New-AzApiManagementGroup
API 管理グループを作成します。
構文
New-AzApiManagementGroup
-Context <PsApiManagementContext>
[-GroupId <String>]
-Name <String>
[-Description <String>]
[-Type <PsApiManagementGroupType>]
[-ExternalId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] 説明
New-AzApiManagementGroup コマンドレットは、API 管理グループを作成します。
例
例 1: 管理グループを作成する
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementGroup -Context $apimContext -Name "Group0001"このコマンドは、管理グループを作成します。
例 2
API 管理グループを作成します。 (自動生成)
New-AzApiManagementGroup -Context <PsApiManagementContext> -Description 'Create Echo Api V4' -GroupId '0001' -Name 'Group0001' -Type Customパラメーター
-Context
PsApiManagementContext オブジェクトのインスタンスを指定します。
| Type: | PsApiManagementContext |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
管理グループの説明を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ExternalId
外部グループの場合、このプロパティには、Azure Active Directory aad://contoso5api.onmicrosoft.com/groups/12ad42b1-592f-4664-a77b4250-2f2e82579f4c など、外部 ID プロバイダーのグループの ID が含まれます。それ以外の場合、値は null です。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-GroupId
新しい管理グループの識別子を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
管理グループ名を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Type
グループの種類。 カスタム グループはユーザー定義グループです。 システム グループには、管理リスト、開発者、ゲストが含まれます。 システム グループを作成または更新することはできません。 外部グループは、Azure Active Directory などの外部 ID プロバイダーのグループです。 このパラメーターは省略可能であり、既定ではカスタム グループと見なされます。
| Type: | Nullable<T>[PsApiManagementGroupType] |
| Accepted values: | Custom, System, External |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
入力
Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroupType, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]