Share via

Get-AzApiManagementUser

  • Referentie
Module:
Az.ApiManagement

Hiermee haalt u een gebruiker of gebruikers op.

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

Description

De cmdlet Get-AzApiManagementUser haalt een opgegeven gebruiker of alle gebruikers op als er geen gebruiker is opgegeven.

Voorbeelden

Voorbeeld 1: Alle gebruikers ophalen

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

Met deze opdracht worden alle gebruikers ophaalt.

Voorbeeld 2: Een gebruiker ophalen op id

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

Met deze opdracht wordt een gebruiker op basis van id ophaalt.

Voorbeeld 3: Gebruikers ophalen op achternaam

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

Met deze opdracht worden gebruikers met een opgegeven achternaam, Fuller, ophaalt.

Voorbeeld 4: Een gebruiker per e-mailadres ophalen

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

Met deze opdracht wordt de gebruiker met het opgegeven e-mailadres ophaalt.

Voorbeeld 5: Alle gebruikers binnen een groep ophalen

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

Met deze opdracht worden alle gebruikers binnen de opgegeven groep ophaalt.

Parameters

-Context

Hiermee geeft u een exemplaar van PsApiManagementContext.

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

-DefaultProfile

De referenties, het account, de tenant en het abonnement die worden gebruikt voor communicatie met Azure.

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

-Email

Hiermee geeft u het e-mailadres van de gebruiker. Als deze parameter is opgegeven, vindt deze cmdlet een gebruiker per e-mail. Deze parameter is optioneel.

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

-FirstName

Hiermee geeft u de voornaam van de gebruiker. Als deze parameter is opgegeven, zoekt deze cmdlet een gebruiker op voornaam. Deze parameter is optioneel.

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

-GroupId

Hiermee geeft u de groeps-id. Als deze cmdlet is opgegeven, worden alle gebruikers binnen de opgegeven groep gevonden. Deze parameter is optioneel.

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

-LastName

Hiermee geeft u de achternaam van een gebruiker. Indien opgegeven, vindt deze cmdlet gebruikers op achternaam. Deze parameter is optioneel.

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

-State

Hiermee geeft u de gebruikersstatus. Als deze cmdlet is opgegeven, worden gebruikers met deze status gevonden. Deze parameter is optioneel.

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

Hiermee geeft u een gebruikers-id op. Als deze cmdlet is opgegeven, wordt de gebruiker door deze id gevonden. Deze parameter is optioneel.

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

Invoerwaarden

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

Uitvoerwaarden

PsApiManagementUser