Add-MgmtSvcUser

Creates a user in Windows Azure Pack.

Syntax

Parameter Set: ByProperties
Add-MgmtSvcUser [-AdminUri] <Uri> [-Token] <String> [-Name] <String> [-Email] <String> [[-State] {PendingValidation | Active | Suspended | DeletePending} ] [[-ActivationSyncState] {InSync | Syncing | OutOfSync} ] [-DisableCertificateValidation] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByObject
Add-MgmtSvcUser [-AdminUri] <Uri> [-Token] <String> [[-User] <User> ] [-DisableCertificateValidation] [-Confirm] [-WhatIf] [ <CommonParameters>]

 

Detailed Description

The Add-MgmtSvcUser cmdlet creates a user in Windows Azure Pack for Windows Server.

Parameters

-ActivationSyncState<ActivationSyncState>

Specifies the activation synchronization state. Valid values are:

-- InSync

-- Synching

-- OutOfSync

The acceptable values for this parameter are:

 

InSync
Syncing
OutOfSync

 

 

Aliases	none
Required?	false
Position?	6
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

 

-AdminUri<Uri>

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.

 

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

 

-DisableCertificateValidation

Disables certificate validation for the Windows Azure Pack installation.

If you specifiy this parameter, you can use self-signed certificates.

 

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

 

-Email<String>

Specifies the email address for the user.

 

Aliases	none
Required?	true
Position?	4
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

 

-Name<String>

Specifies a name for the user.

 

Aliases	none
Required?	true
Position?	3
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

 

-State<UserState>

Specifies a state for the user. Valid values are:

-- PendingValidation

-- Active

-- Suspended

-- DeletePending

The acceptable values for this parameter are:

 

PendingValidation
Active
Suspended
DeletePending

 

 

Aliases	none
Required?	false
Position?	5
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

 

-Token<String>

Specifies an identity token. To create a token, use the Get-MgmtSvcToken cmdlet.

 

Aliases	none
Required?	true
Position?	2
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

 

-User<User>

Specifies a user object.

 

Aliases	none
Required?	false
Position?	3
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

 

-Confirm

Prompts you for confirmation before executing the command.

 

Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

 

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

 

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, and -OutVariable. For more information, see about_CommonParameters.

Examples

Example 1: Add a user

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 adds the user named Patti Fuller.

PS C:\> Add-MgmtSvcUser -AdminUri "https://Computer01:30004" -Token $Token -Name "Patti Fuller" -Email "PattiFuller@Contoso.com" -State "Active" -ActivationSyncState "InSync"
 

 

Related topics

Get-MgmtSvcUser

Set-MgmtSvcUser

Remove-MgmtSvcUser

Get-MgmtSvcUserSetting

Set-MgmtSvcUserSetting