Partager via

Get-AzApiManagementUser

  • Référence
Module:
Az.ApiManagement

Obtient un utilisateur ou des utilisateurs.

Syntaxe

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

L’applet de commande Get-AzApiManagementUser obtient un utilisateur spécifié, ou tous les utilisateurs, si aucun utilisateur n’est spécifié.

Exemples

Exemple 1 : Obtenir tous les utilisateurs

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

Cette commande obtient tous les utilisateurs.

Exemple 2 : Obtenir un utilisateur par ID

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

Cette commande obtient un utilisateur par ID.

Exemple 3 : Obtenir des utilisateurs par nom

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

Cette commande obtient les utilisateurs qui ont un nom spécifié, Fuller.

Exemple 4 : Obtenir un utilisateur par adresse e-mail

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

Cette commande obtient l’utilisateur qui a l’adresse e-mail spécifiée.

Exemple 5 : Obtenir tous les utilisateurs au sein d’un groupe

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

Cette commande obtient tous les utilisateurs du groupe spécifié.

Paramètres

-Context

Spécifie une instance de PsApiManagementContext.

Type:PsApiManagementContext
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.

Type:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Email

Spécifie l’adresse e-mail de l’utilisateur. Si ce paramètre est spécifié, cette applet de commande recherche un utilisateur par e-mail. Ce paramètre est facultatif.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-FirstName

Spécifie le prénom de l’utilisateur. Si ce paramètre est spécifié, cette applet de commande recherche un utilisateur par prénom. Ce paramètre est facultatif.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-GroupId

Spécifie l’identificateur de groupe. Si elle est spécifiée, cette applet de commande recherche tous les utilisateurs dans le groupe spécifié. Ce paramètre est facultatif.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-LastName

Spécifie le nom d’un utilisateur. Si elle est spécifiée, cette applet de commande recherche les utilisateurs par nom. Ce paramètre est facultatif.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-State

Spécifie l’état utilisateur. Si elle est spécifiée, cette applet de commande recherche les utilisateurs dans cet état. Ce paramètre est facultatif.

Type:Nullable<T>[PsApiManagementUserState]
Valeurs acceptées:Active, Blocked, Deleted, Pending
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-UserId

Spécifie un ID d’utilisateur. Si elle est spécifiée, cette applet de commande recherche l’utilisateur par cet identificateur. Ce paramètre est facultatif.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

Entrées

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]]

Sorties

PsApiManagementUser