Add-SqlAzureAuthenticationContext

模組:: SqlServer Module

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

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 '00001111-aaaa-2222-bbbb-3333cccc4444' -Secret '[Placeholder]' -Tenant '11112222-bbbb-3333-cccc-4444dddd5555'

此命令會使用在指定租用戶中定義的指定用戶端標識符，對 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
不要顯示:	False

參數集

DefaultAzureCredential Private

Position:	1
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

Interactive Private

Position:	1
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ClientIdSecret Private

Position:	1
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ClientIdCertificate Private

Position:	1
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-AzureKeyVaultResourceId

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

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

DefaultAzureCredential Private

Position:	2
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

Interactive Private

Position:	2
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ClientIdSecret Private

Position:	2
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ClientIdCertificate Private

Position:	2
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-AzureManagedHsmResourceId

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

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

DefaultAzureCredential Private

Position:	2
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

Interactive Private

Position:	2
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ClientIdSecret Private

Position:	2
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ClientIdCertificate Private

Position:	2
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-CertificateThumbprint

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

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

ClientIdCertificate Public

Position:	1
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ClientIdCertificate Private

Position:	1
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ClientID

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

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

ClientIdSecret Public

Position:	0
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ClientIdSecret Private

Position:	0
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ClientIdCertificate Public

Position:	0
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ClientIdCertificate Private

Position:	0
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-DefaultAzureCredential

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

EnvironmentCredential
WorkloadIdentityCredential
ManagedIdentityCredential（受管理的身份凭证）
SharedTokenCacheCredential
VisualStudioCredential
VisualStudioCodeCredential
AzureCliCredential
AzurePowerShellCredential
AzureDeveloperCliCredential
InteractiveBrowserCredential

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

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

DefaultAzureCredential Public

Position:	0
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

DefaultAzureCredential Private

Position:	0
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ExcludeCredential

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

參數屬性

類型:	CredentialType[]
預設值:	None
接受的值:	EnvironmentCredential, WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, AzureDeveloperCliCredential, InteractiveBrowserCredential
支援萬用字元:	False
不要顯示:	False

參數集

DefaultAzureCredential Public

Position:	1
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

DefaultAzureCredential Private

Position:	1
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Interactive

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

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

Interactive Public

Position:	0
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

Interactive Private

Position:	0
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Secret

指定應用程式秘密。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

ClientIdSecret Public

Position:	1
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ClientIdSecret Private

Position:	1
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Tenant

指定 Azure 中的租使用者。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

ClientIdSecret Public

Position:	2
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ClientIdSecret Private

Position:	2
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ClientIdCertificate Public

Position:	2
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ClientIdCertificate Private

Position:	2
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

CommonParameters

此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。如需詳細資訊，請參閱 about_CommonParameters。

共用方式為

Add-SqlAzureAuthenticationContext

語法

DefaultAzureCredential Public

DefaultAzureCredential Private

Interactive Public

Interactive Private

ClientIdSecret Public

ClientIdSecret Private

ClientIdCertificate Public

ClientIdCertificate Private

Description

範例

範例 1：提示使用者輸入認證以向 Azure Resource Manager 驗證使用者

範例 2：向 Azure Resource Manager 驗證使用者

範例 3：使用 DefaultAzureCredential 向 Azure Resource Manager 驗證使用者

範例 4：使用 DefaultAzureCredential 但排除少數認證類型向 Azure Resource Manager 驗證使用者

參數

-ActiveDirectoryAuthority

參數屬性

參數集

-AzureKeyVaultResourceId

參數屬性

參數集

-AzureManagedHsmResourceId

參數屬性

參數集

-CertificateThumbprint

參數屬性

參數集

-ClientID

參數屬性

參數集

-DefaultAzureCredential

參數屬性

參數集

-ExcludeCredential

參數屬性

參數集

-Interactive

參數屬性

參數集

-Secret

參數屬性

參數集

-Tenant

參數屬性

參數集

CommonParameters

輸出

System.Object

相關連結

意見反應