DeploymentWhatIfProperties Class

Deployment What-if properties.

All required parameters must be populated in order to send to Azure.

Inheritance
azure.mgmt.resource.resources.v2019_10_01.models._models_py3.DeploymentProperties
DeploymentWhatIfProperties

Constructor

DeploymentWhatIfProperties(*, mode: typing.Union[str, _ForwardRef('DeploymentMode')], template: typing.Union[typing.Any, NoneType] = None, template_link: typing.Union[_ForwardRef('TemplateLink'), NoneType] = None, parameters: typing.Union[typing.Any, NoneType] = None, parameters_link: typing.Union[_ForwardRef('ParametersLink'), NoneType] = None, debug_setting: typing.Union[_ForwardRef('DebugSetting'), NoneType] = None, on_error_deployment: typing.Union[_ForwardRef('OnErrorDeployment'), NoneType] = None, what_if_settings: typing.Union[_ForwardRef('DeploymentWhatIfSettings'), NoneType] = None, **kwargs)

Parameters

template
any
Required

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
TemplateLink
Required

The URI of the template. Use either the templateLink property or the template property, but not both.

parameters
any
Required

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
ParametersLink
Required

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
str or DeploymentMode
Required

Required. 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. Possible values include: "Incremental", "Complete".

debug_setting
DebugSetting
Required

The debug setting of the deployment.

on_error_deployment
OnErrorDeployment
Required

The deployment on error behavior.

what_if_settings
DeploymentWhatIfSettings
Required

Optional What-If operation settings.