Remove-AzApiManagementUser
Exclui um usuário existente.
Sintaxe
Remove-AzApiManagementUser
-Context <PsApiManagementContext>
-UserId <String>
[-DeleteSubscriptions]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
O cmdlet Remove-AzApiManagementUser exclui um usuário existente.
Exemplos
Exemplo 1: Excluir um usuário
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementUser -Context $apimContext -UserId "0123456789"Este comando exclui um usuário existente.
Parâmetros
-Confirm
Solicita a sua confirmação antes de executar o cmdlet.
| Tipo: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-Context
Especifica um objeto PsApiManagementContext . Este parâmetro é obrigatório.
| Tipo: | PsApiManagementContext |
| Position: | Named |
| Default value: | None |
| Necessário: | True |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-DefaultProfile
As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure.
| Tipo: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-DeleteSubscriptions
Indica se as assinaturas do produto devem ser excluídas. Se esse parâmetro não for especificado e existir uma assinatura, esse cmdlet lançará uma exceção. Este parâmetro é opcional.
| Tipo: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-PassThru
Indica que esse cmdlet retorna um valor de $Ture, se for bem-sucedido, ou um valor de $False, caso contrário.
| Tipo: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-UserId
Especifica a ID do usuário a ser removido.
| Tipo: | String |
| Position: | Named |
| Default value: | None |
| Necessário: | True |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-WhatIf
Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.
| Tipo: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |