Get-MgmtSvcUser
Gets a user.
Syntax
Get-MgmtSvcUser
[[-Name] <String>]
[-Skip <Int32>]
[-First <Int32>]
[-SortProperty <String>]
[-Descending]
[-AdminUri] <Uri>
[-Token] <String>
[-DisableCertificateValidation]
[<CommonParameters>]
Description
The Get-MgmtSvcUser cmdlet gets a user. By default, all users are returned. To get a specific user, use the Name parameter.
To add a user, use the Add-MgmtSvcUser cmdlet.
Examples
Example 1: Get a specific user by name
PS C:\> Get-MgmtSvcUser -AdminUri "https://Computer01:30004" -Token $Token -Name "Patti Fuller"
NOTE: This example assumes that you have created a token by using Get-MgmtSvcToken and have stored it in a variable named $Token.
This command gets the user named Patti Fuller.
Example 2: Get only the first five users
PS C:\> Get-MgmtSvcUser -AdminUri "https://Computer01:30004" -Token $Token -First 5
NOTE: This example assumes that you have created a token by using Get-MgmtSvcToken and have stored it in a variable named $Token.
This command gets the first five users.
Parameters
-AdminUri
Specifies the URI of the Windows Azure Pack administrator API. Use the following format: https://<computer>:<port>, where <computer> is the computer on which the administrator API is installed.
Type: | Uri |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Descending
Indicates that the users are returned in descending order.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DisableCertificateValidation
Disables certificate validation for the Windows Azure Pack installation.
If you specify this parameter, you can use self-signed certificates.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-First
Gets only the specified number of objects. Enter the number of objects to get.
Type: | Int32 |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Specifies the name of a user.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Skip
Ignores the specified number of objects and then gets the remaining objects. Enter the number of objects to skip.
Type: | Int32 |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SortProperty
Specifies the property by which to sort results.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Token
Specifies an identity token. To create a token, use the Get-MgmtSvcToken cmdlet.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |