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

Remove-AzApiManagementApiSchema

从 API 中删除 API 架构。

语法

Remove-AzApiManagementApiSchema
      -Context <PsApiManagementContext>
      -ApiId <String>
      -SchemaId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzApiManagementApiSchema
      -InputObject <PsApiManagementApiSchema>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzApiManagementApiSchema
      -ResourceId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

说明

cmdlet Remove-AzApiManagementSchema 从 Api。

示例

示例 1:从 API 中删除 API 架构

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementApiSchema -Context $apimContext -ApiId "echo-api" -SchemaId "2"

如果未引用架构,脚本将从 Api echo-api 中删除架构2

示例 2

如果未引用架构 2,脚本将从 Api echo-api 中删除架构 2。 (自动生成)

Remove-AzApiManagementApiSchema -ApiId '0001' -Context <PsApiManagementContext> -SchemaId 5cc9cf67e6ed3b1154e638bd

参数

-ApiId

API 的标识符。 此参数是必需的。

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

-Confirm

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

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

-Context

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

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

-DefaultProfile

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

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

-InputObject

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

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

-PassThru

如果指定操作成功,则为 true。 此参数是可选的。

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

-ResourceId

ApiSchema 的 Arm ResourceId。 此参数是必需的。

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

-SchemaId

API 架构的标识符。 此参数是必需的。

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

-WhatIf

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

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

输入

PsApiManagementContext

PsApiManagementApiSchema

String

输出

Boolean