< Back
Edit-SsisEnvironmentName
Post
NAME Edit-SsisEnvironmentName
SYNOPSIS
This executes the stored procedure "rename environment", effectively appending the current SSIS Project LSN to the
name.
SYNTAX
Edit-SsisEnvironmentName [-jsonPsCustomObject] <PSObject> [-sqlConnection] <SqlConnection> [[-ssisFolderName]
<String>] [[-ssisEnvironmentName] <String>] [-ssisProjectLsn] <String> [<CommonParameters>]
DESCRIPTION
Before we re-write the values stored in an environment, we can effectively take a back up of the current
environment by re-naming it.
We can used the return name to revert this back to the original name if we need to rollback if a validation has
failed
PARAMETERS
-jsonPsCustomObject <PSObject>
Tested json object loaded from Import-Json
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-sqlConnection <SqlConnection>
The SQL Connection to SSISDB
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ssisFolderName <String>
Optional parameter. We may wish to override the value of what is in the json file.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ssisEnvironmentName <String>
Optional parameter. We may wish to override the value of what is in the json file.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ssisProjectLsn <String>
Retrieved from ISC by using Get-SsisProjectLsn function.
Required? true
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$ssisEnvironmentRename = Edit-SsisEnvironmentName -ssisPublishFilePath $thisSsisPublishFilePath
-ssisProjectLsn $thisLsn -sqlConnection $ssisdb
RELATED LINKS
SYNOPSIS
This executes the stored procedure "rename environment", effectively appending the current SSIS Project LSN to the
name.
SYNTAX
Edit-SsisEnvironmentName [-jsonPsCustomObject] <PSObject> [-sqlConnection] <SqlConnection> [[-ssisFolderName]
<String>] [[-ssisEnvironmentName] <String>] [-ssisProjectLsn] <String> [<CommonParameters>]
DESCRIPTION
Before we re-write the values stored in an environment, we can effectively take a back up of the current
environment by re-naming it.
We can used the return name to revert this back to the original name if we need to rollback if a validation has
failed
PARAMETERS
-jsonPsCustomObject <PSObject>
Tested json object loaded from Import-Json
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-sqlConnection <SqlConnection>
The SQL Connection to SSISDB
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ssisFolderName <String>
Optional parameter. We may wish to override the value of what is in the json file.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ssisEnvironmentName <String>
Optional parameter. We may wish to override the value of what is in the json file.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ssisProjectLsn <String>
Retrieved from ISC by using Get-SsisProjectLsn function.
Required? true
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$ssisEnvironmentRename = Edit-SsisEnvironmentName -ssisPublishFilePath $thisSsisPublishFilePath
-ssisProjectLsn $thisLsn -sqlConnection $ssisdb
RELATED LINKS