Remove-MgmtSvcUser

Remove-MgmtSvcUser

Removes a user from Windows Azure Pack.

Syntax

Parameter Set: Default
Remove-MgmtSvcUser [-AdminUri] <Uri> [-Token] <String> [-Name] <String> [-DeleteSubscriptions] [-DisableCertificateValidation] [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]


 

Detailed Description

The Remove-MgmtSvcUser cmdlet removes a user from Windows Azure Pack for Windows Server.

Parameters

-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

 

-DeleteSubscriptions

Indicates that subscriptions associated with the user are removed.

 

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

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

 

-Force

Performs the action without a confirmation message.

 

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

 

-Name<String>

Specifies the name of a user.

 

Aliases

none

Required?

true

Position?

3

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

 

-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: Remove 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 removes the user coadmin@Contoso.com from RDFE. The user still exists and in the membership database and needs be deleted from that database to complete its removal.

PS C:\> Remove-MgmtSvcUser -Name 'coadmin@Contoso.com' -AdminUri "https://Computer01:30004" -Token $Token -DeleteSubscriptions -DisableCertificateValidation

 

Related topics

Add-MgmtSvcUser

Get-MgmtSvcUser

Set-MgmtSvcUser