Partager via


New-AzApiManagementGroup

Crée un groupe d’administration d’API.

Syntaxe

New-AzApiManagementGroup
   -Context <PsApiManagementContext>
   [-GroupId <String>]
   -Name <String>
   [-Description <String>]
   [-Type <PsApiManagementGroupType>]
   [-ExternalId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

La cmdlet New-AzApiManagementGroup crée un groupe d’administration d’API.

Exemples

Exemple 1 : Créer un groupe d’administration

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

Cette commande crée un groupe d’administration.

Exemple 2

Crée un groupe d’administration d’API. (généré automatiquement)

New-AzApiManagementGroup -Context <PsApiManagementContext> -Description 'Create Echo Api V4' -GroupId '0001' -Name 'Group0001' -Type Custom

Paramètres

-Context

Spécifie l’instance de l’objet 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

-Description

Spécifie la description 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

-ExternalId

Pour les groupes externes, cette propriété contient l’ID du groupe à partir du fournisseur d’identité externe, par exemple Azure Active Directory aad://contoso5api.onmicrosoft.com/groups/12ad42b1-592f-4664-a77b4250-2f2e82579f4c ; sinon, la valeur est Null.

Type:String
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’identificateur du nouveau 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

-Name

Spécifie le nom du groupe d’administration.

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

-Type

Type de groupe. Le groupe personnalisé est un groupe défini par l’utilisateur. Le groupe système inclut l’administrateur, les développeurs et les invités. Vous ne pouvez pas créer ou mettre à jour un groupe système. Le groupe externe est des groupes à partir du fournisseur d’identité externe comme Azure Active Directory. Ce paramètre est facultatif et par défaut supposé être un groupe personnalisé.

Type:Nullable<T>[PsApiManagementGroupType]
Valeurs acceptées:Custom, System, External
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

Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroupType, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

Sorties

PsApiManagementGroup