共用方式為

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>]

Description

Add-SqlAzureAuthenticationContext Cmdlet 會將指定的主體帳戶驗證至 Azure Resource Manager。 使用此 Cmdlet 與其他與 Azure 資源互動的 Cmdlet，例如 Azure Key Vault。

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'

此命令會使用在指定租用戶中定義的指定用戶端標識符，對 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
Position:1
預設值:None
必要:True
接受管線輸入:False
接受萬用字元:False

-AzureKeyVaultResourceId

指定 Azure Key Vault 服務的資源識別碼。 與 Azure PowerShell Environment 物件的 AzureKeyVaultServiceEndpointResourceId 屬性相同。

類型:String
Position:2
預設值:None
必要:True
接受管線輸入:False
接受萬用字元:False

-AzureManagedHsmResourceId

指定 Azure 受控 HSM 服務的資源識別碼。 當您的受控 HSM 資源位於 Azure 公用雲端以外的 Azure 實例時，請使用此參數來覆寫預設值 https://managedhsm.azure.net。

類型:String
Position:2
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-CertificateThumbprint

指定要用來識別要使用的憑證指紋。 Cmdlet 會同時搜尋 CurrentUser 和 LocalMachine 證書存儲。

類型:String
Position:1
預設值:None
必要:True
接受管線輸入:False
接受萬用字元:False

-ClientID

指定應用程式用戶端識別碼。

類型:String
Position:0
預設值:None
必要:True
接受管線輸入:False
接受萬用字元:False

-DefaultAzureCredential

指出此 Cmdlet 會使用 DefaultAzureCredential 來取得令牌。 如果已啟用，將會依序嘗試下列認證類型：

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

如需每個認證類型的詳細資訊，請參閱 DefaultAzureCredential 類別。

類型:SwitchParameter
Position:0
預設值:None
必要:True
接受管線輸入:False
接受萬用字元:False

-ExcludeCredential

指出 DefaultAzureCredential 應該排除取得令牌時所指定的認證類型清單。

類型:CredentialType[]
接受的值:EnvironmentCredential, WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, AzureDeveloperCliCredential, InteractiveBrowserCredential
Position:1
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Interactive

指出此 Cmdlet 會提示使用者輸入認證。

類型:SwitchParameter
Position:0
預設值:None
必要:True
接受管線輸入:False
接受萬用字元:False

-ProgressAction

決定 PowerShell 如何回應腳本、Cmdlet 或提供者所產生的進度更新，例如 Write-Progress Cmdlet 所產生的進度列。 Write-Progress Cmdlet 會建立顯示命令狀態的進度列。

類型:ActionPreference
別名:proga
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Secret

指定應用程式秘密。

類型:String
Position:1
預設值:None
必要:True
接受管線輸入:False
接受萬用字元:False

-Tenant

指定 Azure 中的租使用者。

類型:String
Position:2
預設值:None
必要:True
接受管線輸入:False
接受萬用字元:False

輸出

System.Object