Remove-EntraAgentUser

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

Elimina um Utilizador Agente pelo seu ID, ou elimina todos os Utilizadores Agentes associados a uma Identidade de Agente.

Sintaxe

ByUserId (Predefinição) 

Remove-EntraAgentUser

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

ByAgentId 

Remove-EntraAgentUser

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

Descrição

O Remove-EntraAgentUser cmdlet elimina os Utilizadores Agentes do Microsoft Entra. Quando usado com -AgentUserId, elimina um único utilizador agente por ID. Quando usado com -AgentId, procura e apaga todos os utilizadores de agentes associados à Identidade de Agente especificada.

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

Exemplos

Exemplo 1: Eliminar um Utilizador Agente por ID

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

Este exemplo elimina o Utilizador Agente com o ID especificado. Ser-se-á solicitado a confirmação.

Exemplo 2: Eliminar um Utilizador Agente por ID sem confirmação

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

Este exemplo elimina o Utilizador Agente sem necessidade de confirmação.

Exemplo 3: Eliminar todos os utilizadores de agentes para uma identidade de agente

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

Este exemplo procura todos os Utilizadores de Agente associados à Identidade de Agente especificada e apaga-os.

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

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

Este exemplo mostra quais os Utilizadores Agentes que seriam eliminados sem efetivamente realizar a eliminação.

Exemplo 5: Eliminar 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 eliminar um Utilizador Agente com o tratamento de erros.

Parâmetros

-AgentId

O ID da Identidade do Agente cujos Utilizadores Agentes associados devem ser eliminados. O cmdlet procura todos os Utilizadores de Agente ligados a esta Identidade de Agente e apaga-os. 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

-AgentUserId

O ID do Utilizador Agente para eliminar. Usado com o conjunto de parâmetros ByUserId.

Propriedades dos parâmetros

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

Conjuntos de parâmetros

ByUserId
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 um array de tabelas de hash quando usado -AgentId) com as seguintes propriedades: Id, DisplayName, AgentID e Status.

Notas

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

  • AgentIdUser.ReadWrite.All

O cmdlet requer uma ligação Microsoft Entra ativa. Usa Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All' para ligar primeiro.

Ao usar -AgentId, o cmdlet primeiro consulta a todos os Utilizadores do Agente associados à Identidade do Agente, depois elimina cada um deles. Se a Identidade do Agente não tiver Utilizadores de Agente associados, é exibido um aviso.