managed_backup.sp_set_parameter (Transact-SQL)

Applies to: SQL Server 2016 (13.x) and later versions

Sets the value of the specified Smart Admin system parameter.

The available parameters are related to SQL Server Managed Backup to Microsoft Azure. These parameters are used to set the email notifications, enable specific extended events, and enable user set policy based management policies. You must specify the parameter name and the parameter value pairs.

Transact-SQL syntax conventions


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


[ @parameter_name = ] N'parameter_name'

The name of the parameter you want to set the value for. @parameter_name is nvarchar(128). The available parameter names are:

  • SSMBackup2WANotificationEmailIds
  • SSMBackup2WADebugXevent
  • SSMBackup2WAEnableUserDefinedPolicy
  • FileRetentionDebugXevent
  • StorageOperationDebugXevent.

[ @parameter_value = ] N'parameter_value'

The value for the parameter you want to set. @parameter_value is nvarchar(128). The following table shows allowed parameter name and value pairs:

@parameter_name @parameter_value
'SSMBackup2WANotificationEmailIds' 'email'
'SSMBackup2WAEnableUserDefinedPolicy' { 'true' | 'false' }
'SSMBackup2WADebugXevent' { 'true' | 'false' }
'FileRetentionDebugXevent' { 'true' | 'false' }
'StorageOperationDebugXevent' = { 'true' | 'false' } N/A

Return code values

0 (success) or 1 (failure).


Requires EXECUTE permissions on the managed_backup.sp_set_parameter stored procedure.


The following examples enable operational and debug extended events.

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

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

The following example enables email notifications of errors and warnings, and sets the email address for sending notifications:

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