Remove-AzApiManagementApiVersionSet

モジュール:

Az.ApiManagement

特定の API バージョン セットを削除します

構文

Remove-AzApiManagementApiVersionSet
      -Context <PsApiManagementContext>
      -ApiVersionSetId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzApiManagementApiVersionSet
      -InputObject <PsApiManagementApiVersionSet>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

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

説明

Remove-AzAzureRmApiManagementApiVersionSet コマンドレットは、既存の API バージョン セットを削除します。

例

例 1: API バージョン セットを削除する

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementApiVersionSet -Context $apimContext -ApiVersionSetId "query-param-set"

このコマンドは、指定された ApiVersionSetId を持つ API バージョン セットを削除します。

パラメーター

-ApiVersionSetId

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

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

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

-PassThru

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

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

-ResourceId

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

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

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

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

入力

PsApiManagementContext

PsApiManagementApiVersionSet

String

出力

Boolean

関連リンク

• Get-AzApiManagementApiVersionSet
• New-AzApiManagementApiVersionSet
• Set-AzApiManagementApiVersionSet