DeploymentStackData Class

Definition

A class representing the ArmDeploymentStack data model. Deployment stack object.

public class DeploymentStackData : Azure.ResourceManager.Models.ResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Resources.DeploymentStackData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Resources.DeploymentStackData>
type DeploymentStackData = class
    inherit ResourceData
    interface IJsonModel<DeploymentStackData>
    interface IPersistableModel<DeploymentStackData>
Public Class DeploymentStackData
Inherits ResourceData
Implements IJsonModel(Of DeploymentStackData), IPersistableModel(Of DeploymentStackData)
Inheritance
DeploymentStackData
Implements

Constructors

DeploymentStackData()

Initializes a new instance of DeploymentStackData.

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.

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.

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

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
Location

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

Name

The name of the resource.

(Inherited from ResourceData)
Outputs

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

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(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

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
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 FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(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

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ResourceData)

Explicit Interface Implementations

IJsonModel<DeploymentStackData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<DeploymentStackData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<DeploymentStackData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<DeploymentStackData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<DeploymentStackData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to