Sdílet prostřednictvím

Get-AzApiManagementGroup

  • Reference
Modul:
Az.ApiManagement

Získá všechny nebo konkrétní skupiny pro správu rozhraní API.

Syntaxe

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

Rutina Get-AzApiManagementGroup získá všechny nebo konkrétní skupiny pro správu rozhraní API.

Příklady

Příklad 1: Získání všech skupin

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

Tento příkaz získá všechny skupiny.

Příklad 2: Získání skupiny podle ID

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

Tento příkaz získá ID skupiny s názvem 0123456789.

Příklad 3: Získání skupiny podle názvu

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

Tento příkaz získá skupinu s názvem Group0002.

Příklad 4: Získání všech skupin uživatelů

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

Tento příkaz získá všechny skupiny uživatelů s ID uživatele s názvem 0123456789.

Parametry

-Context

Určuje instanci PsApiManagementContext.

Typ:PsApiManagementContext
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.

Typ:IAzureContextContainer
Aliasy:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-GroupId

Určuje ID skupiny. Pokud je zadáno, rutina se pokusí najít skupinu podle identifikátoru.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Name

Určuje název skupiny pro správu.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-ProductId

Identifikátor existujícího produktu. Pokud zadáte, vrátí všechny skupiny, ke kterým byl produkt přiřazen. Tento parametr je volitelný.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-UserId

Určuje identifikátor existujícího produktu. Pokud zadáte, rutina vrátí všechny skupiny, ke kterým byl produkt přiřazen.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

Vstupy

Výstupy