managed_backup.fn_get_parameter (Transact-SQL)

THIS TOPIC APPLIES TO: yesSQL Server (starting with 2016)noAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

Returns a table of 0, 1, or more rows of parameter and value pairs.

Use this stored procedure to review all or a specific configuration settings for Smart Admin.

If the parameter has never been configured, the function returns 0 rows.

Topic link icon Transact-SQL Syntax Conventions

Syntax

managed_backup.fn_get_parameter ('parameter_name' | '' | NULL )  

Arguments

parameter_name
Name of the parameter. parameter_name is NVARCHAR(128). If NULL or an empty string is supplied as an argument to the function, name-values pairs for all configured Smart Admin parameters are returned.

Table Returned

Column Name Data Type Description
parameter_name NVARCHAR(128) Name of the parameter. The following is a current list of parameters returned:

FileRetentionDebugXevent

SSMBackup2WADebugXevent

SSMBackup2WANotificationEmailIds

SSMBackup2WAEnableUserDefinedPolicy

SSMBackup2WAEverConfigured

StorageOperationDebugXevent
parameter_value NVARCHAR(128) Current set value of the parameter.

Security

Permissions

Requires SELECT permissions on the function.

Examples

The following example returns all the parameters which have been configured at least once, and their current values.

USE MSDB  
GO  
SELECT *   
FROM managed_backup.fn_get_parameter (NULL)  

The following example returns the email ID specified to receive the error notifications. If no rows are returns, then it means that this email notification option has not been enabled.

USE MSDB  
GO  
SELECT *  
FROM managed_backup.fn_get_parameter ('SSMBackup2WANotficationEmailIds')  

See Also

SQL Server Managed Backup to Microsoft Azure