Set-SqlSmartAdmin

配置或修改备份保留和存储设置。

语法

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

说明

Set-SqlSmartAdmin cmdlet 配置或修改 BackupEnabledBackupRetentionPeriodinDaysMasterSwitchSqlCredential 参数设置。 此 cmdlet 只能针对实例级别配置运行,而不能针对特定数据库运行。

此 cmdlet 支持以下操作模式来返回此对象:

  • 直接或通过管道将 Smo.Server 对象传递给 InputObject 参数。
  • 将 SQL Server 实例的路径传递给 Path 参数

示例

示例 1:配置备份保留和存储设置

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

此命令为使用名为 MyBackupCert 的加密器的存储设置配置备份保留期,并将结果存储在名为 的 $EncryptionOption变量中。

参数

-AccessToken

用于对SQL Server进行身份验证的访问令牌,作为用户/密码或 Windows 身份验证的替代方法。

例如,这可用于连接到 SQL Azure DB 和使用 SQL Azure Managed InstanceService PrincipalManaged Identity

要使用的参数可以是表示令牌的字符串,也可以是 PSAccessToken 运行 Get-AzAccessToken -ResourceUrl https://database.windows.net返回的对象。

此参数是模块 v22 中的新增参数。

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

-BackupEnabled

指示此 cmdlet 启用SQL Server托管备份到 Windows Azure。

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

-BackupRetentionPeriodInDays

指定备份文件应保留的天数。 这确定数据库的可恢复性的时间范围。 例如,如果将值设置为 30 天,则可以将数据库恢复到过去 30 天内的某个时间点。

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

-Confirm

提示你在运行 cmdlet 之前进行确认。

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

-DatabaseName

指定此 cmdlet 修改的数据库的名称。

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

-Encrypt

连接到SQL Server时使用的加密类型。

此值映射到 Encrypt Microsoft.Data.SqlClient 驱动程序的 SqlConnection 对象上的 属性 SqlConnectionEncryptOption

在模块的 v22 中,默认 Optional 为 (,以便与 v21) 兼容。 在模块的 v23+ 中,默认值为“必需”,这可能会为现有脚本创建中断性变更。

此参数是模块 v22 中的新增参数。

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

-EncryptionOption

指定加密选项。

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

-HostNameInCertificate

验证 SQL Server TLS/SSL 证书时要使用的主机名。 如果SQL Server实例启用了强制加密,并且你想要使用主机名/shortname 连接到实例,则必须传递此参数。 如果省略此参数,则必须将完全限定的域名 (FQDN) 传递给 -ServerInstance 才能连接到启用强制加密的SQL Server实例。

此参数是模块 v22 中的新增参数。

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

-InputObject

指定 Smo Smart 管理员 对象。 可以使用 Get-SqlSmartAdmin cmdlet 获取此对象。

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

-MasterSwitch

指示此 cmdlet 暂停或重启智能管理员下的所有服务,包括SQL Server托管备份到 Windows Azure。

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

-Path

指定 SQL Server 实例的路径。 如果未为此参数指定值,则 cmdlet 将使用当前工作目录。 这在创建脚本以管理多个实例时很有用。

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

-Script

指示此 cmdlet 返回执行此 cmdlet 执行的任务的 Transact-SQL 脚本。

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

-SqlCredential

指定用于向 Windows Azure 存储帐户进行身份验证的 SqlCredential 对象。

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

-TrustServerCertificate

指示是否在绕过证书链以验证信任时对通道进行加密。

在模块的 v22 中,默认 $true 为 (,以便与 v21) 兼容。 在模块的 v23+ 中,默认值为“$false”,这可能会为现有脚本创建中断性变更。

此参数是模块 v22 中的新增参数。

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

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 此 cmdlet 未运行。

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

输入

Microsoft.SqlServer.Management.Smo.SmartAdmin