Partager via

Get-AzApiManagementGroup

  • Référence
Module:
Az.ApiManagement

Obtient tous les groupes d’administration d’API ou spécifiques.

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

La cmdlet Get-AzApiManagementGroup obtient tous les groupes d’administration d’API ou spécifiques.

Exemples

Exemple 1 : Obtenir tous les groupes

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

Cette commande obtient tous les groupes.

Exemple 2 : Obtenir un groupe par ID

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

Cette commande obtient l’ID de groupe nommé 0123456789.

Exemple 3 : Obtenir un groupe par nom

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

Cette commande obtient le groupe nommé Group0002.

Exemple 4 : Obtenir tous les groupes d’utilisateurs

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

Cette commande obtient tous les groupes d’utilisateurs avec l’ID d’utilisateur nommé 0123456789.

Paramètres

-Context

Spécifie une instance de PsApiManagementContext.

Type:PsApiManagementContext
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.

Type:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-GroupId

Spécifie l’ID de groupe. Si elle est spécifiée, l’applet de commande tente de trouver le groupe par l’identificateur.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Name

Spécifie le nom du groupe d’administration.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ProductId

Identificateur du produit existant. Si spécifié, tous les groupes auxquels le produit est affecté sont retournés. Ce paramètre est facultatif.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-UserId

Spécifie l’identificateur du produit existant. Si elle est spécifiée, l’applet de commande retourne tous les groupes auxquels le produit est affecté.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

Entrées

PsApiManagementContext

String

Sorties

PsApiManagementGroup