Connect-AzureAD
認証されたアカウントを使用して、Active Directory コマンドレット要求を使用します。
構文
UserCredential (既定)
Connect-AzureAD
[-AzureEnvironmentName <EnvironmentName>]
[-TenantId <String>]
[-Credential <PSCredential>]
[-AccountId <String>]
[-LogLevel <LogLevel>]
[-LogFilePath <String>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ServicePrincipalCertificate
Connect-AzureAD
-TenantId <String>
-CertificateThumbprint <String>
-ApplicationId <String>
[-AzureEnvironmentName <EnvironmentName>]
[-LogLevel <LogLevel>]
[-LogFilePath <String>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
AccessToken
Connect-AzureAD
-AadAccessToken <String>
-AccountId <String>
[-AzureEnvironmentName <EnvironmentName>]
[-TenantId <String>]
[-MsAccessToken <String>]
[-LogLevel <LogLevel>]
[-LogFilePath <String>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Connect-AzureAD コマンドレットは、Azure Active Directory コマンドレット要求に使用する認証済みアカウントを接続します。
この認証済みアカウントは、Azure Active Directory コマンドレットでのみ使用できます。
例
例 1: PowerShell セッションをテナントに接続する
PS C:\> Connect-AzureAD -Confirm
このコマンドは、現在の PowerShell セッションを Azure Active Directory テナントに接続します。 このコマンドでは、接続するテナントのユーザー名とパスワードの入力を求められます。 [確認] パラメーターで確認を求められます。
資格情報に対して多要素認証が有効になっている場合は、対話型オプションを使用してログインするか、サービス プリンシパル認証を使用する必要があります。
例 2: 変数を使用してセッションを接続する
PS C:\> $Credential = Get-Credential
PS C:\> Connect-AzureAD -Credential $Credential
最初のコマンドは、ユーザー資格情報を取得し、$Credential変数に格納します。
2 番目のコマンドは、$Credential の資格情報を使用して現在の PowerShell セッションに接続します。
このアカウントは、組織 ID の資格情報を使用して Azure Active Directory で認証します。 多要素認証または Microsoft アカウントの資格情報を使用して、このアカウントで Azure Active Directory コマンドレットを実行することはできません。
例 3: セッションをサービス プリンシパルとして接続する
# Login to Azure AD PowerShell With Admin Account
Connect-AzureAD
# Create the self signed cert
$currentDate = Get-Date
$endDate = $currentDate.AddYears(1)
$notAfter = $endDate.AddYears(1)
$pwd = "<password>"
$thumb = (New-SelfSignedCertificate -CertStoreLocation cert:\localmachine\my -DnsName com.foo.bar -KeyExportPolicy Exportable -Provider "Microsoft Enhanced RSA and AES Cryptographic Provider" -NotAfter $notAfter).Thumbprint
$pwd = ConvertTo-SecureString -String $pwd -Force -AsPlainText
Export-PfxCertificate -cert "cert:\localmachine\my\$thumb" -FilePath c:\temp\examplecert.pfx -Password $pwd
# Load the certificate
$cert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate("C:\temp\examplecert.pfx", $pwd)
$keyValue = [System.Convert]::ToBase64String($cert.GetRawCertData())
# Create the Azure Active Directory Application
$application = New-AzureADApplication -DisplayName "test123" -IdentifierUris "https://test123"
New-AzureADApplicationKeyCredential -ObjectId $application.ObjectId -CustomKeyIdentifier "Test123" -StartDate $currentDate -EndDate $endDate -Type AsymmetricX509Cert -Usage Verify -Value $keyValue
# Create the Service Principal and connect it to the Application
$sp=New-AzureADServicePrincipal -AppId $application.AppId
# Give the Service Principal Reader access to the current tenant (Get-AzureADDirectoryRole)
Add-AzureADDirectoryRoleMember -ObjectId aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb -RefObjectId $sp.ObjectId
# Get Tenant Detail
$tenant=Get-AzureADTenantDetail
# Now you can login to Azure PowerShell with your Service Principal and Certificate
Connect-AzureAD -TenantId $tenant.ObjectId -ApplicationId $sp.AppId -CertificateThumbprint $thumb
このコマンドは、サービス プリンシパルとして Azure Active Directory に対してユーザーを認証します。
パラメーター
-AadAccessToken
Azure Active Directory Graph アクセス トークンを指定します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AccessToken
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-AccountId
アカウントの ID を指定します。 ユーザー アクセス トークンで認証する場合は、ユーザーの UPN を指定する必要があります。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
UserCredential
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ApplicationId
サービス プリンシパルのアプリケーション ID を指定します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ServicePrincipalCertificate
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-AzureEnvironmentName
Azure 環境の名前を指定します。 このパラメーターに使用できる値は次のとおりです。
- AzureCloud
- AzureChinaCloud
- AzureUSGovernment (英語)
- AzureGermanyCloud
既定値は AzureCloud です。
パラメーターのプロパティ
| 型: | EnvironmentName |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-CertificateThumbprint
このアクションを実行する権限を持つユーザー アカウントのデジタル公開キー X.509 証明書の証明書拇印を指定します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ServicePrincipalCertificate
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Credential
PSCredential オブジェクトを指定します。 PSCredential オブジェクトの詳細については、「Get-Help Get-Credential」と入力します。
PSCredential オブジェクトは、組織 ID 資格情報のユーザー ID とパスワードを提供します。
パラメーターのプロパティ
| 型: | PSCredential |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
UserCredential
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-InformationAction
このコマンドレットが情報イベントに応答する方法を指定します。 このパラメーターに使用できる値は次のとおりです。
- 続ける
- 不問に付す
- 問い合わせる
- 静かに続行
- 止まれ
- [中断]
パラメーターのプロパティ
| 型: | ActionPreference |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | infa |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-InformationVariable
情報イベント・メッセージを格納する変数を指定します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | iv |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-LogFilePath
この PowerShell セッションのログ ファイルが書き込まれるパス。 既定の PowerShell ログ ファイルの場所から逸脱する必要がある場合は、ここに値を指定します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-LogLevel
ログ・レベルを指定します。 このパラメータの計算可能な値は次のとおりです。
- 情報
- エラー
- Warnung
- 無し
既定値は Info です。
パラメーターのプロパティ
| 型: | LogLevel |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-MsAccessToken
Microsoft Graph アクセス トークンを指定します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AccessToken
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-TenantId
テナントの ID を指定します。
このパラメータを指定しない場合、アカウントはホームテナントで認証されます。
サービス プリンシパルとして認証する場合、または Microsoft アカウントを使用する場合に、TenantId パラメーターを指定する必要があります。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ドメイン, テナントドメイン |
パラメーター セット
UserCredential
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
AccessToken
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。