New-AzApiManagementGroup
建立 API 管理群組。
語法
New-AzApiManagementGroup
-Context <PsApiManagementContext>
[-GroupId <String>]
-Name <String>
[-Description <String>]
[-Type <PsApiManagementGroupType>]
[-ExternalId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
New-AzApiManagementGroup Cmdlet 會建立 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 對象的實例。
類型: | PsApiManagementContext |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-DefaultProfile
用於與 azure 通訊的認證、帳戶、租用戶和訂用帳戶。
類型: | IAzureContextContainer |
別名: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-Description
指定管理群組的描述。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-ExternalId
針對外部群組,此屬性包含來自外部識別提供者的群組標識符,例如 Azure Active Directory aad://contoso5api.onmicrosoft.com/groups/12ad42b1-592f-4664-a77b4250-2f2e82579f4c;否則此值為 null。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-GroupId
指定新管理群組的識別碼。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-Name
指定管理組名。
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-Type
群組類型。 自訂群組是使用者定義的群組。 系統群組包含系統管理員、開發人員和來賓。 您無法建立或更新系統群組。 外部群組是來自外部識別提供者的群組,例如 Azure Active Directory。 此參數是選擇性的,預設會假設為自定義群組。
類型: | Nullable<T>[PsApiManagementGroupType] |
接受的值: | Custom, System, External |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | 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]]