Remove-EntraAgentIdentity

Módulo:
Microsoft.Entra.Applications Module v1.3

Apaga uma Identidade de Agente pelo seu ID, ou apaga todas as Identidades de Agente (e os seus Utilizadores de Agente) associadas a um Blueprint de Identidade de Agente.

Sintaxe

ByAgentId (Predefinição) 

Remove-EntraAgentIdentity

    -AgentId <String>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByBlueprintId 

Remove-EntraAgentIdentity

    -AgentIdentityBlueprintId <String>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Descrição

O Remove-EntraAgentIdentity cmdlet elimina as Identidades de Agente da Microsoft Entra usando a API v1.0. Quando usado com -AgentId, elimina uma única Identidade de Agente e quaisquer Utilizadores de Agente associados. Quando usado com -AgentIdentityBlueprintId, procura todas as Identidades de Agente para o blueprint e apaga cada uma juntamente com os seus Utilizadores Agentes associados.

O cmdlet requer confirmação antes de ser eliminado, a menos que o -Force switch seja utilizado. Use -WhatIf para pré-visualizar quais os recursos que seriam eliminados sem efetuar a eliminação.

Exemplos

Exemplo 1: Eliminar uma Identidade de Agente por ID

Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentity -AgentId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -Force

Este exemplo elimina a Identidade do Agente e quaisquer Utilizadores do Agente associados.

Exemplo 2: Eliminar todas as Identidades de Agentes para um Blueprint

Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentity -AgentIdentityBlueprintId "cccccccc-3333-4444-5555-dddddddddddd" -Force

Este exemplo procura todas as Identidades de Agentes associadas ao Blueprint especificado, apaga os seus Utilizadores de Agentes e depois apaga as próprias Identidades de Agente.

Exemplo 3: Eliminação de pré-visualização com o WhatIf

Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentIdentity -AgentIdentityBlueprintId "cccccccc-3333-4444-5555-dddddddddddd" -WhatIf

Este exemplo mostra quais as Identidades de Agentes e Utilizadores de Agentes que seriam eliminadas sem realizar a eliminação.

Exemplo 4: Apagar com tratamento de erros

Connect-Entra -Scopes 'AgentIdentity.DeleteRestore.All', 'AgentIdUser.ReadWrite.All'
try {
    $result = Remove-EntraAgentIdentity -AgentId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -Force
    Write-Host "Deleted Agent Identity: $($result.DisplayName)"
    Write-Host "Also deleted $($result.DeletedAgentUsers.Count) Agent User(s)"
} catch {
    Write-Host "Failed to delete: $_"
}

Este exemplo demonstra como eliminar uma Identidade de Agente com tratamento de erros e inspecionar os Utilizadores de Agente eliminados.

Parâmetros

-AgentId

O ID da Identidade do Agente a eliminar. O cmdlet também eliminará quaisquer Utilizadores de Agente associados a esta Identidade de Agente. Usado com o conjunto de parâmetros ByAgentId.

Propriedades dos parâmetros

Tipo:System.String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ByAgentId
Posto:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-AgentIdentityBlueprintId

O ID do Plano de Identidade do Agente. Todas as Identidades de Agente associadas a este blueprint serão eliminadas, assim como os seus Utilizadores de Agentes. Usado com o conjunto de parâmetros ByBlueprintId.

Propriedades dos parâmetros

Tipo:System.String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ByBlueprintId
Posto:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

Tipo:System.Management.Automation.SwitchParameter
Valor predefinido:True
Suporta carateres universais:False
NãoMostrar:False
Aliases:Cf.

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Force

Suprime o prompt de confirmação antes de apagar.

Propriedades dos parâmetros

Tipo:System.Management.Automation.SwitchParameter
Valor predefinido:False
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-WhatIf

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

Propriedades dos parâmetros

Tipo:System.Management.Automation.SwitchParameter
Valor predefinido:False
Suporta carateres universais:False
NãoMostrar:False
Aliases:Wi

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

None

Saídas

System.Collections.Hashtable

Devolve uma tabela de hash (ou array de tabelas de hash ao usar -AgentIdentityBlueprintId) com propriedades: Id, DisplayName, AgentIdentityBlueprintId, DeletedAgentUsers (array de informações de utilizador apagadas) e Estado.

Notas

Este cmdlet requer as seguintes permissões do Microsoft Graph:

  • AgentIdentity.DeleteRestore.All
  • AgentIdUser.ReadWrite.All

O cmdlet requer uma ligação Microsoft Entra ativa. Use Connect-Entra com os telescópios acima para ligar primeiro.

Ao eliminar uma Identidade de Agente, quaisquer Utilizadores Agentes associados são eliminados primeiro. Se a eliminação do Utilizador do Agente falhar, o erro é registado mas a eliminação da Identidade do Agente continua.

Ao usar -AgentIdentityBlueprintId, o cmdlet suporta paginação para lidar com blueprints com várias Identidades de Agente.