Add-SqlLogin

  • Referenz
Modul:
SQLServer

Erstellt ein Login-Objekt in einer instance von SQL Server.

Syntax

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

Beschreibung

Das Cmdlet Add-SqlLogin erstellt ein Login-Objekt in einer instance SQL Server.

Beispiele

Beispiel 1: Erstellen eines SqlLogin-Typs

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

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

Mit diesem Befehl wird ein Login-Objekt mit dem Namen "MyLogin" vom Typ SqlLogin erstellt. Der Befehl gibt die Standarddatenbank als "OtherDatabase" auf dem Server instance mit dem Namen "MyServerInstance" an. Dieser Befehl fordert Sie zur Eingabe eines Kennworts für die Anmeldung auf.

Beispiel 2: Erstellen eines asymmetrischen Schlüsseltyps

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

Mit diesem Befehl wird ein Login-Objekt mit dem Namen MyLogin vom Typ AsymmetricKey erstellt. Es gibt einen asymmetrischen Schlüssel mit dem Namen MyKey an. Außerdem werden die Anmeldeinformationen namens MyCredential dem neuen Login-Objekt zugeordnet. Der Befehl wird auf dem Server instance namens MyServerInstance ausgeführt.

Parameter

-AccessToken

Das Zugriffstoken, das zur Authentifizierung bei SQL Server verwendet wird, als Alternative zur Benutzer-/Kennwort- oder Windows-Authentifizierung.

Dies kann z. B. verwendet werden, um eine Verbindung mit SQL Azure DB und SQL Azure Managed Instance mithilfe Service Principal von herzustellen Managed Identity.

Der zu verwendende Parameter kann entweder eine Zeichenfolge sein, die das Token darstellt, oder ein PSAccessToken Objekt, das durch ausführen Get-AzAccessToken -ResourceUrl https://database.windows.netzurückgegeben wird.

Dieser Parameter ist neu in v22 des Moduls.

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AsymmetricKey

Geben Sie den Namen des asymmetrischen Schlüssels für das Login-Objekt an. Wenn der LoginType-Parameter den Wert AsymmetricKey aufweist, geben Sie einen asymmetrischen Schlüssel an.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Certificate

Geben Sie den Namen des Zertifikats für das Login-Objekt an. Wenn LoginType über den Wert Certificate verfügt, geben Sie ein Zertifikat an.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConnectionTimeout

Gibt die Anzahl der Sekunden an, die vor einem Timeoutfehler auf eine Serververbindung gewartet werden müssen. Der Timeoutwert muss einer ganzen Zahl zwischen 0 und 65.534 entsprechen. Wenn 0 angegeben wird, verursachen Verbindungsversuche kein Timeout.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Gibt ein PSCredential-Objekt für die Verbindung mit SQL Server an. Verwenden Sie zum Abrufen eines Anmeldeinformationsobjekts das Cmdlet Get-Credential. Weitere Informationen erhalten Sie, indem Sie Get-Help Get-Credential eingeben.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CredentialName

Geben Sie den Namen der Anmeldeinformationen für das Login-Objekt an.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultDatabase

Geben Sie die Standarddatenbank für das Login-Objekt an. Der Standardwert ist master.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Enable

Gibt an, dass das Login-Objekt aktiviert ist. Anmeldeobjekte sind standardmäßig deaktiviert.

Objekte vom Typ WindowsGroup sind immer aktiviert. Dieser Parameter wirkt sich nicht auf sie aus.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Encrypt

Der Verschlüsselungstyp, der beim Herstellen einer Verbindung mit SQL Server verwendet werden soll.

Dieser Wert wird der Encrypt Eigenschaft SqlConnectionEncryptOption des SqlConnection-Objekts des Microsoft.Data.SqlClient-Treibers zugeordnet.

In v22 des Moduls ist Optional der Standardwert (aus Kompatibilität mit v21). In v23+ des Moduls lautet der Standardwert "Obligatorisch", wodurch möglicherweise eine Breaking Change für vorhandene Skripts entsteht.

Dieser Parameter ist neu in v22 des Moduls.

Type:String
Accepted values:Mandatory, Optional, Strict
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnforcePasswordExpiration

