次の方法で共有

Remove-AzApiManagementApiSchema

  • リファレンス
モジュール:
Az.ApiManagement

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>]

説明

コマンドレット Api からRemove-AzApiManagementSchema 。

例

例 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

このスクリプトは、参照されていない場合、Api echo-api からスキーマ 2 を削除します。 (自動生成)

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

パラメーター

-ApiId

API の識別子。 このパラメーターは必須です。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:SwitchParameter
Aliases:cf
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Context

PsApiManagementContext のインスタンス。 このパラメーターは必須です。

型:PsApiManagementContext
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

型:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-InputObject

PsApiManagementApiSchema のインスタンス。 このパラメーターは必須です。

型:PsApiManagementApiSchema
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-PassThru

指定した場合、操作が成功した場合に true が書き込まれます。 このパラメーターは省略可能です。

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-ResourceId

ApiSchema の Arm ResourceId。 このパラメーターは必須です。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-SchemaId

API スキーマの識別子。 このパラメーターは必須です。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

型:SwitchParameter
Aliases:wi
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

PsApiManagementContext

PsApiManagementApiSchema

String

出力

Boolean