Partager via


Add-SqlLogin

Crée un objet Login dans une instance de SQL Server.

Syntaxe

ByPath (Par défaut)

Add-SqlLogin
    [[-Path] <String>]
    -LoginType <LoginType>
    [-LoginName <String>]
    [-DefaultDatabase <String>]
    [-EnforcePasswordPolicy]
    [-EnforcePasswordExpiration]
    [-MustChangePasswordAtNextLogin]
    [-Certificate <String>]
    [-AsymmetricKey <String>]
    [-CredentialName <String>]
    [-LoginPSCredential <PSCredential>]
    [-Enable]
    [-GrantConnectSql]
    [-Script]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [<CommonParameters>]

ByObject

Add-SqlLogin
    [[-InputObject] <Server>]
    -LoginType <LoginType>
    [-LoginName <String>]
    [-DefaultDatabase <String>]
    [-EnforcePasswordPolicy]
    [-EnforcePasswordExpiration]
    [-MustChangePasswordAtNextLogin]
    [-Certificate <String>]
    [-AsymmetricKey <String>]
    [-CredentialName <String>]
    [-LoginPSCredential <PSCredential>]
    [-Enable]
    [-GrantConnectSql]
    [-Script]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [<CommonParameters>]

ByName

Add-SqlLogin
    [[-ServerInstance] <String[]>]
    -LoginType <LoginType>
    [-LoginName <String>]
    [-DefaultDatabase <String>]
    [-EnforcePasswordPolicy]
    [-EnforcePasswordExpiration]
    [-MustChangePasswordAtNextLogin]
    [-Certificate <String>]
    [-AsymmetricKey <String>]
    [-CredentialName <String>]
    [-LoginPSCredential <PSCredential>]
    [-Enable]
    [-GrantConnectSql]
    [-Credential <PSCredential>]
    [-ConnectionTimeout <Int32>]
    [-Script]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [<CommonParameters>]

Description

L’applet de commande Add-SqlLogin crée un objet Login dans une instance de SQL Server.

Exemples

Exemple 1 : Créer un type SqlLogin

PS C:\> Add-SqlLogin -ServerInstance "MyServerInstance" -LoginName "MyLogin" -LoginType "SqlLogin" -DefaultDatabase "OtherDatabase"

Name                                          Login Type    Created
----                                          ----------    -------
MyLogin                                       SqlLogin      8/11/2016 3:19 PM

Cette commande crée un objet Login nommé « MyLogin » du type SqlLogin. La commande spécifie sa base de données par défaut comme « OtherDatabase » dans l’instance de serveur nommée « MyServerInstance ». Cette commande vous invite à entrer un mot de passe pour la connexion.

Exemple 2 : Créer un type de clé asymétrique

PS C:\> Add-SqlLogin -ServerInstance "MyServerInstance" -LoginName "MyLogin" -LoginType "AsymmetricKey" -AsymmetricKey "MyKey" -CredentialName "MyCredential"

Name                                          Login Type    Created
----                                          ----------    -------
MyLogin                                       AsymmetricKey 8/11/2016 4:08 PM

Cette commande crée un objet Login nommé MyLogin du type AsymmetricKey. Elle spécifie une clé asymétrique nommée MyKey. Il mappe également les informations d’identification appelées MyCredential au nouvel objet Login. La commande fonctionne dans l’instance de serveur nommée MyServerInstance.

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 DBSQL Azure Managed Instance un Service Principal ou un Managed Identity.

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

Ce paramètre est nouveau dans v22 du module.

Propriétés du paramètre

Type:PSObject
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-AsymmetricKey

Spécifiez le nom de la clé asymétrique pour l’objet Login. Si le paramètre LoginType a la valeur AsymmetricKey, spécifiez une clé asymétrique.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Certificate

Spécifiez le nom du certificat pour l’objet Login. Si LoginType a la valeur Certificate, spécifiez un certificat.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ConnectionTimeout

