Share via

Get-AzApiManagementGroup

  • Referentie
Module:
Az.ApiManagement

Hiermee worden alle of specifieke API-beheergroepen opgehaald.

Syntax

Get-AzApiManagementGroup
   -Context <PsApiManagementContext>
   [-Name <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzApiManagementGroup
   -Context <PsApiManagementContext>
   [-GroupId <String>]
   [-Name <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzApiManagementGroup
   -Context <PsApiManagementContext>
   [-Name <String>]
   [-UserId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzApiManagementGroup
   -Context <PsApiManagementContext>
   [-Name <String>]
   [-ProductId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Met de cmdlet Get-AzApiManagementGroup worden alle of specifieke API-beheergroepen opgehaald.

Voorbeelden

Voorbeeld 1: Alle groepen ophalen

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

Met deze opdracht worden alle groepen ophaalt.

Voorbeeld 2: Een groep ophalen op id

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

Met deze opdracht wordt de groeps-id met de naam 0123456789.

Voorbeeld 3: Een groep ophalen op naam

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementGroup -Context $apimContext -Name "Group0002"

Met deze opdracht wordt de groep met de naam Group0002 ophaalt.

Voorbeeld 4: Alle gebruikersgroepen ophalen

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

Met deze opdracht worden alle gebruikersgroepen met de gebruikers-id 0123456789.

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

-GroupId

Hiermee geeft u de groeps-id. Indien opgegeven, probeert de cmdlet de groep te vinden op basis van de id.

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

-Name

Hiermee geeft u de naam van de beheergroep.

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

-ProductId

Id van bestaand product. Als dit is opgegeven, worden alle groepen geretourneerd waaraan het product is toegewezen. Deze parameter is optioneel.

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

-UserId

Hiermee geeft u de id van het bestaande product. Als u de cmdlet opgeeft, worden alle groepen geretourneerd waaraan het product is toegewezen.

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

Invoerwaarden

PsApiManagementContext

String

Uitvoerwaarden

PsApiManagementGroup