Compartilhar 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 usuários

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

Esse comando obtém todos os usuários.

Exemplo 2: Obter um usuário por ID

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

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

Exemplo 3: Obter usuários pelo sobrenome

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

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

Exemplo 4: Obter um usuário por endereço de email

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

Esse comando obtém o usuário que tem o endereço de email especificado.

Exemplo 5: Obter todos os usuários em um grupo

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

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

Parâmetros

-Context

Especifica uma instância de PsApiManagementContext.

Tipo:PsApiManagementContext
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga: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
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Email

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

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-FirstName

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

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-GroupId

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

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-LastName

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

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-State

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

Tipo:Nullable<T>[PsApiManagementUserState]
Valores aceitos:Active, Blocked, Deleted, Pending
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-UserId

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

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga: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