Remove-AzureAccount

  • リファレンス
モジュール:
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-AzureAccount
      -Name <String>
      [-Force]
      [-PassThru]
      [-Profile <AzureSMProfile>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Remove-AzureAccount コマンドレットは、移動ユーザー プロファイルのサブスクリプション データ ファイルから Azure アカウントとそのサブスクリプションを削除します。 Microsoft Azure からアカウントを削除したり、実際のアカウントを変更したりすることはありません。

このコマンドレットの使用は、Azure アカウントからログアウトするのとよく似ています。 また、もう一度アカウントにログインする場合は、Add-AzureAccount または Import-AzurePublishSettingsFile を使用して、アカウントを Windows PowerShell に再度追加します。

Remove-AzureAccount コマンドレットを使用して、Azure PowerShell コマンドレットが Azure アカウントにサインインする方法を変更することもできます。 アカウントに Import-AzurePublishSettingsFile の管理証明書と Add-AzureAccount からのアクセス トークンの両方がある場合、Azure PowerShell コマンドレットはアクセス トークンのみを使用します。管理証明書は無視されます。 管理証明書を使用するには、Remove-AzureAccount を実行 します。 Remove-AzureAccount は、管理証明書とアクセス トークンの両方を検索すると、アカウントを削除するのではなく、アクセス トークンのみを削除します。 管理証明書は引き続き存在するため、アカウントは Windows PowerShell で引き続き使用できます。

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

例

例 1: アカウントを削除する

PS C:\> Remove-AzureAccount -Name admin@contoso.com

このコマンドを実行すると、 admin@contoso.com サブスクリプション データ ファイルから削除されます。 コマンドが完了すると、アカウントは Windows PowerShell で使用できなくなります。

パラメーター

-Confirm

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

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

-Force

確認プロンプトを非表示にします。 既定では、 Windows PowerShell からアカウントを削除する前に、Remove-AzureAccount によってプロンプトが表示されます。

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

-Name

削除するアカウントの名前を指定します。 パラメーター値では大文字と小文字が区別されます。 ワイルドカード文字はサポートされていません。

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

-PassThru

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

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

-Profile

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

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

-WhatIf

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

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

入力

None

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

出力

None or System.Boolean

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