catalog.set_environment_variable_property (SSISDB Database)

  • Article

Sets the property of an environment variable in the Integration Services catalog.

Syntax

set_environment_variable_property [ @folder_name = ] folder_name
    , [ @environment_name = ] environment_name
    , [ @variable_name = ] variable_name
    , [ @property_name = ] property_name
    , [ @property_value = ] property_value

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).

  • [ @property\_name = ] property_name
    The name of the environment variable property. The property_name is nvarchar(128).

  • [ @property\_value = ] property_value
    The value of the environment variable property. The property_value is nvarchar(4000).

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 environment variable property name is not valid

  • The user does not have the appropriate permissions

Remarks

In this release, only the Description property can be set. The property value for the Description property cannot exceed 4000 characters.