Get-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.

Get-AXUser

Returns a list of all users and their properties from Microsoft Dynamics AX.

Syntax

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

Detailed description

Returns a list of users and their properties from Microsoft Dynamics AX. The properties returned are AccountType, UserID, Name, SID, Enabled, UserName, UserDomain, and Company. The cmdlet can optionally take a user ID, a partition key, or both as a parameter.

Parameters

-AXUserId<String>

Specifies a Microsoft Dynamics AX user ID to return properties for. If both a user ID and a partition key are specified, and the user does not exist in the specified partition, an error is returned.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PartitionKey<String>

Specifies the partition to return a list of users from. By default, the cmdlet returns the users in the initial partition.

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

Example 1: Return properties of all users

This example returns the properties of all Microsoft Dynamics AX users.

C:\PS>Get-AXUser

						

						
AccountType : WindowsUser
AXUserId    : Admin
Name        :
SID         : S-1-5-21-2127521184-1604012920-1887927527-2163647
Enabled     : Enabled
UserName    : VamsiK
UserDomain  : CONTOSO
Company     : DAT

AccountType : WindowsUser
AXUserId    : Guest
Name        :
SID         :
Enabled     : Disabled
UserName    :
UserDomain  :
Company     : DAT

.
.
.

Example 2: Return properties of one user

This example returns the properties of a single Microsoft Dynamics AX user.

C:\PS>Get-AXUser -AXUserId admin

						

						
AccountType : WindowsUser
AXUserId    : Admin
Name        :
SID         : S-1-5-21-2127521184-1604012920-1887927527-2163647
Enabled     : Enabled
UserName    : VamsiK
UserDomain  : CONTOSO
Company     : DAT

Get-AXPartitionInfo

Copyright Microsoft Corporation. All rights reserved.