managed_backup.sp_set_parameter (Transact-SQL)

适用于：SQL Server 2016 (13.x) 及更高版本

设置指定的智能管理系统参数的值。

可用参数与到 Microsoft Azure 的 SQL Server 托管备份相关。 这些参数用于设置电子邮件通知、启用特定的扩展事件以及启用基于用户设置的策略的管理策略。 必须指定参数名称和参数值对。

Transact-SQL 语法约定

语法

EXEC managed_backup.sp_set_parameter
    [ @parameter_name = ] {
        N'SSMBackup2WANotificationEmailIds'
        | N'SSMBackup2WAEnableUserDefinedPolicy'
        | N'SSMBackup2WADebugXevent'
        | N'FileRetentionDebugXevent'
        | N'StorageOperationDebugXevent'
    }
    , [ @parameter_value = ] N'parameter_value'
[ ; ]

参数

[ @parameter_name = ] N'parameter_name'

要设置值的参数的名称。 @parameter_name为 nvarchar（128）。 可用的参数名称包括：

• SSMBackup2WANotificationEmailIds
• SSMBackup2WADebugXevent
• SSMBackup2WAEnableUserDefinedPolicy
• FileRetentionDebugXevent
• StorageOperationDebugXevent。

[ @parameter_value = ] N'parameter_value'

要设置的参数的值。 @parameter_value为 nvarchar（128）。 下表显示了允许的参数名称和值对：

@parameter_name	@parameter_value
'SSMBackup2WANotificationEmailIds'	'email'
'SSMBackup2WAEnableUserDefinedPolicy'	{ 'true' |'false' }
'SSMBackup2WADebugXevent'	{ 'true' |'false' }
'FileRetentionDebugXevent'	{ 'true' |'false' }
“存储OperationDebugXevent” = { 'true' |'false' }	空值

返回代码值

0（成功）或 1（失败）。

权限

需要对存储过程具有 managed_backup.sp_set_parameter EXECUTE 权限。

示例

以下示例启用操作并调试扩展事件。

-- Enable operational events
USE msdb;
GO
EXEC managed_backup.sp_set_parameter N'FileRetentionOperationalXevent', N'True';

-- Enable debug events
USE msdb;
GO
EXEC managed_backup.sp_set_parameter N'FileRetentionDebugXevent', N'True';

以下示例启用错误和警告电子邮件通知，并设置用于发送通知的电子邮件地址：

USE msdb;
GO
EXEC managed_backup.sp_set_parameter @parameter_name = 'SSMBackup2WANotificationEmailIds', @parameter_value = '<email address>';