DeploymentWhatIfProperties Class
Deployment What-if properties.
All required parameters must be populated in order to send to server.
- Inheritance
-
azure.mgmt.resource.resources.v2019_10_01.models._models_py3.DeploymentPropertiesDeploymentWhatIfProperties
Constructor
DeploymentWhatIfProperties(*, mode: str | _models.DeploymentMode, template: MutableMapping[str, Any] | None = None, template_link: _models.TemplateLink | None = None, parameters: MutableMapping[str, Any] | None = None, parameters_link: _models.ParametersLink | None = None, debug_setting: _models.DebugSetting | None = None, on_error_deployment: _models.OnErrorDeployment | None = None, what_if_settings: _models.DeploymentWhatIfSettings | None = None, **kwargs: Any)Keyword-Only Parameters
| Name | Description |
|---|---|
|
template
|
<xref:JSON>
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_link
|
The URI of the template. Use either the templateLink property or the template property, but not both. |
|
parameters
|
<xref:JSON>
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_link
|
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. |
|
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. Required. Known values are: "Incremental" and "Complete". |
|
debug_setting
|
The debug setting of the deployment. |
|
on_error_deployment
|
The deployment on error behavior. |
|
what_if_settings
|
Optional What-If operation settings. |
Variables
| Name | Description |
|---|---|
|
template
|
<xref:JSON>
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_link
|
The URI of the template. Use either the templateLink property or the template property, but not both. |
|
parameters
|
<xref:JSON>
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_link
|
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. |
|
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. Required. Known values are: "Incremental" and "Complete". |
|
debug_setting
|
The debug setting of the deployment. |
|
on_error_deployment
|
The deployment on error behavior. |
|
what_if_settings
|
Optional What-If operation settings. |
Azure SDK for Python