Compartilhar via

Remove-AzureRmADSpCredential

  • Referência
Módulo:
AzureRM.Resources

Remove uma credencial de uma entidade de serviço.

Aviso

O módulo PowerShell do AzureRM foi oficialmente preterido a partir de 29 de fevereiro de 2024. Os usuários são aconselhados a migrar do AzureRM para o módulo do Az PowerShell para garantir o suporte e as atualizações contínuas.

Embora o módulo AzureRM ainda possa funcionar, ele não tem suporte ou será mantido, colocando qualquer uso contínuo a critério e risco do usuário. Consulte nossos recursos de migração para obter diretrizes sobre a transição para o módulo Az.

Sintaxe

Remove-AzureRmADSpCredential
      -ObjectId <Guid>
      [-KeyId <Guid>]
      [-PassThru]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureRmADSpCredential
      -ServicePrincipalName <String>
      [-KeyId <Guid>]
      [-PassThru]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureRmADSpCredential
      -DisplayName <String>
      [-PassThru]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureRmADSpCredential
      -ServicePrincipalObject <PSADServicePrincipal>
      [-KeyId <Guid>]
      [-PassThru]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

O cmdlet Remove-AzureRmADSpCredential pode ser usado para remover uma chave de credencial de uma entidade de serviço no caso de um comprometimento ou como parte da expiração de substituição de chave de credencial. A entidade de serviço é identificada fornecendo a ID do objeto ou o SPN (nome da entidade de serviço). A credencial a ser removida é identificada por sua ID de chave se uma credencial individual for removida ou com uma opção 'Todos' para excluir todas as credenciais associadas à entidade de serviço.

Exemplos

Exemplo 1 – Remover uma credencial específica de uma entidade de serviço

PS C:\> Remove-AzureRmADSpCredential -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -KeyId 9044423a-60a3-45ac-9ab1-09534157ebb

Remove a credencial com a ID de chave '9044423a-60a3-45ac-9ab1-09534157ebb' da entidade de serviço com a ID de objeto '00001111-aaaa-2222-bbbb-3333cccc4444'.

Exemplo 2 – Remover todas as credenciais de uma entidade de serviço

PS C:\> Remove-AzureRmADSpCredential -ServicePrincipalName http://test123

Remove todas as credenciais da entidade de serviço com o SPN "http://test123".

Exemplo 3 – Remover todas as credenciais de uma entidade de serviço usando tubulação

PS C:\> Get-AzureRmADServicePrincipal -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 | Remove-AzureRmADSpCredential

Obtém a entidade de serviço com a ID de objeto '00001111-aaaa-2222-bbbb-3333cccc4444' e a canaliza para o cmdlet Remove-AzureRmADSpCredential para remover todas as credenciais dessa entidade de serviço.

Parâmetros

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usadas para comunicação com o Azure

Tipo:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DisplayName

O nome de exibição da entidade de serviço.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Force

Alterne para excluir credencial sem uma confirmação.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-KeyId

Especifica a chave de credencial a ser removida. As IDs de chave para uma entidade de serviço podem ser obtidas usando o cmdlet Get-AzureRmADSpCredential.

Tipo:Guid
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ObjectId

A ID do objeto da entidade de serviço da qual remover as credenciais.

Tipo:Guid
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-PassThru

Especificar isso retornará true se o comando tiver sido bem-sucedido.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ServicePrincipalName

O nome (SPN) da entidade de serviço da qual remover as credenciais.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ServicePrincipalObject

O objeto da entidade de serviço do qual remover as credenciais.

Tipo:PSADServicePrincipal
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

Guid

String

PSADServicePrincipal

Parâmetros: ServicePrincipalObject (ByValue)

Saídas

Boolean