Add-AzureAccount

モジュール:: Azure

Windows PowerShell に Azure アカウントを追加します。

注

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

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

構文

Add-AzureAccount
   [-Environment <String>]
   [-Credential <PSCredential>]
   [-Tenant <String>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Add-AzureAccount
   [-Environment <String>]
   -Credential <PSCredential>
   [-ServicePrincipal]
   -Tenant <String>
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

説明

Add-AzureAccount コマンドレットを使用すると、Azure アカウントとそのサブスクリプションを Windows PowerShell で使用できるようになります。これは、Windows PowerShell で Azure アカウントにログインするのと同じです。アカウントからログアウトするには、 Remove-AzureAccount コマンドレットを使用します。

Add-AzureAccount は、Azure アカウントに関する情報をダウンロードし、ローミングユーザープロファイルのサブスクリプションデータファイルに保存します。また、Windows PowerShell がユーザーに代わって Azure アカウントにアクセスできるようにするアクセストークンも取得します。コマンドが完了したら、Windows PowerShell で Azure アカウントを管理できます。

Azure アカウントを Windows PowerShell で使用できるようにする方法は 2 つあります。 Microsoft Entra 認証アクセストークンを使用する Add-AzureAccount コマンドレット、または管理証明書を使用する Import-AzurePublishSettingsFile を使用できます。

Add-AzureAccount を実行すると、Azure アカウントへのサインインを求める対話型ウィンドウが表示されます。このサインインは、アクセストークンの有効期限が切れるまで有効です。有効期限が切れると、アカウントへのアクセスを必要とするコマンドレットは、 Add-AzureAccount を再度実行するように求められます。

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

例

例 1: アカウントを追加する

PS C:\> Add-AzureAccount

このコマンドは、Windows PowerShell に Azure アカウントを追加します。コマンドを実行すると、アカウントのユーザー名とパスワードを要求するウィンドウが表示されます。

例 2: 代替サブスクリプションデータファイルを使用する

PS C:\> Add-AzureAccount -SubscriptionDataFile C:\Testing\SDF.xml

このコマンドでは、 SubscriptionDataFile パラメーターを使用して、既定のファイルではなく、 Add-AzureAccount にアカウントデータを C:\Testing\SDF.xml ファイルに格納するように指示します。

パラメーター

-Credential

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

-Environment

Azure 環境を指定します。

Azure 環境は、グローバル Azure 用の AzureCloud や、中国の 21Vianet によって運用される AzureChinaCloud for Azure など、Microsoft Azure の独立したデプロイです。また、Azure Pack と WAPack コマンドレットを使用して、オンプレミスの Azure 環境を作成することもできます。詳細については、「 Azure Pack」を参照してください。

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

-Profile

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

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

-ServicePrincipal

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

-Tenant

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

入力

None

このコマンドレットに入力をパイプすることはできません

出力

None

このコマンドレットによる戻り値はありません。

メモ

Add-AzureAccount (および Microsoft Entra 認証方法) は、 Import-AzurePublishSettings (および管理証明書の方法) よりも優先されます。アカウントで Add-AzureAccount を 1 回でも使用する場合、Microsoft Entra 認証方法が使用され、管理証明書は無視されます。 Microsoft Entra トークンを削除し、管理証明書メソッドを復元するには、 Remove-AzureAccount コマンドレットを使用します。詳細については、「 Get-Help Remove-AzureAccount」と入力します。
"資格情報の有効期限が切れています。 Add-AzureAccount を使用してもう一度ログインしてください。アクセストークンの有効期限が切れており、Windows PowerShell が Azure アカウントにアクセスできないことを示します。アカウントへのアクセスを復元するには、 Add-AzureAccount をもう一度実行します。
Azure PowerShell アカウントとサブスクリプションコマンドレットは、ライブ Azure アカウントからではなく、サブスクリプションデータファイルからデータを取得します。 Azure 管理ポータルを使用するなど、Windows PowerShell の外部でアカウントまたはサブスクリプションを変更する場合は、 Add-AzureAccount をもう一度実行して、サブスクリプションデータファイルを更新します。