createDeployerConfiguration
Adds deployer configuration to the deployer application or deployer service.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
releaseName | String | The name of the release |
serviceName | String | The name of the service |
actualParameters | actualParameter array | Actual parameters |
applicationName | String | The name of the application |
applicationProjectName | String | The name of the project containing specified application. If not specified, it is defaulted to the release project name. |
deployerConfigurationName | String | The name of deployer configuration. If not specified, a system generated guid is used. |
deployerTaskName | String | The name of the deployer task defined in the provided stage. |
environmentName | String | The name of the environment. |
environmentProjectName | String | The name of the project containing specified environment or environment template. If not specified, it is defaulted to the release project name. |
environmentTemplateName | String | The name of the environment template. |
environmentTemplateProjectName | String | The name of the project containing specified environment template. If not specified, it is defaulted to the environment project name. |
insertRollingDeployManualStep | Boolean | True to indicate a manual step needs to be injected after each phase or batch. |
processName | String | The name of the application or service process. |
rollingDeployEnabled | Boolean | Perform rolling deployment. |
rollingDeployManualStepAssignees | String array | A list of assignees who receive the notification when rolling deploy iteration completes. |
rollingDeployManualStepCondition | String | Defines run condition on manual step created during rolling deployment. |
rollingDeployPhases | String array | One or more rolling deploy phases to be used for deployment. |
serviceProjectName | String | The name of the project containing specified service. If not specified, it is defaulted to the release project name. |
skipDeploy | Boolean | True to skip deployment to an environment |
snapshotName | String | The name of the snapshot |
stageName | String | The name of the stage of a pipeline attached to a release if specified. |
getDeployerConfiguration
Get a deployer configuration
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
releaseName | String | The name of the release |
stageName | String | The name of the stage of a pipeline attached to a release if specified. |
serviceName | String | The name of the service |
applicationName | String | The name of the application |
applicationProjectName | String | The name of the project containing specified application. If not specified, it is defaulted to the release project name. |
deployerConfigurationName | String | The name of deployer configuration. If not specified, a system generated guid is used. |
deployerTaskName | String | The name of the deployer task defined in the provided stage. |
serviceProjectName | String | The name of the project containing specified service. If not specified, it is defaulted to the release project name. |
getDeployerConfigurations
Gets all the configurations in the deployer
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
releaseName | String | The name of the release |
stageName | String | The name of the stage of a pipeline attached to a release if specified. |
applicationName | String | The name of the application |
applicationProjectName | String | The name of the project containing specified application. If not specified, it is defaulted to the release project name. |
serviceName | String | The name of the service |
serviceProjectName | String | The name of the project containing specified service. If not specified, it is defaulted to the release project name. |
modifyDeployerConfiguration
Modifies deployer configuration associated with a deployer application or deployer service.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
releaseName | String | The name of the release |
serviceName | String | The name of the service |
stageName | String | The name of the stage of a pipeline attached to a release if specified. |
actualParameters | actualParameter array | Actual parameters |
applicationName | String | The name of the application |
applicationProjectName | String | The name of the project containing specified application. If not specified, it is defaulted to the release project name. |
clearActualParameters | Boolean | True if the task should remove all actual parameters. |
deployerConfigurationName | String | The name of deployer configuration. If not specified, a system generated guid is used. |
deployerTaskName | String | The name of the deployer task defined in the provided stage. |
environmentName | String | The name of the environment. |
environmentProjectName | String | The name of the project containing specified environment or environment template. If not specified, it is defaulted to the release project name. |
environmentTemplateName | String | The name of the environment template. |
environmentTemplateProjectName | String | The name of the project containing specified environment template. If not specified, it is defaulted to the environment project name. |
insertRollingDeployManualStep | Boolean | True to indicate a manual step needs to be injected after each phase or batch. |
newName | String | New name for an existing object that is being renamed. |
processName | String | The name of the application or service process. |
rollingDeployEnabled | Boolean | Perform rolling deployment. |
rollingDeployManualStepAssignees | String array | A list of assignees who receive the notification when rolling deploy iteration completes. |
rollingDeployManualStepCondition | String | Defines run condition on manual step created during rolling deployment. |
rollingDeployPhases | String array | One or more rolling deploy phases to be used for deployment. |
serviceProjectName | String | The name of the project containing specified service. If not specified, it is defaulted to the release project name. |
skipDeploy | Boolean | True to skip deployment to an environment |
snapshotName | String | The name of the snapshot |
removeDeployerConfiguration
Removes a deployer configuration
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
releaseName | String | The name of the release |
stageName | String | The name of the stage of a pipeline attached to a release if specified. |
applicationName | String | The name of the application |
applicationProjectName | String | The name of the project containing specified application. If not specified, it is defaulted to the release project name. |
deployerConfigurationName | String | The name of deployer configuration. If not specified, a system generated guid is used. |
deployerTaskName | String | The name of the deployer task defined in the provided stage. |
serviceName | String | The name of the service |
serviceProjectName | String | The name of the project containing specified service. If not specified, it is defaulted to the release project name. |
validateDeployer
Validate deployer configuration
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
releaseName | String | The name of the release |
stageName | String | The name of the stage of a pipeline attached to a release if specified. |
serviceName | String | The name of the service |
actualParameters | actualParameter array | Actual parameters |
applicationName | String | The name of the application |
applicationProjectName | String | The name of the project containing specified application. If not specified, it is defaulted to the release project name. |
deployerConfigurationName | String | The name of deployer configuration. If not specified, a system generated guid is used. |
deployerTaskName | String | The name of the deployer task defined in the provided stage. |
environmentName | String | The name of the environment. |
environmentProjectName | String | The name of the project containing specified environment or environment template. If not specified, it is defaulted to the release project name. |
environmentTemplateName | String | The name of the environment template. |
environmentTemplateProjectName | String | The name of the project containing specified environment template. If not specified, it is defaulted to the environment project name. |
insertRollingDeployManualStep | Boolean | True to indicate a manual step needs to be injected after each phase or batch. |
processName | String | The name of the application or service process. |
rollingDeployEnabled | Boolean | Perform rolling deployment. |
rollingDeployManualStepAssignees | String array | A list of assignees who receive the notification when rolling deploy iteration completes. |
rollingDeployManualStepCondition | String | Defines run condition on manual step created during rolling deployment. |
rollingDeployPhases | String array | One or more rolling deploy phases to be used for deployment. |
serviceProjectName | String | The name of the project containing specified service. If not specified, it is defaulted to the release project name. |
snapshotName | String | The name of the snapshot |
validationType | String | The type of validation to perform (APPROVER for approver, PARAM for parameter, ENV for environment, ALL for all validations). Defaults to ALL |