Bagikan melalui

Add-SqlAzureAuthenticationContext

Modul:
SqlServer Module

Melakukan autentikasi ke Azure dan memperoleh token autentikasi.

Sintaks

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

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

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.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

DefaultAzureCredential Private
Position:1
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
Interactive Private
Position:1
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
ClientIdSecret Private
Position:1
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
ClientIdCertificate Private
Position:1
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-AzureKeyVaultResourceId

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

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

DefaultAzureCredential Private
Position:2
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
Interactive Private
Position:2
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
ClientIdSecret Private
Position:2
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
ClientIdCertificate Private
Position:2
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-AzureManagedHsmResourceId

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

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

DefaultAzureCredential Private
Position:2
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
Interactive Private
Position:2
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
ClientIdSecret Private
Position:2
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
ClientIdCertificate Private
Position:2
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-CertificateThumbprint

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

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

ClientIdCertificate Public
Position:1
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
ClientIdCertificate Private
Position:1
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-ClientID

Menentukan ID klien aplikasi.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

ClientIdSecret Public
Position:0
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
ClientIdSecret Private
Position:0
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
ClientIdCertificate Public
Position:0
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
ClientIdCertificate Private
Position:0
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa: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.

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

DefaultAzureCredential Public
Position:0
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
DefaultAzureCredential Private
Position:0
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-ExcludeCredential

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

Properti parameter

Jenis:

CredentialType[]

Nilai default:None
Nilai yang diterima:EnvironmentCredential, WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, AzureDeveloperCliCredential, InteractiveBrowserCredential
Mendukung wildcard:False
DontShow:False

Set parameter

DefaultAzureCredential Public
Position:1
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
DefaultAzureCredential Private
Position:1
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Interactive

Menunjukkan bahwa cmdlet ini meminta kredensial kepada pengguna.

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

Interactive Public
Position:0
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
Interactive Private
Position:0
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Secret

Menentukan rahasia aplikasi.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

ClientIdSecret Public
Position:1
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
ClientIdSecret Private
Position:1
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Tenant

Menentukan penyewa di Azure.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

ClientIdSecret Public
Position:2
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
ClientIdSecret Private
Position:2
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
ClientIdCertificate Public
Position:2
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
ClientIdCertificate Private
Position:2
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

CommonParameters

Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.

Output

System.Object