New-SqlCredential

Module:

SQLServer

Crée un objet d’informations d’identification SQL Server.

Syntaxe

New-SqlCredential
   -Identity <String>
   [-Secret <SecureString>]
   [-ProviderName <String>]
   [-Name] <String>
   [[-Path] <String>]
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-SqlCredential
   -Identity <String>
   [-Secret <SecureString>]
   [-ProviderName <String>]
   [-Name] <String>
   [-InputObject] <Server>
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

L’applet de commande New-SqlCredential crée un objet d’informations d’identification SQL Server. Un objet d’informations d’identification SQL Server est utilisé pour stocker les informations d’authentification. Les informations d’identification SQL Server sont requises lors de la sauvegarde ou de la restauration à partir du service de stockage Windows Azure et sont utilisées pour stocker le nom du compte de stockage Windows Azure et les informations de clé d’accès.

Exemples

Exemple 1 : Créer des informations d’identification SQL pour l’instance actuelle de SQL Server

PS C:\> cd SQLServer:\SQL\Computer\Instance
PS SQLServer:\SQL\Computer\Instance> New-SqlCredential -Name "MySqlCredential" -Identity "MyWindowsAzureStorageAccount" -Secret "P4ssw0rd"

La première commande remplace le répertoire par SQLServer :\SQL\Computer\Instance.

Exemple 2 : Créer des informations d’identification SQL pour toutes les instances de SQL Server

PS C:\> cd SQLServer:\SQL\Computer\Instance
PS SQLServer:\SQL\Computer\Instance> $SecureString = ConvertTo-SecureString "[Placeholder]" -AsPlainText -Force
PS SQLServer:\SQL\Computer\Instance> $Instances = Get-ChildItem
PS SQLServer:\SQL\Computer\Instance> $Instances | New-SqlCredential -Name "MySqlCredential" -Identity "MyWindowsAzureStorageAccount" -Secret $SecureString

La première commande remplace le répertoire par SQLServer :\SQL\Computer\Instance.

La commande suivante utilise le pipeline pour transmettre les instances au New-SqlCredential pour créer des informations d’identification SQL nommées sur toutes les instances de SQL Server.

Paramètres

-AccessToken

Jeton d’accès utilisé pour s’authentifier auprès de SQL Server, comme alternative à l’authentification utilisateur/mot de passe ou Windows.

Cela peut être utilisé, par exemple, pour se connecter à SQL Azure DB et SQL Azure Managed Instance à l’aide d’un Service Principal ou d’un Managed Identity.

Le paramètre à utiliser peut être une chaîne représentant le jeton ou un objet PSAccessToken tel qu’il est retourné en exécutant Get-AzAccessToken -ResourceUrl https://database.windows.net.

Ce paramètre est nouveau dans v22 du module.

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

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

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

-Encrypt

Type de chiffrement à utiliser lors de la connexion à SQL Server.

Cette valeur est mappée à la propriété EncryptSqlConnectionEncryptOption sur l’objet SqlConnection du pilote Microsoft.Data.SqlClient.

Dans la version 22 du module, la valeur par défaut est Optional (pour la compatibilité avec v21). Dans la version 23+ du module, la valeur par défaut est « Obligatoire », ce qui peut créer une modification cassant pour les scripts existants.

Ce paramètre est nouveau dans v22 du module.

Type:	String
Valeurs acceptées:	Mandatory, Optional, Strict
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-HostNameInCertificate

Nom d’hôte à utiliser pour valider le certificat TLS/SSL SQL Server. Vous devez passer ce paramètre si votre instance SQL Server est activée pour Forcer le chiffrement et que vous souhaitez vous connecter à une instance à l’aide du nom d’hôte/shortname. Si ce paramètre est omis, le passage du nom de domaine complet (FQDN) à -ServerInstance est nécessaire pour se connecter à une instance SQL Server activée pour Forcer le chiffrement.

Ce paramètre est nouveau dans v22 du module.

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

-Identity

Spécifie le nom de l’utilisateur ou du compte. Pour l’authentification du service de stockage Windows Azure, il s’agit du nom du compte de stockage Windows Azure.

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

-InputObject

Spécifie l’objet Serveur dans lequel les informations d’identification doivent être créées.

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

-Name

Spécifie le nom des informations d’identification.

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

-Path

Spécifie le chemin d’accès de l’instance de SQL Server pour laquelle cette applet de commande exécute l’opération. Si vous ne spécifiez pas de valeur pour ce paramètre, l’applet de commande utilise l’emplacement de travail actuel.

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

-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

-ProviderName

Spécifie le nom du fournisseur de chiffrement pour le fournisseur de gestion des clés d’entreprise (EKM).

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

-Script

Indique que cette applet de commande retourne un script Transact-SQL qui effectue la tâche effectuée par cette applet de commande.

Type:	SwitchParameter
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 mot de passe de l’utilisateur ou du compte. Pour l’authentification du service de stockage Windows Azure, il s’agit de la valeur de clé d’accès du compte de stockage.

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

-TrustServerCertificate

Indique si le canal sera chiffré lors du contournement de la marche à pied de la chaîne de certificats pour valider l’approbation.

Dans la version 22 du module, la valeur par défaut est $true (pour la compatibilité avec v21). Dans v23+ du module, la valeur par défaut est « $false », ce qui peut créer une modification cassant pour les scripts existants.

Ce paramètre est nouveau dans v22 du module.

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

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande n’est pas exécutée.

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

Entrées

Microsoft.SqlServer.Management.Smo.Server

Liens associés

• Get-SqlCredential
• Remove-SqlCredential
• Set-SqlCredential