DeploymentStacksWhatIfResultProperties interface

Package:

@azure/arm-resourcesdeploymentstacks

DeploymentStack WhatIfResult Properties

Properties

actionOnUnmanage	Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted.
changes	All of the changes predicted by the deployment stack what-if operation.
correlationId	The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing.
debugSetting	The debug setting of the deployment.
denySettings	Defines how resources deployed by the stack are locked.
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}').
deploymentStackLastModified	The timestamp for when the deployment stack was last modified. This can be used to determine if the what-if data is still current.
deploymentStackResourceId	The deployment stack id to use as the basis for comparison.
description	Deployment stack description. Max length of 4096 characters.
diagnostics	List of resource diagnostics detected by What-If operation.
error	The error detail.
extensionConfigs	The deployment extension configs. Keys of this object are extension aliases as defined in the deployment template.
externalInputDefinitions	External input definitions, used by external tooling to define expected external input values.
externalInputs	External input values, used by external tooling for parameter evaluation.
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.
retentionInterval	The interval to persist the deployment stack what-if result in ISO 8601 format.
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.
validationLevel	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

ActionOnUnmanage

changes

All of the changes predicted by the deployment stack what-if operation.

changes?: DeploymentStacksWhatIfChange

Property Value

DeploymentStacksWhatIfChange

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

DeploymentStacksDebugSetting

denySettings

Defines how resources deployed by the stack are locked.

denySettings: DenySettings

Property Value

DenySettings

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

deploymentStackLastModified

The timestamp for when the deployment stack was last modified. This can be used to determine if the what-if data is still current.

deploymentStackLastModified?: Date

Property Value

Date

deploymentStackResourceId

The deployment stack id to use as the basis for comparison.

deploymentStackResourceId: string

Property Value

string

description

Deployment stack description. Max length of 4096 characters.

description?: string

Property Value

string

diagnostics

List of resource diagnostics detected by What-If operation.

diagnostics?: DeploymentStacksDiagnostic[]

Property Value

DeploymentStacksDiagnostic[]

error

The error detail.

error?: ErrorDetail

Property Value

ErrorDetail

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>

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

DeploymentStacksParametersLink

provisioningState

State of the deployment stack.

provisioningState?: string

Property Value

string

retentionInterval

The interval to persist the deployment stack what-if result in ISO 8601 format.

retentionInterval: string

Property Value

string

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

DeploymentStacksTemplateLink

validationLevel

The validation level of the deployment stack

validationLevel?: string

Property Value

string