Condividi tramite

Add-SqlAzureAuthenticationContext

  • Riferimento
Modulo:
SQLServer

Esegue l'autenticazione in Azure e acquisisce un token di autenticazione.

Sintassi

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

Descrizione

Il cmdlet Add-SqlAzureAuthenticationContext autentica l'account principale specificato in Azure Resource Manager. Usare questo cmdlet con altri cmdlet che interagiscono con le risorse di Azure, ad esempio Azure Key Vault.

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

Esempio

Esempio 1: Richiedere a un utente le credenziali per autenticare un utente in Azure Resource Manager

Add-SqlAzureAuthenticationContext -Interactive

Questo comando richiede un nome utente e una password e quindi autentica l'utente in Azure Resource Manager.

Esempio 2: Autenticare un utente in Azure Resource Manager

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

Questo comando esegue l'autenticazione dell'entità applicazione con l'ID client specificato, definito nel tenant specificato, in Azure Resource Manager.

Esempio 3: Usare DefaultAzureCredential per autenticare un utente in Azure Resource Manager

Add-SqlAzureAuthenticationContext -DefaultAzureCredential

Questo comando acquisisce il token usando i tipi di credenziali seguenti, se abilitati, verrà provato in ordine: EnvironmentCredential, WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, AzureDeveloperCliCredential, InteractiveBrowserCredential.

Esempio 4: Usare DefaultAzureCredential ma escludere alcuni tipi di credenziali per autenticare un utente in Azure Resource Manager

Add-SqlAzureAuthenticationContext -DefaultAzureCredential `
   -ExcludeCredentials EnvironmentCredential, AzureDeveloperCliCredential

Questo comando acquisisce il token usando i tipi di credenziali seguenti, se abilitati, verrà provato in ordine: WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, InteractiveBrowserCredential. Si noti che EnvironmentCredential, AzureDeveloperCliCredential sono esclusi dai tipi precedenti.

Parametri

-ActiveDirectoryAuthority

Specifica l'autorità di base per l'autenticazione di Azure Active Directory. Stesso valore della proprietà ActiveDirectoryAuthority dall'oggetto Azure PowerShell Environment.

Tipo:String
Posizione:1
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-AzureKeyVaultResourceId

Specifica l'ID risorsa per i servizi di Azure Key Vault. Stesso valore della proprietà AzureKeyVaultServiceEndpointResourceId dell'oggetto Ambiente Di Azure PowerShell.

Tipo:String
Posizione:2
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-AzureManagedHsmResourceId

Specifica l'ID risorsa per il servizio HSM gestito di Azure. Usare questo parametro per eseguire l'override del valore predefinito https://managedhsm.azure.net quando la risorsa HSM gestita si trova in un'istanza di Azure diversa dal cloud pubblico di Azure.

Tipo:String
Posizione:2
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-CertificateThumbprint

Specifica l'identificazione personale da utilizzare per identificare il certificato da usare. Il cmdlet cercherà sia CurrentUser che LocalMachine archivi certificati.

Tipo:String
Posizione:1
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-ClientID

Specifica l'ID client dell'applicazione.

Tipo:String
Posizione:0
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-DefaultAzureCredential

Indica che questo cmdlet usa DefaultAzureCredential per l'acquisizione del token. I tipi di credenziali seguenti, se abilitati, verranno provati in ordine:

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

Per altre informazioni su ogni tipo di credenziale, vedere DefaultAzureCredential Class.

Tipo:SwitchParameter
Posizione:0
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-ExcludeCredential

Indica che DefaultAzureCredential deve escludere l'elenco dei tipi di credenziali specificati durante l'acquisizione di un token.

Tipo:CredentialType[]
Valori accettati:EnvironmentCredential, WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, AzureDeveloperCliCredential, InteractiveBrowserCredential
Posizione:1
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Interactive

Indica che questo cmdlet richiede all'utente le credenziali.

Tipo:SwitchParameter
Posizione:0
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-ProgressAction

Determina in che modo PowerShell risponde agli aggiornamenti dello stato generati da uno script, un cmdlet o un provider, ad esempio le barre di stato generate dal cmdlet Write-Progress. Il cmdlet Write-Progress crea barre di stato che mostrano lo stato di un comando.

Tipo:ActionPreference
Alias:proga
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Secret

Specifica il segreto dell'applicazione.

Tipo:String
Posizione:1
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Tenant

Specifica un tenant in Azure.

Tipo:String
Posizione:2
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

Output

System.Object