DeploymentStack Class
Deployment stack object.
Variables are only populated by the server, and will be ignored when sending a request.
- Inheritance
-
azure.mgmt.resource.deploymentstacks.v2022_08_01_preview.models._models_py3.AzureResourceBaseDeploymentStack
Constructor
DeploymentStack(*, location: str | None = None, tags: Dict[str, str] | None = None, 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, action_on_unmanage: _models.DeploymentStackPropertiesActionOnUnmanage | None = None, debug_setting: _models.DeploymentStacksDebugSetting | None = None, deployment_scope: str | None = None, description: str | None = None, deny_settings: _models.DenySettings | None = None, **kwargs: Any)
Keyword-Only Parameters
Name | Description |
---|---|
location
|
The location of the deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. |
tags
|
Deployment stack resource tags. |
error
|
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). |
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. 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. |
parameters_link
|
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. |
action_on_unmanage
|
Defines the behavior of resources that are not managed immediately after the stack is updated. |
debug_setting
|
The debug setting of the deployment. |
deployment_scope
|
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}'). |
description
|
Deployment stack description. |
deny_settings
|
Defines how resources deployed by the stack are locked. |
Variables
Name | Description |
---|---|
id
|
String Id used to locate any resource on Azure. |
name
|
Name of this resource. |
type
|
Type of this resource. |
system_data
|
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
location
|
The location of the deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. |
tags
|
Deployment stack resource tags. |
error
|
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). |
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. 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. |
parameters_link
|
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. |
action_on_unmanage
|
Defines the behavior of resources that are not managed immediately after the stack is updated. |
debug_setting
|
The debug setting of the deployment. |
deployment_scope
|
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}'). |
description
|
Deployment stack description. |
deny_settings
|
Defines how resources deployed by the stack are locked. |
provisioning_state
|
State of the deployment stack. Known values are: "Creating", "Validating", "Waiting", "Deploying", "Canceling", "Locking", "DeletingResources", "Succeeded", "Failed", "Canceled", and "Deleting". |
detached_resources
|
An array of resources that were detached during the most recent update. |
deleted_resources
|
An array of resources that were deleted during the most recent update. |
failed_resources
|
An array of resources that failed to reach goal state during the most recent update. |
resources
|
An array of resources currently managed by the deployment stack. |
deployment_id
|
The resourceId of the deployment resource created by the deployment stack. |
outputs
|
<xref:JSON>
The outputs of the underlying deployment. |
duration
|
The duration of the deployment stack update. |
Azure SDK for Python