通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Remove-AzApiManagementGroup

  • 参考
模块:
Az.ApiManagement

删除现有的 API 管理组。

语法

Remove-AzApiManagementGroup
      -Context <PsApiManagementContext>
      -GroupId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

说明

Remove-AzApiManagementGroup cmdlet 将删除现有的 API 管理组。

示例

示例 1：删除现有管理组

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

此命令删除名为 Group0001 的现有管理组。

参数

-Confirm

在运行 cmdlet 之前，提示你进行确认。

类型:SwitchParameter
别名:cf
Position:Named
默认值:False
必需:False
接受管道输入:False
接受通配符:False

-Context

指定 PsApiManagementContext 对象的实例。

类型:PsApiManagementContext
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

类型:IAzureContextContainer
别名:AzContext, AzureRmContext, AzureCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-GroupId

指定管理组的标识符。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-PassThru

指示此 cmdlet 如果成功，则返回$True的值，否则返回$False值。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 cmdlet 未运行。

类型:SwitchParameter
别名:wi
Position:Named
默认值:False
必需:False
接受管道输入:False
接受通配符:False

输入

PsApiManagementContext

String

SwitchParameter

输出

Boolean