DeploymentStackProperties interface
Deployment stack properties.
Properties
| action |
Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. |
| bypass |
Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. |
| correlation |
The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. |
| debug |
The debug setting of the deployment. |
| deleted |
An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. |
| deny |
Defines how resources deployed by the stack are locked. |
| deployment |
The extensions used during deployment. Contains extension data for all extensible resources managed by the stack. |
| deployment |
The resourceId of the deployment resource created by the deployment stack. |
| deployment |
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. Max length of 4096 characters. |
| detached |
An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. |
| duration | The duration of the last successful Deployment stack update. |
| error | The error detail. |
| extension |
The deployment extension configs. Keys of this object are extension aliases as defined in the deployment template. |
| external |
External input definitions, used by external tooling to define expected external input values. |
| external |
External input values, used by external tooling for parameter evaluation. |
| failed |
An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. |
| outputs | The outputs of the deployment resource created by the deployment stack. |
| parameters | 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. |
| parameters |
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. |
| provisioning |
State of the deployment stack. |
| resources | An array of resources currently managed by the deployment stack. |
| template | 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 |
The URI of the template. Use either the templateLink property or the template property, but not both. |
| validation |
The validation level of the deployment stack |
Property Details
actionOnUnmanage
Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted.
actionOnUnmanage: ActionOnUnmanage
Property Value
bypassStackOutOfSyncError
Flag to bypass service errors that indicate the stack resource list is not correctly synchronized.
bypassStackOutOfSyncError?: boolean
Property Value
boolean
correlationId
The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing.
correlationId?: string
Property Value
string
debugSetting
The debug setting of the deployment.
debugSetting?: DeploymentStacksDebugSetting
Property Value
deletedResources
An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified.
deletedResources?: ResourceReference[]
Property Value
denySettings
Defines how resources deployed by the stack are locked.
denySettings: DenySettings
Property Value
deploymentExtensions
The extensions used during deployment. Contains extension data for all extensible resources managed by the stack.
deploymentExtensions?: DeploymentExtension[]
Property Value
deploymentId
The resourceId of the deployment resource created by the deployment stack.
deploymentId?: string
Property Value
string
deploymentScope
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}').
deploymentScope?: string
Property Value
string
description
Deployment stack description. Max length of 4096 characters.
description?: string
Property Value
string
detachedResources
An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack.
detachedResources?: ResourceReference[]
Property Value
duration
The duration of the last successful Deployment stack update.
duration?: string
Property Value
string
error
extensionConfigs
The deployment extension configs. Keys of this object are extension aliases as defined in the deployment template.
extensionConfigs?: Record<string, DeploymentExtensionConfig>
Property Value
Record<string, DeploymentExtensionConfig>
externalInputDefinitions
External input definitions, used by external tooling to define expected external input values.
externalInputDefinitions?: Record<string, DeploymentExternalInputDefinition>
Property Value
Record<string, DeploymentExternalInputDefinition>
externalInputs
External input values, used by external tooling for parameter evaluation.
externalInputs?: Record<string, DeploymentExternalInput>
Property Value
Record<string, DeploymentExternalInput>
failedResources
An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message.
failedResources?: ResourceReferenceExtended[]
Property Value
outputs
The outputs of the deployment resource created by the deployment stack.
outputs?: Record<string, any>
Property Value
Record<string, any>
parameters
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.
parameters?: Record<string, DeploymentParameter>
Property Value
Record<string, DeploymentParameter>
parametersLink
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.
parametersLink?: DeploymentStacksParametersLink
Property Value
provisioningState
State of the deployment stack.
provisioningState?: string
Property Value
string
resources
An array of resources currently managed by the deployment stack.
resources?: ManagedResourceReference[]
Property Value
template
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?: Record<string, any>
Property Value
Record<string, any>
templateLink
The URI of the template. Use either the templateLink property or the template property, but not both.
templateLink?: DeploymentStacksTemplateLink
Property Value
validationLevel
The validation level of the deployment stack
validationLevel?: string
Property Value
string