Remove-AzureSubscription

  • リファレンス
モジュール:
Azure

Windows PowerShell から Azure サブスクリプションを削除します。

Note

このドキュメントで参照されているコマンドレットは、Azure Service Manager (ASM) API を使用する従来の Azure リソースを管理するためのものです。 ASM の提供終了が予定されているため、新しいリソースを作成する場合、このレガシ PowerShell モジュールは推奨されません。 詳細については、Azure Service Manager の提供終了に関するページを参照してください。

Az PowerShell モジュールは、PowerShell を使用して Azure Resource Manager (ARM) リソースを管理するために推奨される PowerShell モジュールです。

構文

Remove-AzureSubscription
      -SubscriptionName <String>
      [-Force]
      [-PassThru]
      [-Profile <AzureSMProfile>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureSubscription
      -SubscriptionId <String>
      [-Force]
      [-PassThru]
      [-Profile <AzureSMProfile>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Remove-AzureSubscription コマンドレットは、サブスクリプション データ ファイルから Azure サブスクリプションを削除して、Windows PowerShell で見つけることができないようにします。 このコマンドレットは、Microsoft Azure からサブスクリプションを削除したり、実際のサブスクリプションを変更したりすることはありません。

このトピックでは、Microsoft Azure PowerShell モジュールの 0.8.10 バージョンのコマンドレットについて説明します。 使用しているモジュールのバージョンを取得するには、Azure PowerShell コンソールで「.」と入力します (Get-Module -Name Azure).Version。

例

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

C:\PS> Remove-AzureSubscription -SubscriptionName Test

Confirm
Are you sure you want to perform this action?
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"):

このコマンドは、既定のサブスクリプション データ ファイルから "テスト" サブスクリプションを削除します。

例 2: 代替サブスクリプション データ ファイルから削除する

C:\PS> Remove-AzureSubscription -SubscriptionName Test -SubscriptionDataFile C:\Subs\MySubscriptions.xml -Force

このコマンドは、MySubscriptions.xml サブスクリプション データ ファイルからテスト サブスクリプションを削除します。 このコマンドは Force パラメーターを使用して、確認プロンプトを抑制します。

例 3: スクリプト内のサブスクリプションを削除する

C:\PS> ...if (Remove-AzureSubscription -SubscriptionName Test -PassThru) {...}

このコマンドは、If ステートメントで Remove-AzureSubscription コマンドを使用します。 ブール値を返す PassThru パラメーターを使用して、If ステートメントのスクリプト ブロックが実行されるかどうかを判断します。

パラメーター

-Confirm

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

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

-Force

確認プロンプトを非表示にします。

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

-PassThru

コマンドが成功した場合は$Trueを返し、失敗した場合は$Falseを返します。 既定では、このコマンドレットは出力を返しません。

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

-Profile

このコマンドレットが読み取る Azure プロファイルを指定します。 プロファイルを指定しない場合、このコマンドレットはローカルの既定のプロファイルから読み取ります。

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

-SubscriptionId

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

-SubscriptionName

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

-WhatIf

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

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

入力

None

このコマンドレットへの入力はプロパティ名でパイプできますが、値によるパイプ処理は行いません。

出力

None or System.Boolean

PassThru パラメーターを使用すると、このコマンドレットはブール値を返します。 それ以外の場合、出力は返しません。