Add-SqlAzureAuthenticationContext

  • リファレンス
モジュール:
SQLServer

Azure への認証を実行し、認証トークンを取得します。

構文

Add-SqlAzureAuthenticationContext
   [-DefaultAzureCredential]
   [[-ExcludeCredential] <CredentialType[]>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Add-SqlAzureAuthenticationContext
   [-DefaultAzureCredential]
   [[-ExcludeCredential] <CredentialType[]>]
   [-ActiveDirectoryAuthority] <String>
   [-AzureKeyVaultResourceId] <String>
   [[-AzureManagedHsmResourceId] <String>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Add-SqlAzureAuthenticationContext
   [-Interactive]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Add-SqlAzureAuthenticationContext
   [-Interactive]
   [-ActiveDirectoryAuthority] <String>
   [-AzureKeyVaultResourceId] <String>
   [[-AzureManagedHsmResourceId] <String>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Add-SqlAzureAuthenticationContext
   [-ClientID] <String>
   [-Secret] <String>
   [-Tenant] <String>
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Add-SqlAzureAuthenticationContext
   [-ClientID] <String>
   [-Secret] <String>
   [-Tenant] <String>
   [-ActiveDirectoryAuthority] <String>
   [-AzureKeyVaultResourceId] <String>
   [[-AzureManagedHsmResourceId] <String>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Add-SqlAzureAuthenticationContext
   [-ClientID] <String>
   [-CertificateThumbprint] <String>
   [-Tenant] <String>
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Add-SqlAzureAuthenticationContext
   [-ClientID] <String>
   [-CertificateThumbprint] <String>
   [-Tenant] <String>
   [-ActiveDirectoryAuthority] <String>
   [-AzureKeyVaultResourceId] <String>
   [[-AzureManagedHsmResourceId] <String>]
   [-ProgressAction <ActionPreference>]
   [<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 'ad34ca5a-a479-4cf4-b166-a2177b32d33e' -Secret '[Placeholder]' -Tenant '41fb6cc6-96f4-479d-bafd-a2e4810eb100'

このコマンドは、指定したテナントで定義されている指定したクライアント 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
配置:1
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-AzureKeyVaultResourceId

Azure Key Vault サービスのリソース ID を指定します。 Azure PowerShell Environment オブジェクトの AzureKeyVaultServiceEndpointResourceId プロパティと同じ値。

型:String
配置:2
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-AzureManagedHsmResourceId

Azure Managed HSM サービスのリソース ID を指定します。 マネージド HSM リソースが Azure パブリック クラウド以外の Azure インスタンスにある場合に https://managedhsm.azure.net 既定値をオーバーライドするには、このパラメーターを使用します。

型:String
配置:2
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-CertificateThumbprint

使用する証明書を識別するために使用する拇印を指定します。 コマンドレットは、CurrentUser と LocalMachine の両方の証明書ストアを検索します。

型:String
配置:1
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-ClientID

アプリケーション クライアント ID を指定します。

型:String
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-DefaultAzureCredential

このコマンドレットがトークンの取得に DefaultAzureCredential を使用することを示します。 有効になっている場合は、次の資格情報の種類が順番に試行されます。

  • EnvironmentCredential
  • WorkloadIdentityCredential
  • ManagedIdentityCredential
  • SharedTokenCacheCredential
  • VisualStudioCredential
  • VisualStudioCodeCredential
  • AzureCliCredential
  • AzurePowerShellCredential
  • AzureDeveloperCliCredential
  • InteractiveBrowserCredential

各資格情報 種類の詳細については、DefaultAzureCredential クラスの を参照してください。

型:SwitchParameter
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-ExcludeCredential

DefaultAzureCredential が、トークンの取得中に指定された資格情報の種類の一覧を除外する必要があることを示します。

型:CredentialType[]
指定可能な値:EnvironmentCredential, WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, AzureDeveloperCliCredential, InteractiveBrowserCredential
配置:1
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Interactive

このコマンドレットがユーザーに資格情報の入力を求めるメッセージを表示することを示します。

型:SwitchParameter
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-ProgressAction

スクリプト、コマンドレット、またはプロバイダーによって生成された進行状況の更新 (Write-Progress コマンドレットによって生成された進行状況バーなど) に対する PowerShell の応答方法を決定します。 Write-Progress コマンドレットは、コマンドの状態を示す進行状況バーを作成します。

型:ActionPreference
Aliases:proga
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Secret

アプリケーション シークレットを指定します。

型:String
配置:1
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Tenant

Azure のテナントを指定します。

型:String
配置:2
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

出力

System.Object