Set-SqlSmartAdmin

Module:

SqlServer Module

Configure ou modifie les paramètres de rétention et de stockage de sauvegarde.

Syntaxe

ByPath (Par défaut)

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

ByObject

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

Description

L’applet de commande Set-SqlSmartAdmin configure ou modifie les paramètres de paramètres BackupEnabled, BackupRetentionPeriodinDays, MasterSwitch et SqlCredential . Cette applet de commande peut être exécutée uniquement pour les configurations au niveau de l’instance et non pour une base de données spécifique.

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 chiffreur 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 DBSQL Azure Managed Instance un Service Principal ou un Managed Identity.

Le paramètre à utiliser peut être une chaîne représentant le jeton ou un PSAccessToken objet tel qu’il est retourné en exécutant Get-AzAccessToken -ResourceUrl https://database.windows.net.

Ce paramètre est nouveau dans v22 du module.

Propriétés du paramètre

Type:	PSObject
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-BackupEnabled

Indique que cette applet de commande active la sauvegarde managée SQL Server sur Windows Azure.

Propriétés du paramètre

Type:	Boolean
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	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.

Propriétés du paramètre

Type:	Int32
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Propriétés du paramètre

Type:	SwitchParameter
Valeur par défaut:	False
Prend en charge les caractères génériques:	False
DontShow:	False
Alias:	cf

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-DatabaseName

Spécifie le nom de la base de données que cette applet de commande modifie.

Propriétés du paramètre

Type:	String
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-Encrypt

Type de chiffrement à utiliser lors de la connexion à SQL Server.

Cette valeur est mappée à la Encrypt propriété SqlConnectionEncryptOption 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.

Propriétés du paramètre

Type:	String
Valeur par défaut:	None
Valeurs acceptées:	Mandatory, Optional, Strict
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-EncryptionOption

Spécifie les options de chiffrement.

Propriétés du paramètre

Type:	BackupEncryptionOptions
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-HostNameInCertificate

Nom d’hôte à utiliser pour valider le certificat SQL Server TLS/SSL. 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.

Propriétés du paramètre

Type:	String
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-InputObject

Spécifie l’objet Smo Smart Admin. Vous pouvez utiliser l’applet de commande Get-SqlSmartAdmin pour obtenir cet objet.

Propriétés du paramètre

Type:	SmartAdmin
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

ByObject

Position:	1
Obligatoire:	True
Valeur du pipeline:	True
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	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.

Propriétés du paramètre

Type:	Boolean
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	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.

Propriétés du paramètre

Type:	String
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

ByPath

Position:	1
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	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.

Propriétés du paramètre

Type:	SwitchParameter
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-SqlCredential

Spécifie l’objet SqlCredential utilisé pour s’authentifier auprès du compte de stockage Windows Azure.

Propriétés du paramètre

Type:	PSObject
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	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.

Propriétés du paramètre

Type:	SwitchParameter
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande ne s’exécute pas.

Propriétés du paramètre

Type:	SwitchParameter
Valeur par défaut:	False
Prend en charge les caractères génériques:	False
DontShow:	False
Alias:	Wi

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

Microsoft.SqlServer.Management.Smo.SmartAdmin

Liens associés

• Get-SqlSmartAdmin