Add-AzureAccount

リファレンス

モジュール:: Azure

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

Note

このドキュメントで参照されているコマンドレットは、Service Management API を使用するレガシ Azure リソースを管理するためのものです。 Azure Resource Manager リソースを管理するためのコマンドレットについては、Az 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-AzurePublish設定File を使用できます。使用する方法のガイダンスについては、「方法: サブスクリプションに接続する (https://azure.microsoft.com/documentation/articles/install-configure-powershell/#Connect)」を参照してください。

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

パラメーター

-Credential

Type:	PSCredential
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Environment

Azure 環境を指定します。

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Profile

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

Type:	AzureSMProfile
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ServicePrincipal

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Tenant

Type:	String
Aliases:	TenantId
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

入力

None

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

出力