Disable-AXUser

  • Article

Important

This content is archived and is not being updated. For the latest documentation, see Microsoft Dynamics 365 product documentation. For the latest release plans, see Dynamics 365 and Microsoft Power Platform release plans.

Disable-AXUser

Deactivates a user in Microsoft Dynamics AX.

Syntax

Parameter Set: Default
Disable-AXUser -AXUserId <String> [-PartitionKey <String> ] [-RemoveFromProvider] [ <CommonParameters>]

Detailed description

The Disable-AXUser cmdlet deactivates a user in Microsoft Dynamics AX.

Parameters

-AXUserId<String>

Specifies the UserID (shortened name) of the user to be deactivated.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PartitionKey<String>

Specifies the partition to disable the user in. By default, the user is disabled in the initial partition.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RemoveFromProvider

Removes a forms authentication user from the authentication provider membership database. This parameter is only valid when removing a user that is a forms based authentication user.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see about_CommonParameters https://go.microsoft.com/fwlink/?LinkID=113216

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None

    You cannot pipe input to this cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • None

    The cmdlet does not generate any output.

Examples

This example deactivates the user ssmith in Microsoft Dynamics AX.

C:\PS>Disable-AXUser -AXUserId ssmith

Get-AXUser

Get-AXPartitionInfo

Copyright Microsoft Corporation. All rights reserved.