Remove-AzApiManagementSubscription

モジュール:

Az.ApiManagement

既存のサブスクリプションを削除します。

構文

Remove-AzApiManagementSubscription
      -Context <PsApiManagementContext>
      -SubscriptionId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzApiManagementSubscription
      -Context <PsApiManagementContext>
      -SubscriptionId <String>
      -InputObject <PsApiManagementSubscription>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzApiManagementSubscription
      -Context <PsApiManagementContext>
      -SubscriptionId <String>
      -ResourceId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Remove-AzApiManagementSubscription コマンドレットは、既存のサブスクリプションを削除します。

例

例 1: サブスクリプションを削除する

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementSubscription -Context $apimContext -SubscriptionId "0123456789"

このコマンドは、既存のサブスクリプションを削除します。

パラメーター

-Confirm

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

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

-Context

PsApiManagementContext オブジェクトを指定します。

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

-DefaultProfile

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

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

-InputObject

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

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

-PassThru

このコマンドレットが成功した場合は $True の値、それ以外の場合は $false の値を返します。

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

-ResourceId

サブスクリプションの Arm ResourceId。 このパラメーターは必須です。

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

-SubscriptionId

サブスクリプション ID を指定します。

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

-WhatIf

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

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

入力

PsApiManagementContext

String

SwitchParameter

出力

Boolean

関連リンク

• Get-AzApiManagementSubscription
• New-AzApiManagementSubscription
• Set-AzApiManagementSubscription