Udostępnij za pośrednictwem

Get-AzApiManagementGroup

  • Odwołanie
Moduł:
Az.ApiManagement

Pobiera wszystkie lub określone grupy zarządzania interfejsami API.

Składnia

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

Opis

Polecenie cmdlet Get-AzApiManagementGroup pobiera wszystkie lub określone grupy zarządzania interfejsem API.

Przykłady

Przykład 1. Pobieranie wszystkich grup

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

To polecenie pobiera wszystkie grupy.

Przykład 2. Pobieranie grupy według identyfikatora

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

To polecenie pobiera identyfikator grupy o nazwie 0123456789.

Przykład 3. Pobieranie grupy według nazwy

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

To polecenie pobiera grupę o nazwie Group0002.

Przykład 4. Pobieranie wszystkich grup użytkowników

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

To polecenie pobiera wszystkie grupy użytkowników z identyfikatorem użytkownika o nazwie 0123456789.

Parametry

-Context

Określa wystąpienie elementu PsApiManagementContext.

Typ:PsApiManagementContext
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.

Typ:IAzureContextContainer
Aliasy:AzContext, AzureRmContext, AzureCredential
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-GroupId

Określa identyfikator grupy. Jeśli zostanie określony, polecenie cmdlet podejmie próbę znalezienia grupy według identyfikatora.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Name

Określa nazwę grupy zarządzania.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ProductId

Identyfikator istniejącego produktu. Jeśli zostanie określona, zwróci wszystkie grupy, do których przypisano produkt. Ten parametr jest opcjonalny.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-UserId

Określa identyfikator istniejącego produktu. Jeśli określono polecenie cmdlet, zwróci wszystkie grupy przypisane do produktu.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

Dane wejściowe

Dane wyjściowe