Share via

DeploymentWhatIfProperties Class

  • Reference
Package:
com.azure.resourcemanager.resources.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-resources:2.44.0

public final class DeploymentWhatIfProperties
extends DeploymentProperties

Deployment What-if properties.

Constructor Summary

Constructor Description
DeploymentWhatIfProperties()

Creates an instance of DeploymentWhatIfProperties class.

Method Summary

Modifier and Type Method and Description
static DeploymentWhatIfProperties fromJson(JsonReader jsonReader)

Reads an instance of DeploymentWhatIfProperties from the JsonReader.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
DeploymentWhatIfSettings whatIfSettings()

Get the whatIfSettings property: Optional What-If operation settings.
DeploymentWhatIfProperties withDebugSetting(DebugSetting debugSetting)

Set the debugSetting property: The debug setting of the deployment.
DeploymentWhatIfProperties withExpressionEvaluationOptions(ExpressionEvaluationOptions expressionEvaluationOptions)

Set the expressionEvaluationOptions property: Specifies whether template expressions are evaluated within the scope of the parent template or nested template.
DeploymentWhatIfProperties withMode(DeploymentMode mode)

Set the mode property: The mode that is used to deploy resources.
DeploymentWhatIfProperties withOnErrorDeployment(OnErrorDeployment onErrorDeployment)

Set the onErrorDeployment property: The deployment on error behavior.
DeploymentWhatIfProperties withParameters(Map<String,DeploymentParameter> parameters)

Set the parameters property: Name and value pairs that define the deployment parameters for the template.
DeploymentWhatIfProperties withParametersLink(ParametersLink parametersLink)

Set the parametersLink property: The URI of parameters file.
DeploymentWhatIfProperties withTemplate(Object template)

Set the template property: The template content.
DeploymentWhatIfProperties withTemplateLink(TemplateLink templateLink)

Set the templateLink property: The URI of the template.
DeploymentWhatIfProperties withWhatIfSettings(DeploymentWhatIfSettings whatIfSettings)

Set the whatIfSettings property: Optional What-If operation settings.

Methods inherited from DeploymentProperties

debugSetting expressionEvaluationOptions fromJson mode onErrorDeployment parameters parametersLink template templateLink toJson validate withDebugSetting withExpressionEvaluationOptions withMode withOnErrorDeployment withParameters withParametersLink withTemplate withTemplateLink

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DeploymentWhatIfProperties

public DeploymentWhatIfProperties()

Creates an instance of DeploymentWhatIfProperties class.

Method Details

fromJson

public static DeploymentWhatIfProperties fromJson(JsonReader jsonReader)

Reads an instance of DeploymentWhatIfProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DeploymentWhatIfProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

DeploymentWhatIfProperties.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

Overrides:

DeploymentWhatIfProperties.validate()

whatIfSettings

public DeploymentWhatIfSettings whatIfSettings()

Get the whatIfSettings property: Optional What-If operation settings.

Returns:

the whatIfSettings value.

withDebugSetting

public DeploymentWhatIfProperties withDebugSetting(DebugSetting debugSetting)

Set the debugSetting property: The debug setting of the deployment.

Overrides:

DeploymentWhatIfProperties.withDebugSetting(DebugSetting debugSetting)

Parameters:

debugSetting

withExpressionEvaluationOptions

public DeploymentWhatIfProperties withExpressionEvaluationOptions(ExpressionEvaluationOptions expressionEvaluationOptions)

Set the expressionEvaluationOptions property: 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.

Overrides:

DeploymentWhatIfProperties.withExpressionEvaluationOptions(ExpressionEvaluationOptions expressionEvaluationOptions)

Parameters:

expressionEvaluationOptions

withMode

public DeploymentWhatIfProperties withMode(DeploymentMode mode)

Set the mode property: 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.

Overrides:

DeploymentWhatIfProperties.withMode(DeploymentMode mode)

Parameters:

mode

withOnErrorDeployment

public DeploymentWhatIfProperties withOnErrorDeployment(OnErrorDeployment onErrorDeployment)

Set the onErrorDeployment property: The deployment on error behavior.

Overrides:

DeploymentWhatIfProperties.withOnErrorDeployment(OnErrorDeployment onErrorDeployment)

Parameters:

onErrorDeployment

withParameters

public DeploymentWhatIfProperties withParameters(Map parameters)

Set the parameters property: 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.

Overrides:

DeploymentWhatIfProperties.withParameters(Map<String,DeploymentParameter> parameters)

Parameters:

parameters

withParametersLink

public DeploymentWhatIfProperties withParametersLink(ParametersLink parametersLink)

Set the parametersLink property: 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.

Overrides:

DeploymentWhatIfProperties.withParametersLink(ParametersLink parametersLink)

Parameters:

parametersLink

withTemplate

public DeploymentWhatIfProperties withTemplate(Object template)

Set the template property: 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.

Overrides:

DeploymentWhatIfProperties.withTemplate(Object template)

Parameters:

template

withTemplateLink

public DeploymentWhatIfProperties withTemplateLink(TemplateLink templateLink)

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

Overrides:

DeploymentWhatIfProperties.withTemplateLink(TemplateLink templateLink)

Parameters:

templateLink

withWhatIfSettings

public DeploymentWhatIfProperties withWhatIfSettings(DeploymentWhatIfSettings whatIfSettings)

Set the whatIfSettings property: Optional What-If operation settings.

Parameters:

whatIfSettings - the whatIfSettings value to set.

Returns:

the DeploymentWhatIfProperties object itself.

Applies to