Edit

catalog.set_environment_variable_protection (SSISDB Database)

  • Article

Applies to: SQL Server SSIS Integration Runtime in Azure Data Factory

Applies to: SQL Server

Sets the sensitivity bit of an environment variable in the Integration Services catalog.

Syntax

catalog.set_environment_variable_protection [ @folder_name = ] folder_name  
    , [ @environment_name = ] environment_name  
    , [ @variable_name = ] variable_name  
    , [ @sensitive = ] sensitive

Arguments

[ @folder_name = ] folder_name
The name of the folder that contains the environment. The folder_name is nvarchar(128).

[ @environment_name = ] environment_name
The name of the environment. The environment_name is nvarchar(128).

[ @variable_name = ] variable_name
The name of the environment variable. The variable_name is nvarchar(128).

[ @sensitive = ] sensitive
Indicates whether the variable contains a sensitive value or not. Use a value of 1 to indicate that the value of the environment variable is sensitive or a value of 0 to indicate that it is not. A sensitive value is encrypted when it is stored. A value that is not sensitive is stored in plaintext. The sensitive parameter is bit.

Return Code Value

0 (success)

Result Sets

None

Permissions

This stored procedure requires one of the following permissions:

  • READ and MODIFY permissions on the environment

  • Membership to the ssis_admin database role

  • Membership to the sysadmin server role

Errors and Warnings

The following list describes some conditions that may raise an error or warning:

  • The folder name is not valid

  • The environment name is not valid

  • The environment variable name is not valid

  • The user does not have the appropriate permissions