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>]
[-ProgressAction <ActionPreference>]
[-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>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Beschreibung
Das cmdlet Set-SqlSmartAdmin konfiguriert oder ändert die BackupEnabled, BackupRetentionPeriodinDays, MasterSwitchund SqlCredential Parametereinstellungen. Dieses Cmdlet kann nur für Konfigurationen auf Instanzebene und nicht für eine bestimmte Datenbank ausgeführt werden.
Dieses Cmdlet unterstützt die folgenden Vorgangsmodi, um das Objekt zurückzugeben:
- Übergeben Sie ein Smo.Server-Objekt an den InputObject-Parameter, entweder direkt oder über die Pipeline.
- Übergeben Des Pfads der Instanz von SQL Server an den Path-Parameter
Beispiele
Beispiel 1: Konfigurieren von Sicherungsaufbewahrungs- und Speichereinstellungen
PS C:\> $EncryptionOption = New-SqlBackupEncryptionOption -EncryptionAlgorithm Aes128 -EncryptorType ServerCertificate -EncryptorName "MyBackupCert"
Mit diesem Befehl wird die Sicherungsaufbewahrung für Speichereinstellungen konfiguriert, die den Verschlüsselnder namens MyBackupCert
verwenden, und speichert das Ergebnis in der Variablen mit dem Namen $EncryptionOption
.
Parameter
-AccessToken
Das Zugriffstoken, das zur Authentifizierung bei SQL Server verwendet wird, als Alternative zur Benutzer-/Kennwort- oder Windows-Authentifizierung.
Dies kann z. B. zum Herstellen einer Verbindung mit SQL Azure DB
und SQL Azure Managed Instance
mithilfe eines Service Principal
oder einer Managed Identity
verwendet werden.
Der zu verwendende Parameter kann entweder eine Zeichenfolge sein, die das Token darstellt, oder ein PSAccessToken
-Objekt, wie durch Ausführen von Get-AzAccessToken -ResourceUrl https://database.windows.net
zurückgegeben wird.
Dieser Parameter ist neu in v22 des Moduls.
Typ: | PSObject |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-BackupEnabled
Gibt an, dass dieses Cmdlet SQL Server Managed Backup für Windows Azure aktiviert.
Typ: | Boolean |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-BackupRetentionPeriodInDays
Gibt die Anzahl der Tage an, die die Sicherungsdateien aufbewahrt werden sollen. Dadurch wird der Zeitrahmen der Wiederherstellbarkeit für die Datenbanken bestimmt. Wenn Sie beispielsweise den Wert für 30 Tage festlegen, können Sie eine Datenbank in den letzten 30 Tagen zu einem Bestimmten Zeitpunkt wiederherstellen.
Typ: | Int32 |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-Confirm
Fordert Sie vor dem Ausführen des Cmdlets zur Bestätigung auf.
Typ: | SwitchParameter |
Aliase: | cf |
Position: | Named |
Standardwert: | False |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-DatabaseName
Gibt den Namen der Datenbank an, die dieses Cmdlet ändert.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-Encrypt
Der Verschlüsselungstyp, der beim Herstellen einer Verbindung mit SQL Server verwendet werden soll.
Dieser Wert ist der Encrypt
Eigenschaft SqlConnectionEncryptOption
für das SqlConnection-Objekt des Microsoft.Data.SqlClient-Treibers zugeordnet.
In v22 des Moduls ist die Standardeinstellung Optional
(aus Kompatibilität mit v21). In v23+ des Moduls lautet der Standardwert "Verpflichtend", wodurch für vorhandene Skripts eine bahnbrechende Änderung erstellt werden kann.
Dieser Parameter ist neu in v22 des Moduls.
Typ: | String |
Zulässige Werte: | Mandatory, Optional, Strict |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-EncryptionOption
Gibt die Verschlüsselungsoptionen an.
Typ: | BackupEncryptionOptions |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-HostNameInCertificate
Der Hostname, der beim Überprüfen des SQL Server TLS/SSL-Zertifikats verwendet werden soll. Sie müssen diesen Parameter übergeben, wenn Ihre SQL Server-Instanz für die Erzwingungsverschlüsselung aktiviert ist und Sie eine Verbindung mit einer Instanz mit 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 einer SQL Server-Instanz herzustellen, die für die Erzwingungsverschlüsselung aktiviert ist.
Dieser Parameter ist neu in v22 des Moduls.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-InputObject
Gibt das Smo Smart Admin -Objekt an. Sie können das cmdlet Get-SqlSmartAdmin verwenden, um dieses Objekt abzurufen.
Typ: | SmartAdmin |
Position: | 1 |
Standardwert: | None |
Erforderlich: | True |
Pipelineeingabe akzeptieren: | True |
Platzhalterzeichen akzeptieren: | False |
-MasterSwitch
Gibt an, dass dieses Cmdlet alle Dienste unter Smart Admin angehalten oder neu startet, einschließlich SQL Server Managed Backup in Windows Azure.
Typ: | Boolean |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-Path
Gibt den Pfad zur Instanz 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.
Typ: | String |
Position: | 1 |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-ProgressAction
Bestimmt, wie PowerShell auf Statusaktualisierungen reagiert, die von einem Skript, Cmdlet oder Anbieter generiert werden, z. B. auf die Statusanzeigen, die vom Cmdlet Write-Progress generiert werden. Das Cmdlet Write-Progress erstellt Statusanzeigen, die den Status eines Befehls anzeigen.
Typ: | ActionPreference |
Aliase: | proga |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-Script
Gibt an, dass dieses Cmdlet ein Transact-SQL Skript zurückgibt, das die aufgabe ausführt, die dieses Cmdlet ausführt.
Typ: | SwitchParameter |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-SqlCredential
Gibt das SqlCredential--Objekt an, das für die Authentifizierung beim Windows Azure-Speicherkonto verwendet wird.
Typ: | PSObject |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-TrustServerCertificate
Gibt an, ob der Kanal verschlüsselt wird, während die Zertifikatkette umgangen wird, um die Vertrauensstellung zu überprüfen.
In v22 des Moduls ist die Standardeinstellung $true
(aus Kompatibilität mit v21). In v23+ des Moduls lautet der Standardwert "$false", wodurch möglicherweise eine änderung für vorhandene Skripts geändert wird.
Dieser Parameter ist neu in v22 des Moduls.
Typ: | SwitchParameter |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-WhatIf
Zeigt, was passiert, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.
Typ: | SwitchParameter |
Aliase: | wi |
Position: | Named |
Standardwert: | False |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
Eingaben
Microsoft.SqlServer.Management.Smo.SmartAdmin