Add-SqlAzureAuthenticationContext
Azure への認証を実行し、認証トークンを取得します。
構文
Add-SqlAzureAuthenticationContext
[-Interactive]
[<CommonParameters>]
Add-SqlAzureAuthenticationContext
[-Interactive]
[-ActiveDirectoryAuthority] <String>
[-AzureKeyVaultResourceId] <String>
[[-AzureManagedHsmResourceId] <String>]
[<CommonParameters>]
Add-SqlAzureAuthenticationContext
[-ClientID] <String>
[-Secret] <String>
[-Tenant] <String>
[<CommonParameters>]
Add-SqlAzureAuthenticationContext
[-ClientID] <String>
[-Secret] <String>
[-Tenant] <String>
[-ActiveDirectoryAuthority] <String>
[-AzureKeyVaultResourceId] <String>
[[-AzureManagedHsmResourceId] <String>]
[<CommonParameters>]
Add-SqlAzureAuthenticationContext
[-ClientID] <String>
[-CertificateThumbprint] <String>
[-Tenant] <String>
[<CommonParameters>]
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 'ad34ca5a-a479-4cf4-b166-a2177b32d33e' -Secret '[Placeholder]' -Tenant '41fb6cc6-96f4-479d-bafd-a2e4810eb100'
このコマンドは、指定したテナントで定義されている、指定したクライアント ID を使用して、Azure Resource Managerに対してアプリケーション プリンシパルの認証を実行します。
パラメーター
-ActiveDirectoryAuthority
Azure Active Directory 認証の基本機関を指定します。 Azure PowerShell Environment オブジェクトの ActiveDirectoryAuthority プロパティと同じ値。
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AzureKeyVaultResourceId
Azure Key Vault サービスのリソース ID を指定します。 Azure PowerShell Environment オブジェクトの AzureKeyVaultServiceEndpointResourceId プロパティと同じ値。
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AzureManagedHsmResourceId
Azure Managed HSM サービスのリソース ID を指定します。 マネージド HSM リソースが Azure パブリック クラウド以外の Azure インスタンスにある場合は、このパラメーターを使用して既定値 https://managedhsm.azure.net
をオーバーライドします。
Type: | String |
Position: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CertificateThumbprint
使用する証明書を識別するために使用する拇印を指定します。 コマンドレットは、証明書ストアと LocalMachine
証明書ストアの両方CurrentUser
を検索します。
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ClientID
アプリケーション クライアント ID を指定します。
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Interactive
このコマンドレットがユーザーに資格情報の入力を求めるメッセージを表示することを示します。
Type: | SwitchParameter |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Secret
アプリケーション シークレットを指定します。
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Tenant
Azure 内のテナントを指定します。
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
出力
System.Object