Add-SqlAzureAuthenticationContext

  • Référence
Module:
SQLServer

Effectue l’authentification auprès d’Azure et acquiert un jeton d’authentification.

Syntaxe

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

L’applet de commande Add-SqlAzureAuthenticationContext authentifie le compte principal spécifié auprès d’Azure Resource Manager. Utilisez cette applet de commande avec d’autres applets de commande qui interagissent avec des ressources Azure, telles qu’Azure Key Vault.

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

Exemples

Exemple 1 : Inviter un utilisateur à entrer des informations d’identification pour authentifier un utilisateur auprès d’Azure Resource Manager

Add-SqlAzureAuthenticationContext -Interactive

Cette commande invite un utilisateur à entrer un nom d’utilisateur et un mot de passe, puis à authentifier l’utilisateur auprès d’Azure Resource Manager.

Exemple 2 : Authentifier un utilisateur auprès d’Azure Resource Manager

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

Cette commande effectue l’authentification du principal de l’application avec l’ID client spécifié, qui a été défini dans le locataire spécifié, à Azure Resource Manager.

Exemple 3 : Utiliser DefaultAzureCredential pour authentifier un utilisateur auprès d’Azure Resource Manager

Add-SqlAzureAuthenticationContext -DefaultAzureCredential

Cette commande acquiert le jeton à l’aide des types d’informations d’identification suivants, s’il est activé, dans l’ordre : EnvironmentCredential, WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, AzureDeveloperCliCredential, InteractiveBrowserCredential.

Exemple 4 : Utiliser DefaultAzureCredential, mais exclure quelques types d’informations d’identification pour authentifier un utilisateur auprès d’Azure Resource Manager

Add-SqlAzureAuthenticationContext -DefaultAzureCredential `
   -ExcludeCredentials EnvironmentCredential, AzureDeveloperCliCredential

Cette commande acquiert le jeton à l’aide des types d’informations d’identification suivants, s’il est activé, dans l’ordre suivant : WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, InteractiveBrowserCredential. Notez que EnvironmentCredential, AzureDeveloperCliCredential est exclu des types ci-dessus.

Paramètres

-ActiveDirectoryAuthority

Spécifie l’autorité de base pour l’authentification Azure Active Directory. Même valeur que la propriété ActiveDirectoryAuthority de l’objet Azure PowerShell Environment.

Type:String
Position:1
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-AzureKeyVaultResourceId

Spécifie l’ID de ressource pour les services Azure Key Vault. Même valeur que la propriété AzureKeyVaultServiceEndpointResourceId de l’objet Environnement Azure PowerShell.

Type:String
Position:2
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-AzureManagedHsmResourceId

Spécifie l’ID de ressource du service Azure Managed HSM. Utilisez ce paramètre pour remplacer la valeur par défaut https://managedhsm.azure.net lorsque votre ressource HSM managée se trouve dans une instance Azure autre que le cloud public Azure.

Type:String
Position:2
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-CertificateThumbprint

Spécifie l’empreinte numérique à utiliser pour identifier le certificat à utiliser. L’applet de commande recherche à la fois CurrentUser et LocalMachine magasins de certificats.

Type:String
Position:1
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ClientID

Spécifie l’ID client de l’application.

Type:String
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DefaultAzureCredential

Indique que cette applet de commande utilise DefaultAzureCredential pour acquérir un jeton. Les types d’informations d’identification suivants, s’ils sont activés, seront essayés, dans l’ordre :

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

Reportez-vous à classe DefaultAzureCredential pour plus d’informations sur chaque type d’informations d’identification.

Type:SwitchParameter
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ExcludeCredential

Indique que DefaultAzureCredential doit exclure la liste des types d’informations d’identification spécifiés lors de l’acquisition d’un jeton.

Type:CredentialType[]
Valeurs acceptées:EnvironmentCredential, WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, AzureDeveloperCliCredential, InteractiveBrowserCredential
Position:1
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Interactive

Indique que cette applet de commande invite l’utilisateur à entrer des informations d’identification.

Type:SwitchParameter
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ProgressAction

Détermine comment PowerShell répond aux mises à jour de progression générées par un script, une applet de commande ou un fournisseur, telles que les barres de progression générées par l’applet de commande Write-Progress. L’applet de commande Write-Progress crée des barres de progression qui affichent l’état d’une commande.

Type:ActionPreference
Alias:proga
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Secret

Spécifie le secret d’application.

Type:String
Position:1
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Tenant

Spécifie un locataire dans Azure.

Type:String
Position:2
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Sorties

System.Object