Partilhar via

Remove-AzADUser

Módulo:
Az.Resources Module

Exclui entidade dos usuários.

Sintaxe

UPNOrObjectIdParameterSet (Padrão) 

Remove-AzADUser
    -UPNOrObjectId <String>
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ObjectIdParameterSet 

Remove-AzADUser
    -ObjectId <String>
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UPNParameterSet 

Remove-AzADUser
    -UserPrincipalName <String>
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DisplayNameParameterSet 

Remove-AzADUser
    -DisplayName <String>
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObjectParameterSet 

Remove-AzADUser
    -InputObject <IMicrosoftGraphUser>
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Descrição

Exclui entidade dos usuários.

Exemplos

Exemplo 1: Remover usuário por nome de exibição

Remove-AzADUser -DisplayName $name

Remover usuário por nome de exibição

Exemplo 2: Remover usuário por entrada de pipeline

Get-AzADUser -UserPrincipalName $id | Remove-AzADUser

Remover usuário por entrada de pipeline

Parâmetros

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

Tipo:SwitchParameter
Valor padrão:None
Suporta curingas:False
DontShow:False
Pseudónimos:Cf.

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-DefaultProfile

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

Propriedades dos parâmetros

Tipo:PSObject
Valor padrão:None
Suporta curingas:False
DontShow:False
Pseudónimos:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-DisplayName

nome de exibição do usuário

Propriedades dos parâmetros

Tipo:String
Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

DisplayNameParameterSet
Posição:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-InputObject

objeto de entrada do usuário

Propriedades dos parâmetros

Tipo:IMicrosoftGraphUser
Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

InputObjectParameterSet
Posição:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-ObjectId

Chave: ID do usuário

Propriedades dos parâmetros

Tipo:String
Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

ObjectIdParameterSet
Posição:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-PassThru

Retorna true quando o comando é bem-sucedido

Propriedades dos parâmetros

Tipo:SwitchParameter
Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-UPNOrObjectId

O userPrincipalName ou ObjectId do usuário a ser excluído.

Propriedades dos parâmetros

Tipo:String
Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

UPNOrObjectIdParameterSet
Posição:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-UserPrincipalName

nome principal de utilizador

Propriedades dos parâmetros

Tipo:String
Valor padrão:None
Suporta curingas:False
DontShow:False
Pseudónimos:UPN

Conjuntos de parâmetros

UPNParameterSet
Posição:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por 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 dos parâmetros

Tipo:SwitchParameter
Valor padrão:None
Suporta curingas:False
DontShow:False
Pseudónimos:Wi

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por 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

IMicrosoftGraphUser

Saídas

Boolean