Set-MgmtSvcUser
Updates the properties of a user.
Syntax
Set-MgmtSvcUser
[-Name] <String>
[-Email] <String>
[[-State] <UserState>]
[[-ActivationSyncState] <ActivationSyncState>]
[-AdminUri] <Uri>
[-Token] <String>
[-DisableCertificateValidation]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-MgmtSvcUser
[[-User] <User>]
[-AdminUri] <Uri>
[-Token] <String>
[-DisableCertificateValidation]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-MgmtSvcUser cmdlet updates the properties of a user. To add a user to Windows Azure Pack for Windows Server, use the Add-MgmtSvcUser cmdlet.
Examples
Example 1: Suspend a user
PS C:\> Set-MgmtSvcUser -AdminUri "https://Computer01:30004" -Token $Token -Name "Patti Fuller" -Email "PattiFuller@Contoso.com" -State "Suspended"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 changes the state of the user named Patti Fuller to Suspended.
Parameters
-ActivationSyncState
Specifies the activation synchronization state. Valid values are:
- InSync
- Synching
- OutOfSync
| Type: | ActivationSyncState |
| Accepted values: | InSync, Syncing, OutOfSync |
| Position: | 5 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-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 |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| 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 |
Specifies the email address for the user.
| Type: | String |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specifies a name for the user.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-State
Specifies a state for the user. Valid values are:
- PendingValidation
- Active
- Suspended
- DeletePending
| Type: | UserState |
| Accepted values: | PendingValidation, Active, Suspended, DeletePending |
| Position: | 4 |
| 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 |
-User
Specifies a user object.
| Type: | User |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |