Get-AzApiManagementUser

  • Referenz
Modul:
Az.ApiManagement

Ruft einen Benutzer oder Benutzer ab.

Syntax

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

Beschreibung

Das Cmdlet Get-AzApiManagementUser ruft einen angegebenen Benutzer oder alle Benutzer ab, wenn kein Benutzer angegeben ist.

Beispiele

Beispiel 1: Abrufen aller Benutzer

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

Dieser Befehl ruft alle Benutzer ab.

Beispiel 2: Abrufen eines Benutzers nach ID

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

Dieser Befehl ruft einen Benutzer anhand der ID ab.

Beispiel 3: Abrufen von Benutzern anhand des Nachnamens

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

Dieser Befehl ruft Benutzer ab, die einen angegebenen Nachnamen haben, Fuller.

Beispiel 4: Abrufen eines Benutzers nach E-Mail-Adresse

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

Mit diesem Befehl wird der Benutzer mit der angegebenen E-Mail-Adresse abgerufen.

Beispiel 5: Abrufen aller Benutzer innerhalb einer Gruppe

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

Dieser Befehl ruft alle Benutzer innerhalb der angegebenen Gruppe ab.

Parameter

-Context

Gibt eine Instanz von PsApiManagementContext an.

Type:PsApiManagementContext
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Die Anmeldeinformationen, Konten, Mandanten und Abonnements, die für die Kommunikation mit Azure verwendet werden.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Email

Gibt die E-Mail-Adresse des Benutzers an. Wenn dieser Parameter angegeben ist, findet dieses Cmdlet einen Benutzer per E-Mail. Dieser Parameter ist optional.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-FirstName

Gibt den Vornamen des Benutzers an. Wenn dieser Parameter angegeben ist, findet dieses Cmdlet einen Benutzer anhand des Vornamens. Dieser Parameter ist optional.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-GroupId

Gibt den Gruppenbezeichner an. Wenn angegeben, findet dieses Cmdlet alle Benutzer innerhalb der angegebenen Gruppe. Dieser Parameter ist optional.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-LastName

Gibt den Nachnamen eines Benutzers an. Wenn angegeben, findet dieses Cmdlet Benutzer anhand des Nachnamens. Dieser Parameter ist optional.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-State

Gibt den Benutzerstatus an. Wenn angegeben, findet dieses Cmdlet Benutzer in diesem Zustand. Dieser Parameter ist optional.

Type:Nullable<T>[PsApiManagementUserState]
Accepted values:Active, Blocked, Deleted, Pending
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-UserId

Gibt eine Benutzer-ID an. Wenn angegeben, findet dieses Cmdlet den Benutzer anhand dieses Bezeichners. Dieser Parameter ist optional.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Eingaben

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

Ausgaben

PsApiManagementUser