Connect-AzureRmAccount

リファレンス

モジュール:: AzureRM.Profile

Azure Resource Manager コマンドレット要求で使用するために、認証されたアカウントを使用して Azure に接続します。

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

Connect-AzureRmAccount
       [-Environment <String>]
       [[-Credential] <PSCredential>]
       [-TenantId <String>]
       [-Subscription <String>]
       [-ContextName <String>]
       [-SkipContextPopulation]
       [-Force]
       [-Scope <ContextModificationScope>]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Connect-AzureRmAccount
       [-Environment <String>]
       [-Credential] <PSCredential>
       [-ServicePrincipal]
       -TenantId <String>
       [-Subscription <String>]
       [-ContextName <String>]
       [-SkipContextPopulation]
       [-Force]
       [-Scope <ContextModificationScope>]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Connect-AzureRmAccount
       [-Environment <String>]
       -CertificateThumbprint <String>
       -ApplicationId <String>
       [-ServicePrincipal]
       -TenantId <String>
       [-Subscription <String>]
       [-ContextName <String>]
       [-SkipContextPopulation]
       [-Force]
       [-Scope <ContextModificationScope>]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Connect-AzureRmAccount
       [-Environment <String>]
       [-TenantId <String>]
       -AccessToken <String>
       [-GraphAccessToken <String>]
       [-KeyVaultAccessToken <String>]
       -AccountId <String>
       [-Subscription <String>]
       [-ContextName <String>]
       [-SkipValidation]
       [-SkipContextPopulation]
       [-Force]
       [-Scope <ContextModificationScope>]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Connect-AzureRmAccount
       [-Environment <String>]
       [-TenantId <String>]
       [-AccountId <String>]
       [-Identity]
       [-ManagedServicePort <Int32>]
       [-ManagedServiceHostName <String>]
       [-ManagedServiceSecret <SecureString>]
       [-Subscription <String>]
       [-ContextName <String>]
       [-SkipContextPopulation]
       [-Force]
       [-Scope <ContextModificationScope>]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

説明

Connect-AzureRmAccount コマンドレットは、Azure Resource Manager コマンドレット要求で使用するために、認証されたアカウントを使用して Azure に接続します。この認証済みアカウントは、Azure Resource Manager コマンドレットでのみ使用できます。 Service Management コマンドレットで使用する認証済みアカウントを追加するには、Add-AzureAccount または Import-AzurePublish設定File コマンドレットを使用します。現在のユーザーのコンテキストが見つからない場合、このコマンドはユーザーのコンテキストリストに各 (最初の 25) サブスクリプションのコンテキストを設定します。ユーザー用に作成されたコンテキストの一覧は、"Get-AzureRmContext -ListAvailable" を実行することで確認できます。このコンテキストの作成をスキップするには、"-SkipContextPopulation" スイッチパラメーターを指定してこのコマンドを実行します。このコマンドレットを実行した後、Disconnect-AzureRmAccount を使用して Azure アカウントから切断できます。

例

例 1: 対話型ログインを使用して Azure アカウントに接続する

PS C:\> Connect-AzureRmAccount

Account                SubscriptionName TenantId                Environment
-------                ---------------- --------                -----------
azureuser@contoso.com  Subscription1    xxxx-xxxx-xxxx-xxxx     AzureCloud

このコマンドは、Azure アカウントに接続します。このアカウントで Azure Resource Manager コマンドレットを実行するには、プロンプトで Microsoft アカウントまたは組織 ID の資格情報を指定する必要があります。資格情報に対して多要素認証が有効になっている場合は、対話型オプションを使用してログインするか、サービスプリンシパル認証を使用する必要があります。

例 2: 組織 ID 資格情報を使用して Azure アカウントに接続する

PS C:\> $Credential = Get-Credential
PS C:\> Connect-AzureRmAccount -Credential $Credential

Account                SubscriptionName TenantId                Environment
-------                ---------------- --------                -----------
azureuser@contoso.com  Subscription1    xxxx-xxxx-xxxx-xxxx     AzureCloud

最初のコマンドは、ユーザー資格情報 (ユーザー名とパスワード) を求め、$Credential変数に格納します。 2 番目のコマンドは、$Credentialに格納されている資格情報を使用して Azure アカウントに接続します。このアカウントは、組織の ID 資格情報を使用して Azure Resource Manager で認証されます。多要素認証または Microsoft アカウント資格情報を使用して、このアカウントで Azure Resource Manager コマンドレットを実行することはできません。

例 3: Azure サービスプリンシパルアカウントに接続する

PS C:\> $Credential = Get-Credential

PS C:\> Connect-AzureRmAccount -Credential $Credential -Tenant "xxxx-xxxx-xxxx-xxxx" -ServicePrincipal
Account                SubscriptionName TenantId                Environment
-------                ---------------- --------                -----------
xxxx-xxxx-xxxx-xxxx    Subscription1    xxxx-xxxx-xxxx-xxxx     AzureCloud

