Set-SqlSmartAdmin

Konfiguriert oder ändert Sicherungsaufbewahrungs- und Speichereinstellungen.

Syntax

Set-SqlSmartAdmin
   [-SqlCredential <PSObject>]
   [-MasterSwitch <Boolean>]
   [-BackupEnabled <Boolean>]
   [-BackupRetentionPeriodInDays <Int32>]
   [-EncryptionOption <BackupEncryptionOptions>]
   [-DatabaseName <String>]
   [[-Path] <String>]
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-SqlSmartAdmin
   [-SqlCredential <PSObject>]
   [-MasterSwitch <Boolean>]
   [-BackupEnabled <Boolean>]
   [-BackupRetentionPeriodInDays <Int32>]
   [-EncryptionOption <BackupEncryptionOptions>]
   [-DatabaseName <String>]
   [-InputObject] <SmartAdmin>
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Beschreibung

Das Cmdlet Set-SqlSmartAdmin konfiguriert oder ändert die Parametereinstellungen BackupEnabled, BackupRetentionPeriodinDays, MasterSwitch und SqlCredential . Dieses Cmdlet kann nur für Konfigurationen auf instance Ebene und nicht für eine bestimmte Datenbank ausgeführt werden.

Dieses Cmdlet unterstützt die folgenden Vorgangsmodi für die Rückgabe des Objekts:

  • Übergeben Sie ein Smo.Server-Objekt direkt oder über die Pipeline an den InputObject-Parameter.
  • Übergeben Sie den Pfad des instance von SQL Server an den Path-Parameter.

Beispiele

Beispiel 1: Konfigurieren von Aufbewahrungs- und Speichereinstellungen für Sicherungen

PS C:\> $EncryptionOption = New-SqlBackupEncryptionOption -EncryptionAlgorithm Aes128 -EncryptorType ServerCertificate -EncryptorName "MyBackupCert"

Mit diesem Befehl wird die Sicherungsaufbewahrung für Speichereinstellungen konfiguriert, die den Verschlüsselungsgeber namens MyBackupCert verwendet und das Ergebnis in der Variablen mit dem Namen $EncryptionOptionspeichert.

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

-BackupEnabled

Gibt an, dass dieses Cmdlet SQL Server Verwaltete Sicherung in Windows Azure aktiviert.

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

-BackupRetentionPeriodInDays

Gibt die Anzahl der Tage an, die die Sicherungsdateien beibehalten werden sollen. Dadurch wird der Zeitraum für die Wiederherstellbarkeit der Datenbanken festgelegt. Wenn Sie für instance den Wert für 30 Tage festlegen, können Sie eine Datenbank auf einen Zeitpunkt in den letzten 30 Tagen wiederherstellen.

Type:Int32
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

-DatabaseName

Gibt den Namen der Datenbank an, die dieses Cmdlet ändert.

Type:String
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

-EncryptionOption

Gibt die Verschlüsselungsoptionen an.

Type:BackupEncryptionOptions
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 das Smo Smart Admin-Objekt an. Sie können das Cmdlet Get-SqlSmartAdmin verwenden, um dieses Objekt abzurufen.

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

-MasterSwitch

Gibt an, dass dieses Cmdlet alle Dienste unter Smart Admin anhält oder neu startet, einschließlich SQL Server verwalteten Sicherung in Windows Azure.

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

-Path

Gibt den Pfad zum instance von SQL Server an. Wenn Sie keinen Wert für diesen Parameter angeben, verwendet das Cmdlet das aktuelle Arbeitsverzeichnis. Dies ist nützlich, wenn Sie Skripts zum Verwalten mehrerer Instanzen erstellen.

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

-SqlCredential

Gibt das SqlCredential-Objekt an, das zur Authentifizierung beim Windows Azure-Speicherkonto verwendet wird.

Type:PSObject
Position:Named
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 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

-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.SmartAdmin