Partilhar via

Get-AzApiManagementUser

  • Referência
Módulo:
Az.ApiManagement

Obtém um usuário ou usuários.

Sintaxe

Get-AzApiManagementUser
   -Context <PsApiManagementContext>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzApiManagementUser
   -Context <PsApiManagementContext>
   [-UserId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzApiManagementUser
   -Context <PsApiManagementContext>
   [-FirstName <String>]
   [-LastName <String>]
   [-State <PsApiManagementUserState>]
   [-Email <String>]
   [-GroupId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

O cmdlet Get-AzApiManagementUser obtém um usuário especificado, ou todos os usuários, se nenhum usuário for especificado.

Exemplos

Exemplo 1: Obter todos os utilizadores

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementUser -Context $apimContext

Este comando obtém todos os usuários.

Exemplo 2: Obter um utilizador por ID

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementUser -Context $apimContext -UserId "0123456789"

Este comando obtém um usuário por ID.

Exemplo 3: Obter usuários por sobrenome

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementUser -Context $apimContext -LastName "Fuller"

Este comando obtém usuários que têm um sobrenome especificado, Fuller.

Exemplo 4: Obter um utilizador por endereço de e-mail

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementUser -Context $apimContext -Email "user@contoso.com"

Este comando obtém o usuário que tem o endereço de e-mail especificado.

Exemplo 5: Obter todos os usuários dentro de um grupo

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementUser -Context $apimContext -GroupId "0001"

Este comando obtém todos os usuários dentro do grupo especificado.

Parâmetros

-Context

Especifica uma instância de PsApiManagementContext.

Tipo:PsApiManagementContext
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-DefaultProfile

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

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Email

Especifica o endereço de e-mail do usuário. Se esse parâmetro for especificado, esse cmdlet localizará um usuário por email. Este parâmetro é opcional.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-FirstName

Especifica o nome do usuário. Se esse parâmetro for especificado, esse cmdlet localizará um usuário pelo nome. Este parâmetro é opcional.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-GroupId

Especifica o identificador de grupo. Se especificado, esse cmdlet localiza todos os usuários dentro do grupo especificado. Este parâmetro é opcional.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-LastName

Especifica o sobrenome de um usuário. Se especificado, esse cmdlet localiza os usuários pelo sobrenome. Este parâmetro é opcional.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-State

Especifica o estado do usuário. Se especificado, esse cmdlet localiza os usuários nesse estado. Este parâmetro é opcional.

Tipo:Nullable<T>[PsApiManagementUserState]
Valores aceites:Active, Blocked, Deleted, Pending
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-UserId

Especifica um ID de usuário. Se especificado, esse cmdlet localiza o usuário por esse identificador. Este parâmetro é opcional.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

Entradas

PsApiManagementContext

String

Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUserState, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

Saídas

PsApiManagementUser