最初のコマンドは、サービスプリンシパルの資格情報 (アプリケーション ID とサービスプリンシパルシークレット) を取得し、$Credential変数に格納します。 2 番目のコマンドは、指定したテナントの$Credentialに格納されているサービスプリンシパル資格情報を使用して Azure に接続します。 ServicePrincipal スイッチパラメーターは、アカウントがサービスプリンシパルとして認証されることを示します。

例 4: 対話型ログインを使用して、特定のテナントとサブスクリプションのアカウントに接続する

PS C:\> Connect-AzureRmAccount -Tenant "xxxx-xxxx-xxxx-xxxx" -SubscriptionId "yyyy-yyyy-yyyy-yyyy"
Account                SubscriptionName TenantId                Environment
-------                ---------------- --------                -----------
azureuser@contoso.com  Subscription1    xxxx-xxxx-xxxx-xxxx     AzureCloud

このコマンドは、Azure アカウントに接続し、指定されたテナントとサブスクリプションのコマンドレットを既定で実行するように AzureRM PowerShell を構成します。

例 5: マネージドサービス ID ログインを使用してアカウントを追加する

PS C:\> Connect-AzureRmAccount -MSI

Account                SubscriptionName TenantId                Environment
-------                ---------------- --------                -----------
MSI@50342              Subscription1    xxxx-xxxx-xxxx-xxxx     AzureCloud

このコマンドは、ホスト環境のマネージドサービス ID を使用して接続します (たとえば、割り当てられたマネージドサービス ID を持つ VirtualMachine で実行された場合、これにより、割り当てられた ID を使用してコードがログインできるようになります)。

例 6: 証明書を使用してアカウントを追加する

# For more information on creating a self-signed certificate
# and giving it proper permissions, please see the following:
# https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-authenticate-service-principal-powershell
PS C:\> $Thumbprint = "0SZTNJ34TCCMUJ5MJZGR8XQD3S0RVHJBA33Z8ZXV"
PS C:\> $TenantId = "4cd76576-b611-43d0-8f2b-adcb139531bf"
PS C:\> $ApplicationId = "3794a65a-e4e4-493d-ac1d-f04308d712dd"
PS C:\> Connect-AzureRmAccount -CertificateThumbprint $Thumbprint -ApplicationId $ApplicationId -Tenant $TenantId -ServicePrincipal

Account             SubscriptionName TenantId            Environment
-------             ---------------- --------            -----------
xxxx-xxxx-xxxx-xxxx Subscription1    xxxx-xxxx-xxxx-xxxx AzureCloud

Account          : 3794a65a-e4e4-493d-ac1d-f04308d712dd
SubscriptionName : MyTestSubscription
SubscriptionId   : 85f0f653-1f86-4d2c-a9f1-042efc00085c
TenantId         : 4cd76576-b611-43d0-8f2b-adcb139531bf
Environment      : AzureCloud

このコマンドは、証明書ベースのサービスプリンシパル認証を使用して Azure アカウントに接続します。認証に使用されるサービスプリンシパルは、指定された証明書で作成されている必要があります。

パラメーター

-AccessToken

アクセストークンを指定します。

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

-AccountId

アクセストークンのアカウント ID

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

-ApplicationId

SPN

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

-CertificateThumbprint

証明書ハッシュ (拇印)

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

-Confirm

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

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ContextName

このログインの既定のコンテキストの名前。ログイン後に、この名前でこのコンテキストを選択できます。

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

-Credential

PSCredential オブジェクトを指定します。 PSCredential オブジェクトの詳細については、「Get-Help Get-Credential」と入力します。 PSCredential オブジェクトは、組織 ID 資格情報のユーザー ID とパスワード、またはサービスプリンシパル資格情報のアプリケーション ID とシークレットを提供します。

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

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Environment

ログインするアカウントを含む環境

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

-Force

既存のコンテキストがある場合は、同じ名前で上書きします。

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

-GraphAccessToken

Graph サービスの AccessToken

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

-Identity

現在の環境でマネージドサービス ID を使用してログインします。

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

-KeyVaultAccessToken

KeyVault サービスの AccessToken

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

-ManagedServiceHostName

マネージドサービスログインのホスト名

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

-ManagedServicePort

マネージドサービスログインのポート番号

Type:	Int32
Position:	Named
Default value:	50342
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ManagedServiceSecret

シークレット。一部の種類のマネージドサービスログインに使用されます。

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

-Scope

コンテキスト変更のスコープを決定します。たとえば、変更が現在のプロセスにのみ適用されるか、このユーザーによって開始されたすべてのセッションに適用されるかなどです。

Type:	ContextModificationScope
Accepted values:	Process, CurrentUser
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

-SkipContextPopulation

コンテキストが見つからない場合は、コンテキストの作成をスキップします。

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

-SkipValidation

アクセストークンの検証をスキップする

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

-Subscription

サブスクリプション名または ID

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

-TenantId

省略可能メイン名前またはテナント ID。 Doメイン名前は、すべてのサインイン状況で機能するわけではありません。クラウドソリューションプロバイダー (CSP) のサインインには、テナント ID が必要です。

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

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

入力

String

パラメーター: サブスクリプション (ByValue)

出力

PSAzureProfile