Set-SqlCredential

  • Referenz
Modul:
SQLServer

Legt die Eigenschaften für das SQL Credential-Objekt fest.

Syntax

Set-SqlCredential
   [-Identity] <String>
   [[-Secret] <SecureString>]
   [[-Path] <String>]
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-SqlCredential
   [-Identity] <String>
   [[-Secret] <SecureString>]
   [-InputObject] <Credential>
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Beschreibung

Das Cmdlet Set-SqlCredential legt mithilfe dieses Cmdlets die Eigenschaften Identität und Kennwort für ein SQL Credential-Objekt fest. Dieses Cmdlet unterstützt die beiden folgenden Betriebsmodi:

  • Geben Sie den Pfad oder Speicherort der Anmeldeinformationen an, einschließlich des Anmeldeinformationsnamens, der den Path-Parameter verwendet.
  • Übergeben Sie ein Smo.Credential-Objekt an das Objekt, das den InputObject-Parameter verwendet.

Beispiele

Beispiel 1: Festlegen der Identität eines SQL-Anmeldeinformationsobjekts

PS C:\> Set-SqlCredential -Path SQLSERVER:\SQL\Computer\Instance\Credentials\MySqlCredential -Identity "MyStorageAccount"

Dieser Befehl legt die Identität von MySqlCredential auf fest, MyStorageAccount indem der Pfad der SQL-Anmeldeinformationen angegeben wird.

Beispiel 2: Festlegen der Identität eines SQL-Anmeldeinformationsobjekts mithilfe der Pipeline

PS C:\> $Cred = Get-SqlCredential -Name "MySqlCredential"
PS C:\> $Cred | Set-SqlCredential -Identity "MyStorageAccount"

Der erste Befehl ruft das Anmeldeinformationsobjekt aus dem Cmdlet Get-Credential ab und speichert das Ergebnis in der Variablen namens $Cred.

Beispiel 3: Festlegen der Identität eines SQL-Anmeldeinformationsobjekts, das den Benutzer auffordert

PS C:\> $Secret = Read-Host "Please enter the storage account access key"
PS C:\> Set-SqlCredential -Identity "MyStorageAccount" -Secret $Secret

Der erste Befehl fordert die Speicherzugriffsschlüsselinformationen ein und speichert das Ergebnis in der Variablen mit dem Namen $Secret.

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 von oder Service Principal 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.netvon zurückgegeben wird.

Dieser Parameter ist in v22 des Moduls neu.

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

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
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 Version 23 und höher des Moduls lautet der Standardwert "Obligatorisch", was zu einer Breaking Change für vorhandene Skripts führen kann.

Dieser Parameter ist in v22 des Moduls neu.

Type:String
Accepted values:Mandatory, Optional, Strict
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 einem instance mithilfe des Hostnamens/Kurznamens herstellen möchten. Wenn dieser Parameter ausgelassen wird, ist die Übergabe 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 in v22 des Moduls neu.

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

-Identity

Gibt den Benutzer- oder Kontonamen für die Ressource an, bei der SQL Server sich authentifizieren muss. Beim Windows Azure-Speicherdienst ist dies der Name des Windows Azure-Speicherkontos.

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

-InputObject

Gibt ein Eingabeanmeldeinformationsobjekt an. Verwenden Sie zum Abrufen dieses Objekts das Cmdlet Get-SqlCredential .

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

-Path

Gibt den Pfad zu den Anmeldeinformationen an, für die dieses Cmdlet diesen Vorgang ausführt. Beispielsweise SQLSERVER:\SQL\Computer\Instance\Credentials\Credential.

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

-Secret

Gibt das Kennwort für den Benutzer oder das Konto an. Für den Windows Azure-Speicherdienst ist dies der Zugriffsschlüsselwert für das Windows Azure-Speicherkonto.

Type:SecureString
Position:3
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TrustServerCertificate

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

In v22 des Moduls ist $true der Standardwert (aus Kompatibilität mit v21). In Version 23 und höher des Moduls lautet der Standardwert "$false", was zu einer Breaking Change für vorhandene Skripts führen kann.

Dieser Parameter ist in v22 des Moduls neu.

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

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

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

Eingaben

Microsoft.SqlServer.Management.Smo.Credential