你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
New-AzApiManagementGroup
创建 API 管理组。
语法
New-AzApiManagementGroup
-Context <PsApiManagementContext>
[-GroupId <String>]
-Name <String>
[-Description <String>]
[-Type <PsApiManagementGroupType>]
[-ExternalId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
说明
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
对于外部组,此属性包含来自外部标识提供者的组的 ID,例如 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]]