Set-SqlSmartAdmin

Configura o modifica la retención de copia de seguridad y la configuración de almacenamiento.

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>]

Description

El cmdlet Set-SqlSmartAdmin configura o modifica la configuración del parámetro BackupEnabled, BackupRetentionPeriodinDays, MasterSwitch y SqlCredential . Este cmdlet solo se puede ejecutar para configuraciones de nivel de instancia y no para una base de datos específica.

Este cmdlet admite los siguientes modos de funcionamiento para devolver el objeto:

  • Pase un objeto Smo.Server al parámetro InputObject, ya sea directamente o a través de la canalización.
  • Pase la ruta de acceso de la instancia de SQL Server al parámetro Path.

Ejemplos

Ejemplo 1: Configuración de la retención de copia de seguridad y la configuración de almacenamiento

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

Este comando configura la retención de copia de seguridad para la configuración de almacenamiento que usa el cifrador denominado MyBackupCert y almacena el resultado en la variable denominada $EncryptionOption.

Parámetros

-AccessToken

Token de acceso que se usa para autenticarse en SQL Server, como alternativa a la autenticación de usuario o contraseña de Windows.

Esto se puede usar, por ejemplo, para conectarse a SQL Azure DB y SQL Azure Managed Instance usar o Service Principal .Managed Identity

El parámetro que se va a usar puede ser una cadena que representa el token o un PSAccessToken objeto tal y como se devuelve mediante la ejecución Get-AzAccessToken -ResourceUrl https://database.windows.netde .

Este parámetro es nuevo en la versión 22 del módulo.

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

-BackupEnabled

Indica que este cmdlet habilita SQL Server Copia de seguridad administrada en Windows Azure.

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

-BackupRetentionPeriodInDays

Especifica el número de días que se deben conservar los archivos de copia de seguridad. Este valor determina el margen de tiempo durante el cual se pueden recuperar las bases de datos. Por ejemplo, si establece el valor durante 30 días, puede recuperar una base de datos en un momento dado en los últimos 30 días.

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

-Confirm

Le solicita su confirmación antes de ejecutar el cmdlet.

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

-DatabaseName

Especifica el nombre de la base de datos que modifica este cmdlet.

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

-Encrypt

Tipo de cifrado que se va a usar al conectarse a SQL Server.

Este valor se asigna a la Encrypt propiedad SqlConnectionEncryptOption del objeto SqlConnection del controlador Microsoft.Data.SqlClient.

En la versión 22 del módulo, el valor predeterminado es Optional (por compatibilidad con v21). En la versión 23+ del módulo, el valor predeterminado será "Obligatorio", lo que puede crear un cambio importante para los scripts existentes.

Este parámetro es nuevo en la versión 22 del módulo.

Type:String
Accepted values:Mandatory, Optional, Strict
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EncryptionOption

Especifica las opciones de cifrado.

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

-HostNameInCertificate

Nombre de host que se va a usar al validar el certificado TLS/SSL de SQL Server. Debe pasar este parámetro si la instancia de SQL Server está habilitada para Forzar cifrado y desea conectarse a una instancia mediante el nombre de host o el nombre corto. Si se omite este parámetro, es necesario pasar el nombre de dominio completo (FQDN) a -ServerInstance para conectarse a una instancia de SQL Server habilitada para forzar el cifrado.

Este parámetro es nuevo en la versión 22 del módulo.

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

-InputObject

Especifica el objeto Smo Smart Administración. Puede usar el cmdlet Get-SqlSmartAdmin para obtener este objeto.

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

-MasterSwitch

Indica que este cmdlet pausa o reinicia todos los servicios en Smart Administración, incluida SQL Server Copia de seguridad administrada en Windows Azure.

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

-Path

Especifica la ruta de acceso a la instancia de SQL Server. Si no especifica un valor para este parámetro, el cmdlet usa el directorio de trabajo actual. Esto resulta útil al crear scripts para administrar varias instancias.

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

-Script

Indica que este cmdlet devuelve un script de Transact-SQL que realiza la tarea que realiza este cmdlet.

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

-SqlCredential

Especifica el objeto SqlCredential que se usa para autenticarse en la cuenta de almacenamiento de Windows Azure.

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

-TrustServerCertificate

Indica si el canal se cifrará al pasar la cadena de certificados para validar la confianza.

En la versión 22 del módulo, el valor predeterminado es $true (por compatibilidad con v21). En la versión 23 y posteriores del módulo, el valor predeterminado será "$false", lo que puede crear un cambio importante para los scripts existentes.

Este parámetro es nuevo en la versión 22 del módulo.

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

-WhatIf

Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.

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

Entradas

Microsoft.SqlServer.Management.Smo.SmartAdmin