Auf Englisch lesen

Freigeben über

New-AzApiManagementGroup

  • Referenz
Modul:
Az.ApiManagement

Erstellt eine API-Verwaltungsgruppe.

Syntax

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

Beschreibung

Das Cmdlet New-AzApiManagementGroup erstellt eine API-Verwaltungsgruppe.

Beispiele

Beispiel 1: Erstellen einer Verwaltungsgruppe

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

Mit diesem Befehl wird eine Verwaltungsgruppe erstellt.

Beispiel 2

Erstellt eine API-Verwaltungsgruppe. (automatisch generiert)

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

Parameter

-Context

Gibt die Instanz des PsApiManagementContext -Objekts an.

Typ:PsApiManagementContext
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-DefaultProfile

Die Anmeldeinformationen, Konten, Mandanten und Abonnements, die für die Kommunikation mit Azure verwendet werden.

Typ:IAzureContextContainer
Aliase:AzContext, AzureRmContext, AzureCredential
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Description

Gibt die Beschreibung der Verwaltungsgruppe an.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ExternalId

Bei externen Gruppen enthält diese Eigenschaft die ID der Gruppe vom externen Identitätsanbieter, z. B. Azure Active Directory-aad://contoso5api.onmicrosoft.com/groups/12ad42b1-592f-4664-a77b4250-2f2e82579f4c; andernfalls ist der Wert NULL.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-GroupId

Gibt den Bezeichner der neuen Verwaltungsgruppe an.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Name

Gibt den Verwaltungsgruppennamen an.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Type

Gruppentyp. Benutzerdefinierte Gruppe ist benutzerdefinierte Gruppe. Die Systemgruppe umfasst Administrator, Entwickler und Gäste. Sie können keine Systemgruppe erstellen oder aktualisieren. Externe Gruppe ist Gruppen von externem Identitätsanbieter wie Azure Active Directory. Dieser Parameter ist optional und wird standardmäßig als benutzerdefinierte Gruppe angenommen.

Typ:Nullable<T>[PsApiManagementGroupType]
Zulässige Werte:Custom, System, External
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

Eingaben

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

Ausgaben