DeploymentProperties interface
Deployment properties.
Properties
| debug |
The debug setting of the deployment. |
| mode | The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources. |
| on |
The deployment on error behavior. |
| parameters | Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. |
| parameters |
The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. |
| template | The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. |
| template |
The URI of the template. Use either the templateLink property or the template property, but not both. |
Property Details
debugSetting
mode
The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources.
mode: DeploymentModeProperty Value
onErrorDeployment
The deployment on error behavior.
onErrorDeployment?: OnErrorDeploymentProperty Value
parameters
Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string.
parameters?: Record<string, unknown>Property Value
Record<string, unknown>
parametersLink
The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both.
parametersLink?: ParametersLinkProperty Value
template
The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both.
template?: Record<string, unknown>Property Value
Record<string, unknown>
templateLink
The URI of the template. Use either the templateLink property or the template property, but not both.
templateLink?: TemplateLink