Bagikan melalui

Add-SqlAzureAuthenticationContext

  • Referensi
Modul:
SQLServer

Melakukan autentikasi ke Azure dan memperoleh token autentikasi.

Sintaks

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

Deskripsi

Cmdlet Add-SqlAzureAuthenticationContext mengautentikasi akun utama yang ditentukan ke Azure Resource Manager. Gunakan cmdlet ini dengan cmdlet lain yang berinteraksi dengan sumber daya Azure, seperti Azure Key Vault.

Module requirements: version 21+ on PowerShell 5.1; version 22+ on PowerShell 7.x.

Contoh

Contoh 1: Meminta kredensial kepada pengguna untuk mengautentikasi pengguna ke Azure Resource Manager

Add-SqlAzureAuthenticationContext -Interactive

Perintah ini meminta pengguna untuk nama pengguna dan kata sandi lalu mengautentikasi pengguna ke Azure Resource Manager.

Contoh 2: Mengautentikasi pengguna ke Azure Resource Manager

Add-SqlAzureAuthenticationContext -ClientID 'ad34ca5a-a479-4cf4-b166-a2177b32d33e' -Secret '[Placeholder]' -Tenant '41fb6cc6-96f4-479d-bafd-a2e4810eb100'

Perintah ini melakukan autentikasi perwakilan aplikasi dengan ID klien yang ditentukan, yang telah ditentukan dalam penyewa yang ditentukan, ke Azure Resource Manager.

Contoh 3: Gunakan DefaultAzureCredential untuk mengautentikasi pengguna ke Azure Resource Manager

Add-SqlAzureAuthenticationContext -DefaultAzureCredential

Perintah ini memperoleh token menggunakan jenis kredensial berikut, jika diaktifkan, akan dicoba, secara berurutan: EnvironmentCredential, WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, AzureDeveloperCliCredential, InteractiveBrowserCredential.

Contoh 4: Gunakan DefaultAzureCredential tetapi kecualikan beberapa jenis kredensial untuk mengautentikasi pengguna ke Azure Resource Manager

Add-SqlAzureAuthenticationContext -DefaultAzureCredential `
   -ExcludeCredentials EnvironmentCredential, AzureDeveloperCliCredential

Perintah ini memperoleh token menggunakan jenis kredensial berikut, jika diaktifkan, akan dicoba, dalam urutan: WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, InteractiveBrowserCredential. PERHATIKAN bahwa EnvironmentCredential, AzureDeveloperCliCredential dikecualikan dari jenis di atas.

Parameter

-ActiveDirectoryAuthority

Menentukan otoritas dasar untuk autentikasi Azure Active Directory. Nilai yang sama dengan properti ActiveDirectoryAuthority dari objek Lingkungan Azure PowerShell.

Jenis:String
Position:1
Nilai default:None
Diperlukan:True
Terima input alur:False
Terima karakter wildcard:False

-AzureKeyVaultResourceId

Menentukan ID sumber daya untuk layanan Azure Key Vault. Nilai yang sama dengan properti AzureKeyVaultServiceEndpointResourceId dari objek Lingkungan Azure PowerShell.

Jenis:String
Position:2
Nilai default:None
Diperlukan:True
Terima input alur:False
Terima karakter wildcard:False

-AzureManagedHsmResourceId

Menentukan ID sumber daya untuk layanan Azure Managed HSM. Gunakan parameter ini untuk mengambil alih nilai default https://managedhsm.azure.net saat sumber daya HSM terkelola Anda berada dalam instans Azure selain cloud publik Azure.

Jenis:String
Position:2
Nilai default:None
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-CertificateThumbprint

Menentukan thumbprint yang akan digunakan untuk mengidentifikasi sertifikat yang akan digunakan. Cmdlet akan mencari penyimpanan sertifikat CurrentUser dan LocalMachine.

Jenis:String
Position:1
Nilai default:None
Diperlukan:True
Terima input alur:False
Terima karakter wildcard:False

-ClientID

Menentukan ID klien aplikasi.

Jenis:String
Position:0
Nilai default:None
Diperlukan:True
Terima input alur:False
Terima karakter wildcard:False

-DefaultAzureCredential

Menunjukkan bahwa cmdlet ini menggunakan DefaultAzureCredential untuk memperoleh token. Jenis kredensial berikut, jika diaktifkan, akan dicoba, secara berurutan:

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

Lihat Kelas DefaultAzureCredential untuk informasi selengkapnya tentang setiap jenis kredensial.

Jenis:SwitchParameter
Position:0
Nilai default:None
Diperlukan:True
Terima input alur:False
Terima karakter wildcard:False

-ExcludeCredential

Menunjukkan bahwa DefaultAzureCredential harus mengecualikan daftar jenis kredensial yang ditentukan saat memperoleh token.

Jenis:CredentialType[]
Nilai yang diterima:EnvironmentCredential, WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, AzureDeveloperCliCredential, InteractiveBrowserCredential
Position:1
Nilai default:None
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-Interactive

Menunjukkan bahwa cmdlet ini meminta kredensial kepada pengguna.

Jenis:SwitchParameter
Position:0
Nilai default:None
Diperlukan:True
Terima input alur:False
Terima karakter wildcard:False

-ProgressAction

Menentukan bagaimana PowerShell merespons pembaruan kemajuan yang dihasilkan oleh skrip, cmdlet, atau penyedia, seperti bilah kemajuan yang dihasilkan oleh cmdlet Write-Progress. cmdlet Write-Progress membuat bilah kemajuan yang memperlihatkan status perintah.

Jenis:ActionPreference
Alias:proga
Position:Named
Nilai default:None
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-Secret

Menentukan rahasia aplikasi.

Jenis:String
Position:1
Nilai default:None
Diperlukan:True
Terima input alur:False
Terima karakter wildcard:False

-Tenant

Menentukan penyewa di Azure.

Jenis:String
Position:2
Nilai default:None
Diperlukan:True
Terima input alur:False
Terima karakter wildcard:False

Output

System.Object