azure.mgmt.resource.resources.v2020_10_01.models.DeploymentProperties.yml

### YamlMime:PythonClass
uid: azure.mgmt.resource.resources.v2020_10_01.models.DeploymentProperties
name: DeploymentProperties
fullName: azure.mgmt.resource.resources.v2020_10_01.models.DeploymentProperties
module: azure.mgmt.resource.resources.v2020_10_01.models
inheritances:
- azure.mgmt.resource.resources._serialization.Model
summary: 'Deployment properties.


  All required parameters must be populated in order to send to server.'
constructor:
  syntax: 'DeploymentProperties(*, 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, expression_evaluation_options: _models.ExpressionEvaluationOptions
    | None = None, **kwargs: Any)'
  keywordOnlyParameters:
  - name: template
    description: '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.'
    types:
    - <xref:JSON>
  - name: template_link
    description: 'The URI of the template. Use either the templateLink property or
      the

      template property, but not both.'
    types:
    - <xref:azure.mgmt.resource.resources.v2020_10_01.models.TemplateLink>
  - name: parameters
    description: '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.'
    types:
    - <xref:JSON>
  - name: parameters_link
    description: '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.'
    types:
    - <xref:azure.mgmt.resource.resources.v2020_10_01.models.ParametersLink>
  - name: mode
    description: '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".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.resource.resources.v2020_10_01.models.DeploymentMode>
  - name: debug_setting
    description: The debug setting of the deployment.
    types:
    - <xref:azure.mgmt.resource.resources.v2020_10_01.models.DebugSetting>
  - name: on_error_deployment
    description: The deployment on error behavior.
    types:
    - <xref:azure.mgmt.resource.resources.v2020_10_01.models.OnErrorDeployment>
  - name: expression_evaluation_options
    description: 'Specifies whether template expressions are evaluated

      within the scope of the parent template or nested template. Only applicable
      to nested

      templates. If not specified, default value is outer.'
    types:
    - <xref:azure.mgmt.resource.resources.v2020_10_01.models.ExpressionEvaluationOptions>
variables:
- description: '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.'
  name: template
  types:
  - <xref:JSON>
- description: 'The URI of the template. Use either the templateLink property or the

    template property, but not both.'
  name: template_link
  types:
  - <xref:azure.mgmt.resource.resources.v2020_10_01.models.TemplateLink>
- description: '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.'
  name: parameters
  types:
  - <xref:JSON>
- description: '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.'
  name: parameters_link
  types:
  - <xref:azure.mgmt.resource.resources.v2020_10_01.models.ParametersLink>
- description: '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".'
  name: mode
  types:
  - <xref:str>
  - <xref:azure.mgmt.resource.resources.v2020_10_01.models.DeploymentMode>
- description: The debug setting of the deployment.
  name: debug_setting
  types:
  - <xref:azure.mgmt.resource.resources.v2020_10_01.models.DebugSetting>
- description: The deployment on error behavior.
  name: on_error_deployment
  types:
  - <xref:azure.mgmt.resource.resources.v2020_10_01.models.OnErrorDeployment>
- description: 'Specifies whether template expressions are evaluated

    within the scope of the parent template or nested template. Only applicable to
    nested

    templates. If not specified, default value is outer.'
  name: expression_evaluation_options
  types:
  - <xref:azure.mgmt.resource.resources.v2020_10_01.models.ExpressionEvaluationOptions>