Condividi tramite

Get-AzApiManagementGroup

  • Riferimento
Modulo:
Az.ApiManagement

Ottiene tutti o specifici gruppi di gestione API.

Sintassi

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

Descrizione

Il cmdlet Get-AzApiManagementGroup ottiene tutti o specifici gruppi di gestione API.

Esempio

Esempio 1: Ottenere tutti i gruppi

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

Questo comando ottiene tutti i gruppi.

Esempio 2: Ottenere un gruppo in base all'ID

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

Questo comando ottiene l'ID del gruppo denominato 0123456789.

Esempio 3: Ottenere un gruppo in base al nome

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

Questo comando ottiene il gruppo denominato Group0002.

Esempio 4: Ottenere tutti i gruppi di utenti

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

Questo comando ottiene tutti i gruppi di utenti con l'ID utente denominato 0123456789.

Parametri

-Context

Specifica un'istanza di PsApiManagementContext.

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

-DefaultProfile

Credenziali, account, tenant e sottoscrizione usati per la comunicazione con Azure.

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

-GroupId

Specifica l'ID gruppo. Se specificato, il cmdlet tenta di trovare il gruppo in base all'identificatore.

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

-Name

Specifica il nome del gruppo di gestione.

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

-ProductId

Identificatore del prodotto esistente. Se specificato restituirà tutti i gruppi a cui è assegnato il prodotto. Il parametro è facoltativo.

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

-UserId

Specifica l'identificatore del prodotto esistente. Se specificato, il cmdlet restituirà tutti i gruppi a cui è assegnato il prodotto.

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

Input

PsApiManagementContext

String

Output

PsApiManagementGroup