Remove-EntraAgentUser

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

Exclui um usuário do agente por sua ID ou exclui todos os Usuários do Agente associados a uma Identidade do Agente.

Sintaxe

ByUserId (Default) 

Remove-EntraAgentUser

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

ByAgentId 

Remove-EntraAgentUser

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

Description

O Remove-EntraAgentUser cmdlet exclui usuários do agente de Microsoft Entra. Quando usado com -AgentUserId, ele exclui um único usuário de agente por ID. Quando usado com -AgentId, ele pesquisa e exclui todos os usuários do agente associados à Identidade do Agente especificada.

O cmdlet requer confirmação antes de excluir, a menos que a opção -Force seja usada. Use -WhatIf para visualizar quais usuários seriam excluídos sem realmente executar a exclusão.

Exemplos

Exemplo 1: excluir um usuário do agente por ID

Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"

Este exemplo exclui o Usuário do Agente com a ID especificada. Você será solicitado a confirmar.

Exemplo 2: excluir um usuário do agente por ID sem confirmação

Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -Force

Este exemplo exclui o Usuário do Agente sem solicitar confirmação.

Exemplo 3: excluir todos os usuários do agente para uma identidade de agente

Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentId "cccccccc-3333-4444-5555-dddddddddddd" -Force

Este exemplo pesquisa todos os Usuários do Agente associados à Identidade do Agente especificada e os exclui.

Exemplo 4: exclusão de visualização com WhatIf

Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
Remove-EntraAgentUser -AgentId "cccccccc-3333-4444-5555-dddddddddddd" -WhatIf

Este exemplo mostra quais Usuários do Agente seriam excluídos sem realmente executar a exclusão.

Exemplo 5: Excluir com tratamento de erros

Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
try {
    $result = Remove-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" -Force
    Write-Host "Deleted: $($result.DisplayName)"
} catch {
    Write-Host "Failed to delete: $_"
}

Este exemplo demonstra como excluir um usuário do agente com tratamento de erros.

Parâmetros

-AgentId

A ID da Identidade do Agente cujos Usuários do Agente associados devem ser excluídos. O cmdlet pesquisa todos os Usuários do Agente conectados a essa Identidade do Agente e os exclui. Usado com o conjunto de parâmetros ByAgentId.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

ByAgentId
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-AgentUserId

A ID do usuário do agente a ser excluído. Usado com o conjunto de parâmetros ByUserId.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

ByUserId
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Confirm

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

Propriedades do parâmetro

Tipo:System.Management.Automation.SwitchParameter
Valor padrão:True
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Force

Suprime o prompt de confirmação antes da exclusão.

Propriedades do parâmetro

Tipo:System.Management.Automation.SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WhatIf

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

Propriedades do parâmetro

Tipo:System.Management.Automation.SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes: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

Retorna um hashtable (ou matriz de hashtables ao usar -AgentId) com as seguintes propriedades: Id, DisplayName, AgentId e Status.

Observações

Esse cmdlet requer as seguintes permissões de Microsoft Graph:

  • AgentIdUser.ReadWrite.All

O cmdlet requer uma conexão Microsoft Entra ativa. Use Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All' para se conectar primeiro.

Ao usar -AgentId, o cmdlet primeiro consulta todos os Usuários do Agente associados à Identidade do Agente e, em seguida, exclui cada um deles. Se a Identidade do Agente não tiver usuários de agente associados, um aviso será exibido.