DeploymentStackProperties interface

Package:

@azure/arm-resourcesdeploymentstacks

Deployment stack properties.

Extends

DeploymentStacksError

Properties

actionOnUnmanage	Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted.
bypassStackOutOfSyncError	Flag to bypass service errors that indicate the stack resource list is not correctly synchronized.
correlationId	The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. NOTE: This property will not be serialized. It can only be populated by the server.
debugSetting	The debug setting of the deployment.
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. NOTE: This property will not be serialized. It can only be populated by the server.
denySettings	Defines how resources deployed by the stack are locked.
deploymentId	The resourceId of the deployment resource created by the deployment stack. NOTE: This property will not be serialized. It can only be populated by the server.
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}').
description	Deployment stack description. Max length of 4096 characters.
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. NOTE: This property will not be serialized. It can only be populated by the server.
duration	The duration of the last successful Deployment stack update. NOTE: This property will not be serialized. It can only be populated by the server.
failedResources	An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. NOTE: This property will not be serialized. It can only be populated by the server.
outputs	The outputs of the deployment resource created by the deployment stack. NOTE: This property will not be serialized. It can only be populated by the server.
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.
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.
provisioningState	State of the deployment stack. NOTE: This property will not be serialized. It can only be populated by the server.
resources	An array of resources currently managed by the deployment stack. NOTE: This property will not be serialized. It can only be populated by the server.
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.
templateLink	The URI of the template. Use either the templateLink property or the template property, but not both.

Inherited Properties

error

The error detail.

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

ActionOnUnmanage

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. NOTE: This property will not be serialized. It can only be populated by the server.

correlationId?: string

Property Value

string

debugSetting

The debug setting of the deployment.

debugSetting?: DeploymentStacksDebugSetting

Property Value

DeploymentStacksDebugSetting

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. NOTE: This property will not be serialized. It can only be populated by the server.

deletedResources?: ResourceReference[]

Property Value

ResourceReference[]

denySettings

Defines how resources deployed by the stack are locked.

denySettings: DenySettings

Property Value

DenySettings

deploymentId

The resourceId of the deployment resource created by the deployment stack. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

detachedResources?: ResourceReference[]

Property Value

ResourceReference[]

duration

The duration of the last successful Deployment stack update. NOTE: This property will not be serialized. It can only be populated by the server.

duration?: string

Property Value

string

failedResources

An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. NOTE: This property will not be serialized. It can only be populated by the server.

failedResources?: ResourceReferenceExtended[]

Property Value

ResourceReferenceExtended[]

outputs

The outputs of the deployment resource created by the deployment stack. NOTE: This property will not be serialized. It can only be populated by the server.

outputs?: Record<string, unknown>

Property Value

Record<string, unknown>

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?: {[propertyName: string]: DeploymentParameter}

Property Value

{[propertyName: 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

DeploymentStacksParametersLink

provisioningState

State of the deployment stack. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

resources

An array of resources currently managed by the deployment stack. NOTE: This property will not be serialized. It can only be populated by the server.

resources?: ManagedResourceReference[]

Property Value

ManagedResourceReference[]

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, unknown>

Property Value

Record<string, unknown>

templateLink

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

templateLink?: DeploymentStacksTemplateLink

Property Value

DeploymentStacksTemplateLink

Inherited Property Details

error

The error detail.

error?: ErrorDetail

Property Value

ErrorDetail

Inherited From DeploymentStacksError.error