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

Remove-AzApiManagementGateway

从网关分离 API。

语法

ContextParameterSetName (默认值)

Remove-AzApiManagementGateway
    -Context <PsApiManagementContext>
    -GatewayId <String>
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByInputObjectParameterSet

Remove-AzApiManagementGateway
    -InputObject <PsApiManagementGateway>
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByResourceIdParameterSet

Remove-AzApiManagementGateway
    -ResourceId <String>
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

说明

Remove-AzApiManagementGateway cmdlet 从网关分离 API。

示例

示例 1:删除现有网关

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementGateway -Context $apimContext -GatewayId "g0001"

此命令将删除现有网关,并且不会提示用户进行确认。

参数

-Confirm

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

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Context

PsApiManagementContext 的实例。 此参数是必需的。

参数属性

类型:PsApiManagementContext
默认值:None
支持通配符:False
不显示:False

参数集

ContextParameterSetName
Position:Named
必需:True
来自管道的值:True
来自管道的值(按属性名称):True
来自剩余参数的值:False

-DefaultProfile

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

参数属性

类型:IAzureContextContainer
默认值:None
支持通配符:False
不显示:False
别名:AzContext, AzureRmContext, AzureCredential

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-GatewayId

现有网关的标识符。 此参数是必需的。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

ContextParameterSetName
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-InputObject

PsApiManagementGateway 的实例。 此参数是必需的。

参数属性

类型:PsApiManagementGateway
默认值:None
支持通配符:False
不显示:False

参数集

ByInputObjectParameterSet
Position:Named
必需:True
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-PassThru

如果指定作成功,则为 true。 此参数是可选的。 默认值为 false。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-ResourceId

网关的 Arm ResourceId。 此参数是必需的。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

ByResourceIdParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters

输入

PsApiManagementContext

String

SwitchParameter

输出

Boolean