Gibt an, dass die Kennwortablaufrichtlinie für das Login-Objekt erzwungen wird. Dieser Parameter wendet nur Objekte vom Typ SqlLogin an. Dieser Parameter impliziert den EnforcePasswordPolicy-Parameter. Sie müssen nicht beide angeben.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnforcePasswordPolicy

Gibt an, dass die Kennwortrichtlinie für das Login-Objekt erzwungen wird. Dieser Parameter wendet nur Objekte vom Typ SqlLogin an.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GrantConnectSql

Gibt an, dass dem Login-Objekt keine Berechtigungen zum Herstellen einer Verbindung mit der Datenbank-Engine verweigert werden. Anmeldeobjekten werden standardmäßig Berechtigungen zum Herstellen einer Verbindung mit der Datenbank-Engine verweigert.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HostNameInCertificate

Der Hostname, der beim Überprüfen des TLS/SSL-Zertifikats von SQL Server verwendet werden soll. Sie müssen diesen Parameter übergeben, wenn Ihr SQL Server instance für Verschlüsselung erzwingen aktiviert ist und Sie eine Verbindung mit einer instance mithilfe von hostname/shortname herstellen möchten. Wenn dieser Parameter nicht angegeben wird, ist das Übergeben des vollqualifizierten Domänennamens (Fully Qualified Domain Name, FQDN) an -ServerInstance erforderlich, um eine Verbindung mit einem für Die Verschlüsselung erzwingen aktivierten SQL Server instance herzustellen.

Dieser Parameter ist neu in v22 des Moduls.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Gibt ein SQL Server Management Objects (SMO)-Objekt an, das das SQL Server, für das dieses Cmdlet verwendet wird.

Type:Server
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-LoginName

Gibt einen Namen für das Login-Objekt an. Die Groß-/Kleinschreibung ist identisch mit der instance von SQL Server.

Type:String
Aliases:Name
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LoginPSCredential

Gibt ein PSCredential-Objekt an, mit dem das Login-Objekt Namen und Kennwort ohne Aufforderung angeben kann.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LoginType

Gibt den Typ des Login-Objekts als Microsoft.SqlServer.Management.Smo.LoginType-Wert an. Zulässige Werte für diesen Parameter:

  • AsymmetricKey
  • Zertifikat
  • SqlLogin
  • WindowsGroup
  • WindowsUser

Derzeit unterstützt das Cmdlet Weder ExternalUser noch ExternalGroup.

Type:LoginType
Accepted values:WindowsUser, WindowsGroup, SqlLogin, Certificate, AsymmetricKey, ExternalUser, ExternalGroup
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-MustChangePasswordAtNextLogin

Gibt an, dass der Benutzer das Kennwort bei der nächsten Anmeldung ändern muss. Dieser Parameter wendet nur Objekte vom Typ SqlLogin an. Dieser Parameter impliziert den EnforcePasswordExpiration-Parameter. Sie müssen nicht beide angeben.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

Gibt den Pfad des SQL Server an, auf dem dieses Cmdlet den Vorgang ausführt. Der Standardwert ist das aktuelle Arbeitsverzeichnis.

Type:String
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Script

Gibt an, dass dieses Cmdlet ein Transact-SQL-Skript zurückgibt, das die Aufgabe ausführt, die dieses Cmdlet ausführt.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServerInstance

Gibt den Namen einer instance von SQL Server an. Geben Sie für die Standard-instance den Computernamen an. Verwenden Sie für benannte Instanzen das Format ComputerName\Instanzname.

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-TrustServerCertificate

Gibt an, ob der Kanal verschlüsselt wird, während das Durchlaufen der Zertifikatkette zur Überprüfung der Vertrauensstellung umgangen wird.

In v22 des Moduls ist $true der Standardwert (aus Kompatibilität mit v21). In v23+ des Moduls lautet der Standardwert "$false", wodurch möglicherweise eine Breaking Change für vorhandene Skripts entsteht.

Dieser Parameter ist neu in v22 des Moduls.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Eingaben

Microsoft.SqlServer.Management.Smo.Server

System.String[]

Ausgaben

System.Object