Freigeben über

Get-AzApiManagementGroup

  • Referenz
Modul:
Az.ApiManagement

Ruft alle oder bestimmte API-Verwaltungsgruppen ab.

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

Beschreibung

Das Cmdlet "Get-AzApiManagementGroup " ruft alle oder bestimmte API-Verwaltungsgruppen ab.

Beispiele

Beispiel 1: Abrufen aller Gruppen

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

Dieser Befehl ruft alle Gruppen ab.

Beispiel 2: Abrufen einer Gruppe nach ID

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

Dieser Befehl ruft die Gruppen-ID mit dem Namen 0123456789 ab.

Beispiel 3: Abrufen einer Gruppe nach Name

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

Dieser Befehl ruft die Gruppe mit dem Namen "Group0002" ab.

Beispiel 4: Abrufen aller Benutzergruppen

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

Dieser Befehl ruft alle Benutzergruppen mit der Benutzer-ID namens 0123456789 ab.

Parameter

-Context

Gibt eine Instanz von PsApiManagementContext an.

Typ:PsApiManagementContext
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-DefaultProfile

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

Typ:IAzureContextContainer
Aliase:AzContext, AzureRmContext, AzureCredential
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-GroupId

Gibt die Gruppen-ID an. Wenn angegeben, versucht das Cmdlet, die Gruppe anhand des Bezeichners zu finden.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Name

Gibt den Namen der Verwaltungsgruppe an.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ProductId

Bezeichner des vorhandenen Produkts. Wenn angegeben, werden alle Gruppen zurückgegeben, denen das Produkt zugewiesen ist. Dieser Parameter ist optional.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-UserId

Gibt den Bezeichner des vorhandenen Produkts an. Wenn das Cmdlet angegeben wird, werden alle Gruppen zurückgegeben, denen das Produkt zugewiesen ist.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

Eingaben

PsApiManagementContext

String

Ausgaben

PsApiManagementGroup