managed_backup.sp_set_parameter (Transact-SQL)

  • [アーティクル]

適用対象: SQL Server 2016 (13.x) 以降のバージョン

指定した Smart 管理 システム パラメーターの値を設定します。

使用可能なパラメーターは、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
'SS MB (メガバイト)ackup2WANotificationEmailIds' 'email'
'SS MB (メガバイト)ackup2WAEnableUserDefinedPolicy' { 'true' |'false' }
'SS MB (メガバイト)ackup2WADebugXevent' { 'true' |'false' }
'FileRetentionDebugXevent' { 'true' |'false' }
'StorageOperationDebugXevent' = { 'true' |'false' } 該当なし

リターン コードの値

0 (成功) または 1 (失敗)。

アクセス許可

ストアド プロシージャに対する EXECUTE アクセス許可が managed_backup.sp_set_parameter 必要です。

例

次の例では、操作イベントとデバッグ拡張イベントを有効にします。

-- 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>';