Set-SqlSmartAdmin
Configure ou modifie les paramètres de rétention et de stockage de sauvegarde.
Syntaxe
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>] Description
L’applet de commande
Cette applet de commande prend en charge les modes d’opération suivants pour retourner l’objet :
- Transmettez un objet Smo.Server au paramètre InputObject, directement ou via le pipeline.
- Passez le chemin d’accès de l’instance de SQL Server au paramètre Path
Exemples
Exemple 1 : Configurer les paramètres de rétention et de stockage de sauvegarde
PS C:\> $EncryptionOption = New-SqlBackupEncryptionOption -EncryptionAlgorithm Aes128 -EncryptorType ServerCertificate -EncryptorName "MyBackupCert"Cette commande configure la rétention de sauvegarde pour les paramètres de stockage qui utilisent le chiffrement nommé MyBackupCert et stocke le résultat dans la variable nommée $EncryptionOption.
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 DB et SQL Azure Managed Instance à l’aide d’un Service Principal ou d’un Managed Identity.
Le paramètre à utiliser peut être une chaîne représentant le jeton ou un objet PSAccessToken tel qu’il est retourné en exécutant Get-AzAccessToken -ResourceUrl https://database.windows.net.
Ce paramètre est nouveau dans v22 du module.
| Type: | PSObject |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-BackupEnabled
Indique que cette applet de commande active la sauvegarde managée SQL Server sur Windows Azure.
| Type: | Boolean |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-BackupRetentionPeriodInDays
Spécifie le nombre de jours pendant lesquels les fichiers de sauvegarde doivent être conservés. Cela détermine la durée de récupération des bases de données. Par exemple, si vous définissez la valeur pendant 30 jours, vous pouvez récupérer une base de données à un point dans le temps au cours des 30 derniers jours.
| Type: | Int32 |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-Confirm
Vous invite à confirmer avant d’exécuter l’applet de commande.
| Type: | SwitchParameter |
| Alias: | cf |
| Position: | Named |
| Valeur par défaut: | False |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-DatabaseName
Spécifie le nom de la base de données que cette applet de commande modifie.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-Encrypt
Type de chiffrement à utiliser lors de la connexion à SQL Server.
Cette valeur est mappée à la propriété EncryptSqlConnectionEncryptOption 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.
| Type: | String |
| Valeurs acceptées: | Mandatory, Optional, Strict |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-EncryptionOption
Spécifie les options de chiffrement.
| Type: | BackupEncryptionOptions |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-HostNameInCertificate
Nom d’hôte à utiliser pour valider le certificat TLS/SSL SQL Server. 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.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-InputObject
Spécifie l’objet Smo Smart Admin. Vous pouvez utiliser l’applet de commande Get-SqlSmartAdmin pour obtenir cet objet.
| Type: | SmartAdmin |
| Position: | 1 |
| Valeur par défaut: | None |
| Obligatoire: | True |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-MasterSwitch
Indique que cette applet de commande interrompt ou redémarre tous les services sous Administrateur intelligent, y compris la sauvegarde managée SQL Server sur Windows Azure.
| Type: | Boolean |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-Path
Spécifie le chemin d’accès à l’instance de SQL Server. Si vous ne spécifiez pas de valeur pour ce paramètre, l’applet de commande utilise le répertoire de travail actuel. Cela est utile lorsque vous créez des scripts pour gérer plusieurs instances.
| Type: | String |
| Position: | 1 |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-ProgressAction
Détermine comment PowerShell répond aux mises à jour de progression générées par un script, une applet de commande ou un fournisseur, telles que les barres de progression générées par l’applet de commande Write-Progress. L’applet de commande Write-Progress crée des barres de progression qui affichent l’état d’une commande.
| Type: | ActionPreference |
| Alias: | proga |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | 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.
| Type: | SwitchParameter |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-SqlCredential
Spécifie l’objet SqlCredential utilisé pour s’authentifier auprès du compte de stockage Windows Azure.
| Type: | PSObject |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | 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.
| Type: | SwitchParameter |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-WhatIf
Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande n’est pas exécutée.
| Type: | SwitchParameter |
| Alias: | wi |
| Position: | Named |
| Valeur par défaut: | False |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
Entrées
Microsoft.SqlServer.Management.Smo.SmartAdmin