Share via


DeploymentStack Class

Definition

DeploymentStack.

public class DeploymentStack : Azure.Provisioning.Primitives.ProvisionableResource
type DeploymentStack = class
    inherit ProvisionableResource
Public Class DeploymentStack
Inherits ProvisionableResource
Inheritance

Constructors

DeploymentStack(String, String)

Creates a new DeploymentStack.

Properties

ActionOnUnmanage

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

BicepIdentifier

Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores.

(Inherited from NamedProvisionableConstruct)
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.

DebugSettingDetailLevel

Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed.

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.

DenySettings

Defines how resources deployed by the stack are locked.

DependsOn

Declares explicit dependencies on other resources.

(Inherited from ProvisionableResource)
DeploymentId

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

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.

Duration

The duration of the last successful Deployment stack update.

Error

The error detail.

FailedResources

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

Id

Gets the Id.

IsExistingResource

Gets whether this is referencing an existing resource or we're defining a new resource.

(Inherited from ProvisionableResource)
Location

The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations.

Name

Name of the deployment stack.

Outputs

The outputs of the deployment resource created by the deployment stack. To assign an object to this property use System.BinaryData.FromObjectAsJson1(0,System.Text.Json.JsonSerializerOptions). To assign an already formatted json string to this property use System.BinaryData.FromString(System.String). Examples: BinaryData.FromObjectAsJson("foo")Creates a payload of "foo".BinaryData.FromString(""foo"")Creates a payload of "foo".BinaryData.FromObjectAsJson(new { key = "value" })Creates a payload of { "key": "value" }.BinaryData.FromString("{"key": "value"}")Creates a payload of { "key": "value" }.

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.

Resources

An array of resources currently managed by the deployment stack.

ResourceType

Gets the type of the resource.

(Inherited from ProvisionableResource)
ResourceVersion

Gets or sets the version of the resource.

(Inherited from ProvisionableResource)
SystemData

Gets the SystemData.

Tags

Deployment stack resource tags.

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. To assign an object to this property use System.BinaryData.FromObjectAsJson1(0,System.Text.Json.JsonSerializerOptions). To assign an already formatted json string to this property use System.BinaryData.FromString(System.String). Examples: BinaryData.FromObjectAsJson("foo")Creates a payload of "foo".BinaryData.FromString(""foo"")Creates a payload of "foo".BinaryData.FromObjectAsJson(new { key = "value" })Creates a payload of { "key": "value" }.BinaryData.FromString("{"key": "value"}")Creates a payload of { "key": "value" }.

TemplateLink

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

Methods

AssignOrReplace<T>(T, T) (Inherited from ProvisionableConstruct)
Build(ProvisioningBuildOptions)

Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly.

(Inherited from ProvisionableResource)
Compile()

Compile the resource into a set of Bicep statements.

(Inherited from ProvisionableResource)
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineListProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String) (Inherited from ProvisionableConstruct)
DefineProvisionableProperties()

Define all the provisionable properties of DeploymentStack.

DefineResource<T>(String, String[], Boolean, Boolean, T) (Inherited from ProvisionableResource)
FromExisting(String, String)

Creates a reference to an existing DeploymentStack.

GetProvisionableResources()

Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure.

(Inherited from Provisionable)
Initialize()

Initialize this construct.

(Inherited from ProvisionableConstruct)
OverrideWithExpression(BicepExpression) (Inherited from ProvisionableConstruct)
Resolve(ProvisioningBuildOptions)

Resolve any resources or properties that were not explicitly specified.

(Inherited from ProvisionableConstruct)
Validate(ProvisioningBuildOptions)

Validate the presence of any required members.

(Inherited from ProvisionableResource)

Explicit Interface Implementations

IBicepValue.Assign(IBicepValue)

Assign a value to this property.

(Inherited from ProvisionableConstruct)
IBicepValue.Compile()

Compile this value to a Bicep expression.

(Inherited from ProvisionableConstruct)
IBicepValue.Expression

Gets the expression for this value if it's not a literal.

(Inherited from ProvisionableConstruct)
IBicepValue.IsEmpty

Gets whether this value is unset or empty.

(Inherited from ProvisionableConstruct)
IBicepValue.IsOutput

Tracks whether this is an output only property.

(Inherited from ProvisionableConstruct)
IBicepValue.IsRequired

Tracks whether this property is required.

(Inherited from ProvisionableConstruct)
IBicepValue.IsSecure

Tracks whether this contains a secure value.

(Inherited from ProvisionableConstruct)
IBicepValue.Kind

Gets the kind of this value (a literal value, an expression, or it's unset).

(Inherited from ProvisionableConstruct)
IBicepValue.LiteralValue

Get the value of this expression, if it's literal.

(Inherited from ProvisionableConstruct)
IBicepValue.Self

Gets information about where this value was defined.

(Inherited from ProvisionableConstruct)
IBicepValue.SetReadOnly()

Make this value readonly.

(Inherited from ProvisionableConstruct)
IBicepValue.Source

Gets information about where this value was assigned from.

(Inherited from ProvisionableConstruct)

Applies to