Connect-AzureRmAccount
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 = "00001111-aaaa-2222-bbbb-3333cccc4444"
PS C:\> $ApplicationId = "00001111-aaaa-2222-bbbb-3333cccc4444"
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 : 00001111-aaaa-2222-bbbb-3333cccc4444
SubscriptionName : MyTestSubscription
SubscriptionId : 85f0f653-1f86-4d2c-a9f1-042efc00085c
TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444
Environment : AzureCloud
このコマンドは、証明書ベースのサービス プリンシパル認証を使用して Azure アカウントに接続します。 認証に使用されるサービス プリンシパルは、指定された証明書で作成されている必要があります。
パラメーター
-AccessToken
アクセス トークンを指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-AccountId
アクセス トークンのアカウント ID
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ApplicationId
SPN
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-CertificateThumbprint
証明書ハッシュ (拇印)
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ContextName
このログインの既定のコンテキストの名前。 ログイン後に、この名前でこのコンテキストを選択できます。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Credential
PSCredential オブジェクトを指定します。 PSCredential オブジェクトの詳細については、「Get-Help Get-Credential」と入力します。 PSCredential オブジェクトは、組織 ID 資格情報のユーザー ID とパスワード、またはサービス プリンシパル資格情報のアプリケーション ID とシークレットを提供します。
型: | PSCredential |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
型: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Environment
ログインするアカウントを含む環境
型: | String |
Aliases: | EnvironmentName |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Force
既存のコンテキストがある場合は、同じ名前で上書きします。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-GraphAccessToken
Graph サービスの AccessToken
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Identity
現在の環境でマネージド サービス ID を使用してログインします。
型: | SwitchParameter |
Aliases: | MSI, ManagedService |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-KeyVaultAccessToken
KeyVault サービスの AccessToken
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ManagedServiceHostName
マネージド サービス ログインのホスト名
型: | String |
配置: | Named |
規定値: | localhost |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ManagedServicePort
マネージド サービス ログインのポート番号
型: | Int32 |
配置: | Named |
規定値: | 50342 |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ManagedServiceSecret
シークレット。一部の種類のマネージド サービス ログインに使用されます。
型: | SecureString |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Scope
コンテキスト変更のスコープを決定します。たとえば、変更が現在のプロセスにのみ適用されるか、このユーザーによって開始されたすべてのセッションに適用されるかなどです。
型: | ContextModificationScope |
指定可能な値: | Process, CurrentUser |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ServicePrincipal
このアカウントがサービス プリンシパルの資格情報を指定して認証されることを示します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-SkipContextPopulation
コンテキストが見つからない場合は、コンテキストの作成をスキップします。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-SkipValidation
アクセス トークンの検証をスキップする
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Subscription
サブスクリプション名または ID
型: | String |
Aliases: | SubscriptionName, SubscriptionId |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-TenantId
省略可能メイン名前またはテナント ID。 Doメイン 名前は、すべてのサインイン状況で機能するわけではありません。 クラウド ソリューション プロバイダー (CSP) のサインインには、テナント ID が必要です。
型: | String |
Aliases: | Domain |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
パラメーター: サブスクリプション (ByValue)