Get-MSAzureUser
- 21 Aug 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Get-MSAzureUser
- Updated on 21 Aug 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Return a list of users from Azure AD.
Syntax
Get-MSAzureUser
-Properties <String>
-Filter <String>
-UPN <String>
-TenantName <String>
-TotalCount
-HideProgressBar
-AuthToken <String>
-ResultSize <Int32>
-ProgressUpdateFreq <Int32>
Examples
Example 1
Get-MSAzureUser
Returns all MS Azure user accounts
Example 2
Get-MSAzureUser -Properties 'id,userPrincipalName' -AuthToken $AuthToken
Returns a list of Azure users' ID and userPrincipalNames using a previously-obtained authtoken
Example 3
Get-MSAzureUser -Filter "startswith(displayName,'Meeting Room')"
Returns a list of Azure users whose display names start with 'Meeting Room'
Parameters
-Properties <String>
A comma-delimited list of properties to return in the results
Format as per https://docs.microsoft.com/en-us/graph/query-parameters?view=graph-rest-1.0#select-parameter
Available properties can be found at https://docs.microsoft.com/en-us/graph/api/resources/user?view=graph-rest-1.0#properties
| Parameter | Value |
|---|---|
| Required | false |
| Position | 1 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-Filter <String>
Add filter parameters as per https://docs.microsoft.com/en-us/graph/query-parameters?context=graph%2Fapi%2F1.0&view=graph-rest-1.0#filter-parameter
Available properties can be found at https://docs.microsoft.com/en-us/graph/api/resources/user?view=graph-rest-1.0#properties
| Parameter | Value |
|---|---|
| Required | false |
| Position | 2 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-UPN <String>
Return user details for the given UserPrincipalName
| Parameter | Value |
|---|---|
| Required | false |
| Position | 3 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-TenantName <String>
The name of the Nectar DXP tenant. Used in multi-tenant configurations.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 4 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-TotalCount <SwitchParameter>
Only return a total count of objects
| Parameter | Value |
|---|---|
| Required | false |
| Position | named |
| Required | false |
| Default Value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-HideProgressBar <SwitchParameter>
Don't show the progress bar. Cleans up logs when running on Docker.
| Parameter | Value |
|---|---|
| Required | false |
| Position | named |
| Required | false |
| Default Value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-AuthToken <String>
The authorization token used for this request. Normally obtained via Get-MSGraphAccessToken
| Parameter | Value |
|---|---|
| Required | false |
| Position | 5 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-ResultSize <Int32>
The number of results to return. Defaults to 1000.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 6 |
| Required | false |
| Default Value | 200000 |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-ProgressUpdateFreq <Int32>
| Parameter | Value |
|---|---|
| Required | false |
| Position | 7 |
| Required | false |
| Default Value | 1 |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Was this article helpful?