Share via

DeploymentWhatIfProperties interface

Package:
@azure/arm-resourcesdeployments

Deployment What-if properties.

Extends
DeploymentProperties

Properties

whatIfSettings

Optional What-If operation settings.

Inherited Properties

debugSetting

The debug setting of the deployment.
expressionEvaluationOptions

Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer.
extensionConfigs

The configurations to use for deployment extensions. The keys of this object are deployment 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.
mode

The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources.
onErrorDeployment

The deployment on error behavior.
parameters

Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string.
parametersLink

The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both.
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

Property Details

whatIfSettings

Optional What-If operation settings.

whatIfSettings?: DeploymentWhatIfSettings

Property Value

DeploymentWhatIfSettings

Inherited Property Details

debugSetting

The debug setting of the deployment.

debugSetting?: DebugSetting

Property Value

DebugSetting

Inherited From DeploymentProperties.debugSetting

expressionEvaluationOptions

Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer.

expressionEvaluationOptions?: ExpressionEvaluationOptions

Property Value

ExpressionEvaluationOptions

Inherited From DeploymentProperties.expressionEvaluationOptions

extensionConfigs

The configurations to use for deployment extensions. The keys of this object are deployment extension aliases as defined in the deployment template.

extensionConfigs?: {[propertyName: string]: {[propertyName: string]: DeploymentExtensionConfigItem}}

Property Value

{[propertyName: string]: {[propertyName: string]: DeploymentExtensionConfigItem}}

Inherited From DeploymentProperties.extensionConfigs

externalInputDefinitions

External input definitions, used by external tooling to define expected external input values.

externalInputDefinitions?: {[propertyName: string]: DeploymentExternalInputDefinition}

Property Value

{[propertyName: string]: DeploymentExternalInputDefinition}

Inherited From DeploymentProperties.externalInputDefinitions

externalInputs

External input values, used by external tooling for parameter evaluation.

externalInputs?: {[propertyName: string]: DeploymentExternalInput}

Property Value

{[propertyName: string]: DeploymentExternalInput}

Inherited From DeploymentProperties.externalInputs

mode

The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources.

mode: DeploymentMode

Property Value

DeploymentMode

Inherited From DeploymentProperties.mode

onErrorDeployment

The deployment on error behavior.

onErrorDeployment?: OnErrorDeployment

Property Value

OnErrorDeployment

Inherited From DeploymentProperties.onErrorDeployment

parameters

Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string.

parameters?: {[propertyName: string]: DeploymentParameter}

Property Value

{[propertyName: string]: DeploymentParameter}

Inherited From DeploymentProperties.parameters

The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both.

parametersLink?: ParametersLink

Property Value

ParametersLink

Inherited From DeploymentProperties.parametersLink

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>

Inherited From DeploymentProperties.template

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

templateLink?: TemplateLink

Property Value

TemplateLink

Inherited From DeploymentProperties.templateLink

validationLevel

The validation level of the deployment

validationLevel?: string

Property Value

string

Inherited From DeploymentProperties.validationLevel