catalog.delete_environment_variable (SSISDB Database)

  • Article

Deletes an environment variable from an environment in the Integration Services catalog.

Syntax

delete_environment_variable [ @folder_name = ] folder_name
    , [ @environment_name = ] environment_name
    , [ @variable_name = ] variable_name

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 that contains the variable. The environment_name is nvarchar(128).

  • [ @variable\_name = ] variable_name
    The name of the variable that is to be deleted. The variable_name is nvarchar(128).

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

  • The environment variable does not exist