Remove-MgmtSvcAdminUser

Removes an administrative principal from the database.

Syntax

Parameter Set: ConnectionParameters
Remove-MgmtSvcAdminUser [-Principal] <String> [-Database <String> ] [-EncryptionAlgorithm <String> ] [-EncryptionKey <String> ] [-Password <String> ] [-Server <String> ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ConnectionString
Remove-MgmtSvcAdminUser [-Principal] <String> [-ConnectionString <String> ] [-EncryptionAlgorithm <String> ] [-EncryptionKey <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Remove-MgmgSvcAdminUser cmdlet removes an administrative user from the database.

If this cmdlet is run on the computer on which the Admin API service is installed and the Web.config file contains values for EncrptionKey and EncryptionAlgorithm, then those values are used.

Parameters

-ConnectionString<String>

Specifies an SQL connection string.

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

-Database<String>

Specifies a database name.

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

-EncryptionAlgorithm<String>

Specifies an encryption algorithm.

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

-EncryptionKey<String>

Specifies an encryption key, as a hexadecimal string.

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

-Password<String>

Specifies a password.

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

-Principal<String>

Specifies an administrative user or group.

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

-Server<String>

Specifies the name of the computer on which the SQL database resides.

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

-UserName<String>

Specifies the name of a user account.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
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 principal by using a connection string

This command removes the principal named Patti Fuller by using a connection string to connect to the database.

PS C:\> Remove-MgmtSvcAdminUser -Principal "PattiFuller@Contoso.com" -ConnectionString 'Server=.\sqlexpress;Initial Catalog=Contoso.MgmtSvc.Store;User Id=sa;Password=PassWord;'

Remove-MgmtSvcAdminUser