Export (0) Print
Expand All

smart_admin.sp_set_parameter (Transact-SQL)

Sets the value of the specified Smart Admin system parameter.

The available parameters are related to SQL Server Managed Backup to Windows 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..

Applies to: SQL Server (SQL Server 2014 through current version).

Topic link icon Transact-SQL Syntax Conventions

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


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, and StorageOperationDebugXevent.


The value for the parameter you want to set. @parameter value is NVARCHAR(128). Following are the allowed parameter name and value pairs:

  • @parameter_name = 'SSMBackup2WANotificationEmailIds' : @parameter_value = 'email'

  • @parameter_name = 'SSMBackup2WAEnableUserDefinedPolicy' : @parameter_value = { 'true' | 'false' }

  • @parameter_name = 'SSMBackup2WADebugXevent': @parameter_value = { 'true' | 'false' }

  • @parameter_name = 'FileRetentionDebugXevent' : @parameter_value = { 'true' | 'false' }

  • @parameter_name = 'StorageOperationDebugXevent' = { 'true' | 'false' }

0 (success) or 1 (failure)

Optional section that describes best practices the user should know when executing the statement or routine.


Requires EXECUTE permissions on smart_admin.sp_set_parameter stored procedure.

The following examples enable operational and debug extended events.

-- to enable operational events
Use msdb;
         EXEC smart_admin.sp_set_parameter 'FileRetentionOperationalXevent', 'True'
--  to enable debug events
Use msdb;
         EXEC smart_admin.sp_set_parameter 'FileRetentionDebugXevent', 'True'

The following example enables email notifications of errors and warnings and sets the emailID to use to send the notifications to:

Use msdb
EXEC smart_admin.sp_set_parameter @parameter_name = 'SSMBackup2WANotificationEmailIds', @parameter_value = '<email address>'

Community Additions

© 2015 Microsoft