Compartir a través de

Get-AzApiManagementUser

  • Referencia
Módulo:
Az.ApiManagement

Obtiene un usuario o usuarios.

Sintaxis

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

El cmdlet Get-AzApiManagementUser obtiene un usuario especificado o todos los usuarios, si no se especifica ningún usuario.

Ejemplos

Ejemplo 1: Obtener todos los usuarios

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

Este comando obtiene todos los usuarios.

Ejemplo 2: Obtención de un usuario por identificador

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

Este comando obtiene un usuario por identificador.

Ejemplo 3: Obtener usuarios por apellidos

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

Este comando obtiene los usuarios que tienen un apellido especificado, Fuller.

Ejemplo 4: Obtener un usuario por dirección de correo electrónico

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

Este comando obtiene el usuario que tiene la dirección de correo electrónico especificada.

Ejemplo 5: Obtener todos los usuarios de un grupo

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

Este comando obtiene todos los usuarios del grupo especificado.

Parámetros

-Context

Especifica una instancia de PsApiManagementContext.

Tipo:PsApiManagementContext
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-DefaultProfile

Las credenciales, la cuenta, el inquilino y la suscripción que se usan para la comunicación con Azure.

Tipo:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Email

Especifica la dirección de correo electrónico del usuario. Si se especifica este parámetro, este cmdlet busca un usuario por correo electrónico. Este parámetro es opcional.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-FirstName

Especifica el nombre del usuario. Si se especifica este parámetro, este cmdlet busca un usuario por nombre. Este parámetro es opcional.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-GroupId

Especifica el identificador de grupo. Si se especifica, este cmdlet busca todos los usuarios del grupo especificado. Este parámetro es opcional.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-LastName

Especifica el apellido de un usuario. Si se especifica, este cmdlet busca a los usuarios por apellidos. Este parámetro es opcional.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-State

Especifica el estado del usuario. Si se especifica, este cmdlet busca usuarios en este estado. Este parámetro es opcional.

Tipo:Nullable<T>[PsApiManagementUserState]
Valores aceptados:Active, Blocked, Deleted, Pending
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-UserId

Especifica un identificador de usuario. Si se especifica, este cmdlet busca al usuario por este identificador. Este parámetro es opcional.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín: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]]

Salidas

PsApiManagementUser