Add-SqlAzureAuthenticationContext
Azure への認証を実行し、認証トークンを取得します。
構文
DefaultAzureCredential Public
Add-SqlAzureAuthenticationContext
[[-ExcludeCredential] <CredentialType[]>]
[-DefaultAzureCredential]
[<CommonParameters>]
DefaultAzureCredential Private
Add-SqlAzureAuthenticationContext
[[-ExcludeCredential] <CredentialType[]>]
[-ActiveDirectoryAuthority] <String>
[-AzureKeyVaultResourceId] <String>
[[-AzureManagedHsmResourceId] <String>]
[-DefaultAzureCredential]
[<CommonParameters>]
Interactive Public
Add-SqlAzureAuthenticationContext
[-Interactive]
[<CommonParameters>]
Interactive Private
Add-SqlAzureAuthenticationContext
[-ActiveDirectoryAuthority] <String>
[-AzureKeyVaultResourceId] <String>
[[-AzureManagedHsmResourceId] <String>]
[-Interactive]
[<CommonParameters>]
ClientIdSecret Public
Add-SqlAzureAuthenticationContext
[-ClientID] <String>
[-Secret] <String>
[-Tenant] <String>
[<CommonParameters>]
ClientIdSecret Private
Add-SqlAzureAuthenticationContext
[-ClientID] <String>
[-Secret] <String>
[-Tenant] <String>
[-ActiveDirectoryAuthority] <String>
[-AzureKeyVaultResourceId] <String>
[[-AzureManagedHsmResourceId] <String>]
[<CommonParameters>]
ClientIdCertificate Public
Add-SqlAzureAuthenticationContext
[-ClientID] <String>
[-CertificateThumbprint] <String>
[-Tenant] <String>
[<CommonParameters>]
ClientIdCertificate Private
Add-SqlAzureAuthenticationContext
[-ClientID] <String>
[-CertificateThumbprint] <String>
[-Tenant] <String>
[-ActiveDirectoryAuthority] <String>
[-AzureKeyVaultResourceId] <String>
[[-AzureManagedHsmResourceId] <String>]
[<CommonParameters>]
説明
Add-SqlAzureAuthenticationContext コマンドレットは、指定したプリンシパル アカウントを Azure Resource Manager に対して認証します。 このコマンドレットは、Azure Key Vault などの Azure リソースと対話する他のコマンドレットと共に使用します。
Module requirements: version 21+ on PowerShell 5.1; version 22+ on PowerShell 7.x.
例
例 1: Azure Resource Manager に対してユーザーを認証するための資格情報の入力をユーザーに求める
Add-SqlAzureAuthenticationContext -Interactive
このコマンドは、ユーザーにユーザー名とパスワードの入力を求め、そのユーザーを Azure Resource Manager に対して認証します。
例 2: Azure Resource Manager に対するユーザーの認証
Add-SqlAzureAuthenticationContext -ClientID '00001111-aaaa-2222-bbbb-3333cccc4444' -Secret '[Placeholder]' -Tenant '11112222-bbbb-3333-cccc-4444dddd5555'
このコマンドは、指定したテナントで定義されている指定したクライアント ID を使用して、Azure Resource Manager に対してアプリケーション プリンシパルの認証を実行します。
例 3: DefaultAzureCredential を使用して Azure Resource Manager に対してユーザーを認証する
Add-SqlAzureAuthenticationContext -DefaultAzureCredential
このコマンドは、有効になっている場合は、次の資格情報の種類を使用してトークンを取得します。EnvironmentCredential、WorkloadIdentityCredential、ManagedIdentityCredential、SharedTokenCacheCredential、VisualStudioCredential、VisualStudioCodeCredential、AzureCliCredential、AzurePowerShellCredential、AzureDeveloperCliCredential、InteractiveBrowserCredential。
例 4: DefaultAzureCredential を使用するが、Azure Resource Manager に対してユーザーを認証するためにいくつかの資格情報の種類を除外する
Add-SqlAzureAuthenticationContext -DefaultAzureCredential `
-ExcludeCredentials EnvironmentCredential, AzureDeveloperCliCredential
このコマンドは、有効になっている場合は、次の資格情報の種類を使用してトークンを取得します。WorkloadIdentityCredential、ManagedIdentityCredential、SharedTokenCacheCredential、VisualStudioCredential、VisualStudioCodeCredential、AzureCliCredential、AzurePowerShellCredential、InteractiveBrowserCredential。
EnvironmentCredential、AzureDeveloperCliCredential は上記の種類から除外されることに注意してください。
パラメーター
-ActiveDirectoryAuthority
Azure Active Directory 認証の基本機関を指定します。
Azure PowerShell Environment オブジェクトの ActiveDirectoryAuthority プロパティと同じ値。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
DefaultAzureCredential Private
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
Interactive Private
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ClientIdSecret Private
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ClientIdCertificate Private
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-AzureKeyVaultResourceId
Azure Key Vault サービスのリソース ID を指定します。 Azure PowerShell Environment オブジェクトの AzureKeyVaultServiceEndpointResourceId プロパティと同じ値。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
DefaultAzureCredential Private
| 配置: | 2 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
Interactive Private
| 配置: | 2 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ClientIdSecret Private
| 配置: | 2 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ClientIdCertificate Private
| 配置: | 2 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-AzureManagedHsmResourceId
Azure Managed HSM サービスのリソース ID を指定します。 マネージド HSM リソースが Azure パブリック クラウド以外の Azure インスタンスにある場合に https://managedhsm.azure.net 既定値をオーバーライドするには、このパラメーターを使用します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
DefaultAzureCredential Private
| 配置: | 2 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
Interactive Private
| 配置: | 2 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ClientIdSecret Private
| 配置: | 2 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ClientIdCertificate Private
| 配置: | 2 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-CertificateThumbprint
使用する証明書を識別するために使用する拇印を指定します。 コマンドレットは、 CurrentUser と LocalMachine の両方の証明書ストアを検索します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ClientIdCertificate Public
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ClientIdCertificate Private
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ClientID
アプリケーション クライアント ID を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ClientIdSecret Public
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ClientIdSecret Private
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ClientIdCertificate Public
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ClientIdCertificate Private
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultAzureCredential
このコマンドレットがトークンの取得に DefaultAzureCredential を使用することを示します。
有効になっている場合は、次の資格情報の種類が順番に試行されます。
- EnvironmentCredential
- WorkloadIdentityCredential
- ManagedIdentityCredential
- SharedTokenCacheCredential
- VisualStudioCredential
- VisualStudioCodeCredential
- AzureCliCredential
- AzurePowerShellCredential
- AzureDeveloperCliCredential
- InteractiveBrowserCredential
各資格情報の種類の詳細については、 DefaultAzureCredential クラス を参照してください。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
DefaultAzureCredential Public
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
DefaultAzureCredential Private
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ExcludeCredential
DefaultAzureCredential が、トークンの取得中に指定された資格情報の種類の一覧を除外する必要があることを示します。
パラメーターのプロパティ
| 型: | CredentialType[]
|
| 規定値: | None |
| 指定可能な値: | EnvironmentCredential, WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, AzureDeveloperCliCredential, InteractiveBrowserCredential |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
DefaultAzureCredential Public
| 配置: | 1 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
DefaultAzureCredential Private
| 配置: | 1 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Interactive
このコマンドレットがユーザーに資格情報の入力を求めるメッセージを表示することを示します。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Interactive Public
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
Interactive Private
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Secret
アプリケーション シークレットを指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ClientIdSecret Public
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ClientIdSecret Private
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Tenant
Azure のテナントを指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ClientIdSecret Public
| 配置: | 2 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ClientIdSecret Private
| 配置: | 2 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ClientIdCertificate Public
| 配置: | 2 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ClientIdCertificate Private
| 配置: | 2 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力
System.Object