DeploymentStackProperties Class

Definition

Deployment stack properties.

public class DeploymentStackProperties
type DeploymentStackProperties = class
Public Class DeploymentStackProperties
Inheritance
DeploymentStackProperties

Constructors

Name Description
DeploymentStackProperties()

Initializes a new instance of the DeploymentStackProperties class.

DeploymentStackProperties(ActionOnUnmanage, DenySettings, ErrorDetail, IDictionary<String,Object>, DeploymentStacksTemplateLink, IDictionary<String, DeploymentParameter>, DeploymentStacksParametersLink, IDictionary<String, IDictionary<String,DeploymentExtensionConfigItem>>, IDictionary<String, DeploymentExternalInput>, IDictionary<String,DeploymentExternalInputDefinition>, DeploymentStacksDebugSetting, String, String, String, String, String, Nullable<Boolean>, IList<ResourceReference>, IList<ResourceReference>, IList<ResourceReferenceExtended>, IList<ManagedResourceReference>, IList<DeploymentExtension>, String, IDictionary<String,Object>, String)

Initializes a new instance of the DeploymentStackProperties class.

Properties

Name Description
ActionOnUnmanage

Gets or sets defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted.

BypassStackOutOfSyncError

Gets or sets flag to bypass service errors that indicate the stack resource list is not correctly synchronized.

CorrelationId

Gets the correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing.

DebugSetting

Gets or sets the debug setting of the deployment.

DeletedResources

Gets 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.

DenySettings

Gets or sets defines how resources deployed by the stack are locked.

DeploymentExtensions

Gets the extensions used during deployment. Contains extension data for all extensible resources managed by the stack.

DeploymentId

Gets the resourceId of the deployment resource created by the deployment stack.

DeploymentScope

Gets or sets 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

Gets or sets deployment stack description. Max length of 4096 characters.

DetachedResources

Gets 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

Gets the duration of the last successful Deployment stack update.

Error

Gets the error detail.

ExtensionConfigs

Gets or sets the deployment extension configs. Keys of this object are extension aliases as defined in the deployment template.

ExternalInputDefinitions

Gets or sets external input definitions, used by external tooling to define expected external input values.

ExternalInputs

Gets or sets external input values, used by external tooling for parameter evaluation.

FailedResources

Gets an array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message.

Outputs

Gets the outputs of the deployment resource created by the deployment stack.

Parameters

Gets or sets 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

Gets or sets 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

Gets state of the deployment stack. Possible values include: 'creating', 'validating', 'waiting', 'deploying', 'canceling', 'updatingDenyAssignments', 'deletingResources', 'succeeded', 'failed', 'canceled', 'deleting', 'initializing', 'running'

Resources

Gets an array of resources currently managed by the deployment stack.

Template

Gets or sets 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

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

ValidationLevel

Gets or sets the validation level of the deployment stack Possible values include: 'Template', 'Provider', 'ProviderNoRbac'

Methods

Name Description
Validate()

Validate the object.

Applies to