Spécifie le nombre de secondes à attendre pour une connexion serveur avant une défaillance de délai d’attente. La valeur de délai d’attente doit être un entier compris entre 0 et 65534. Si 0 est spécifié, les tentatives de connexion n’expirent pas.

Propriétés du paramètre

Type:Int32
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ByName
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Credential

Spécifie un objet PSCredential pour la connexion à SQL Server. Pour obtenir un objet d’informations d’identification, utilisez l’applet de commande Get-Credential. Pour plus d’informations, tapez Get-Help Obtenir des informations d’identification.

Propriétés du paramètre

Type:PSCredential
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ByName
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-CredentialName

Spécifiez le nom des informations d’identification de l’objet Login.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-DefaultDatabase

Spécifiez la base de données par défaut de l’objet Login. La valeur par défaut est master.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Enable

Indique que l’objet Login est activé. Par défaut, les objets Login sont désactivés.

Les objets de type WindowsGroup sont toujours activés. Ce paramètre ne les affecte pas.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Encrypt

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

Cette valeur est mappée à la Encrypt propriété SqlConnectionEncryptOption 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.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Valeurs acceptées:Mandatory, Optional, Strict
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-EnforcePasswordExpiration

Indique que la stratégie d’expiration du mot de passe est appliquée pour l’objet Login. Ce paramètre applique uniquement les objets de type SqlLogin. Ce paramètre implique le paramètre EnforcePasswordPolicy. Vous n’avez pas besoin de spécifier les deux.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-EnforcePasswordPolicy

Indique que la stratégie de mot de passe est appliquée pour l’objet Login. Ce paramètre applique uniquement les objets de type SqlLogin.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-GrantConnectSql

Indique que l’objet Login n’est pas autorisé à se connecter au moteur de base de données. Par défaut, les objets de connexion sont refusés pour se connecter au moteur de base de données, sauf si le serveur cible est SQL Azure.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-HostNameInCertificate

Nom d’hôte à utiliser pour valider le certificat SQL Server TLS/SSL. 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.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-InputObject

Spécifie un objet SMO (SQL Server Management Objects) sur lequel cette applet de commande fonctionne.

Propriétés du paramètre

Type:Server
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ByObject
Position:1
Obligatoire:False
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-LoginName

Spécifie un nom pour l’objet Login. La sensibilité de la casse est la même que celle de l’instance de SQL Server.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:Nom

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-LoginPSCredential

Spécifie un objet PSCredential qui permet à l’objet Login de fournir un nom et un mot de passe sans invite.

Propriétés du paramètre

Type:PSCredential
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-LoginType

Spécifie le type de l’objet Login en tant que valeur Microsoft.SqlServer.Management.Smo.LoginType. Les valeurs acceptables pour ce paramètre sont les suivantes :

  • AsymmetricKey
  • Certificat
  • SqlLogin
  • WindowsGroup
  • WindowsUser

À ce stade, l’applet de commande ne prend pas en charge ExternalUser ou ExternalGroup.

Propriétés du paramètre

Type:LoginType
Valeur par défaut:None
Valeurs acceptées:WindowsUser, WindowsGroup, SqlLogin, Certificate, AsymmetricKey, ExternalUser, ExternalGroup
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-MustChangePasswordAtNextLogin

Indique que l’utilisateur doit modifier le mot de passe lors de la connexion suivante. Ce paramètre applique uniquement les objets de type SqlLogin. Ce paramètre implique le paramètre EnforcePasswordExpiration. Vous n’avez pas besoin de spécifier les deux.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Path

Spécifie le chemin d’accès de SQL Server sur lequel cette applet de commande exécute l’opération. La valeur par défaut est le répertoire de travail actuel.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ByPath
Position:1
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ServerInstance

Spécifie le nom d’une instance de SQL Server. Pour l’instance par défaut, spécifiez le nom de l’ordinateur. Pour les instances nommées, utilisez le format ComputerName\InstanceName.

Propriétés du paramètre

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ByName
Position:1
Obligatoire:False
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

Microsoft.SqlServer.Management.Smo.Server

System.String[]

Sorties

System.Object