次の方法で共有

New-AzureRmApiManagementGroup

  • リファレンス
モジュール:
AzureRM.ApiManagement

API 管理グループを作成します。

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

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

説明

New-AzureRmApiManagementGroup コマンドレットは、API 管理グループを作成します。

例

例 1: 管理グループを作成する

PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>New-AzureRmApiManagementGroup -Context $apimContext -Name "Group0001"

このコマンドは、管理グループを作成します。

パラメーター

-Context

PsApiManagementContext オブジェクトのインスタンスを指定します。

型:PsApiManagementContext
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

型:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Description

管理グループの説明を指定します。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ExternalId

外部グループの場合、このプロパティには、Microsoft Entra aad://contoso5api.onmicrosoft.com/groups/12ad42b1-592f-4664-a77b4250-2f2e82579f4c など、外部 ID プロバイダーからのグループの ID が含まれます。それ以外の場合、値は null です。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-GroupId

新しい管理グループの識別子を指定します。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Name

管理グループ名を指定します。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Type

グループの種類。 カスタム グループはユーザー定義グループです。 システム グループには、管理リスト、開発者、ゲストが含まれます。 システム グループを作成または更新することはできません。 外部グループは、Microsoft Entra ID などの外部 ID プロバイダーのグループです。 このパラメーターは省略可能であり、既定ではカスタム グループと見なされます。

型:Nullable<T>[PsApiManagementGroupType]
指定可能な値:Custom, System, External
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

入力

PsApiManagementContext

String

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

出力

PsApiManagementGroup