azure.mgmt.resource.deploymentstacks.v2022_08_01_preview.models.DeploymentStackProperties.yml

### YamlMime:PythonClass
uid: azure.mgmt.resource.deploymentstacks.v2022_08_01_preview.models.DeploymentStackProperties
name: DeploymentStackProperties
fullName: azure.mgmt.resource.deploymentstacks.v2022_08_01_preview.models.DeploymentStackProperties
module: azure.mgmt.resource.deploymentstacks.v2022_08_01_preview.models
inheritances:
- azure.mgmt.resource.deploymentstacks.v2022_08_01_preview.models._models_py3.DeploymentStacksError
summary: 'Deployment stack properties.


  Variables are only populated by the server, and will be ignored when sending a request.


  All required parameters must be populated in order to send to server.'
constructor:
  syntax: 'DeploymentStackProperties(*, action_on_unmanage: _models.DeploymentStackPropertiesActionOnUnmanage,
    deny_settings: _models.DenySettings, error: _models.ErrorResponse | None = None,
    template: MutableMapping[str, Any] | None = None, template_link: _models.DeploymentStacksTemplateLink
    | None = None, parameters: MutableMapping[str, Any] | None = None, parameters_link:
    _models.DeploymentStacksParametersLink | None = None, debug_setting: _models.DeploymentStacksDebugSetting
    | None = None, deployment_scope: str | None = None, description: str | None =
    None, **kwargs: Any)'
  keywordOnlyParameters:
  - name: error
    description: 'Common error response for all Azure Resource Manager APIs to return
      error

      details for failed operations. (This also follows the OData error response format.).'
    types:
    - <xref:azure.mgmt.resource.deploymentstacks.v2022_08_01_preview.models.ErrorResponse>
  - 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.deploymentstacks.v2022_08_01_preview.models.DeploymentStacksTemplateLink>
  - name: parameters
    description: 'Name and value pairs that define the deployment parameters for the

      template. Use this element when providing the parameter values directly in the
      request, rather

      than linking 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. 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.deploymentstacks.v2022_08_01_preview.models.DeploymentStacksParametersLink>
  - name: action_on_unmanage
    description: 'Defines the behavior of resources that are not managed immediately

      after the stack is updated. Required.'
    types:
    - <xref:azure.mgmt.resource.deploymentstacks.v2022_08_01_preview.models.DeploymentStackPropertiesActionOnUnmanage>
  - name: debug_setting
    description: The debug setting of the deployment.
    types:
    - <xref:azure.mgmt.resource.deploymentstacks.v2022_08_01_preview.models.DeploymentStacksDebugSetting>
  - name: deployment_scope
    description: 'The scope at which the initial deployment should be created. If
      a

      scope is not specified, it will default to the scope of the deployment stack.
      Valid scopes are:

      management group (format:

      ''/providers/Microsoft.Management/managementGroups/{managementGroupId}''), subscription
      (format:

      ''/subscriptions/{subscriptionId}''), resource group (format:

      ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'').'
    types:
    - <xref:str>
  - name: description
    description: Deployment stack description.
    types:
    - <xref:str>
  - name: deny_settings
    description: Defines how resources deployed by the stack are locked. Required.
    types:
    - <xref:azure.mgmt.resource.deploymentstacks.v2022_08_01_preview.models.DenySettings>
variables:
- description: 'Common error response for all Azure Resource Manager APIs to return
    error details

    for failed operations. (This also follows the OData error response format.).'
  name: error
  types:
  - <xref:azure.mgmt.resource.deploymentstacks.v2022_08_01_preview.models.ErrorResponse>
- 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.deploymentstacks.v2022_08_01_preview.models.DeploymentStacksTemplateLink>
- description: 'Name and value pairs that define the deployment parameters for the
    template.

    Use this element when providing the parameter values directly in the request,
    rather than

    linking 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. 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.deploymentstacks.v2022_08_01_preview.models.DeploymentStacksParametersLink>
- description: 'Defines the behavior of resources that are not managed immediately

    after the stack is updated. Required.'
  name: action_on_unmanage
  types:
  - <xref:azure.mgmt.resource.deploymentstacks.v2022_08_01_preview.models.DeploymentStackPropertiesActionOnUnmanage>
- description: The debug setting of the deployment.
  name: debug_setting
  types:
  - <xref:azure.mgmt.resource.deploymentstacks.v2022_08_01_preview.models.DeploymentStacksDebugSetting>
- description: 'The scope at which the initial deployment should be created. If a
    scope

    is not specified, it will default to the scope of the deployment stack. Valid
    scopes are:

    management group (format:

    ''/providers/Microsoft.Management/managementGroups/{managementGroupId}''), subscription
    (format:

    ''/subscriptions/{subscriptionId}''), resource group (format:

    ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'').'
  name: deployment_scope
  types:
  - <xref:str>
- description: Deployment stack description.
  name: description
  types:
  - <xref:str>
- description: Defines how resources deployed by the stack are locked. Required.
  name: deny_settings
  types:
  - <xref:azure.mgmt.resource.deploymentstacks.v2022_08_01_preview.models.DenySettings>
- description: 'State of the deployment stack. Known values are: "Creating",

    "Validating", "Waiting", "Deploying", "Canceling", "Locking", "DeletingResources",
    "Succeeded",

    "Failed", "Canceled", and "Deleting".'
  name: provisioning_state
  types:
  - <xref:str>
  - <xref:azure.mgmt.resource.deploymentstacks.v2022_08_01_preview.models.DeploymentStackProvisioningState>
- description: 'An array of resources that were detached during the most recent

    update.'
  name: detached_resources
  types:
  - <xref:list>[<xref:azure.mgmt.resource.deploymentstacks.v2022_08_01_preview.models.ResourceReference>]
- description: An array of resources that were deleted during the most recent update.
  name: deleted_resources
  types:
  - <xref:list>[<xref:azure.mgmt.resource.deploymentstacks.v2022_08_01_preview.models.ResourceReference>]
- description: 'An array of resources that failed to reach goal state during the most

    recent update.'
  name: failed_resources
  types:
  - <xref:list>[<xref:azure.mgmt.resource.deploymentstacks.v2022_08_01_preview.models.ResourceReferenceExtended>]
- description: An array of resources currently managed by the deployment stack.
  name: resources
  types:
  - <xref:list>[<xref:azure.mgmt.resource.deploymentstacks.v2022_08_01_preview.models.ManagedResourceReference>]
- description: The resourceId of the deployment resource created by the deployment
    stack.
  name: deployment_id
  types:
  - <xref:str>
- description: The outputs of the underlying deployment.
  name: outputs
  types:
  - <xref:JSON>
- description: The duration of the deployment stack update.
  name: duration
  types:
  - <xref:str>