com.azure.resourcemanager.resources.models

Class DeploymentWhatIfProperties

java.lang.Object

com.azure.resourcemanager.resources.models.DeploymentProperties

com.azure.resourcemanager.resources.models.DeploymentWhatIfProperties

public final class DeploymentWhatIfProperties
extends DeploymentProperties

Deployment What-if properties.

Constructor Summary

Constructors

Constructor and Description
DeploymentWhatIfProperties()

Method Summary

Modifier and Type	Method and Description
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(Object 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 class com.azure.resourcemanager.resources.models.DeploymentProperties

debugSetting, expressionEvaluationOptions, mode, onErrorDeployment, parameters, parametersLink, template, templateLink

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeploymentWhatIfProperties

public DeploymentWhatIfProperties()

Method Detail

whatIfSettings

public DeploymentWhatIfSettings whatIfSettings()

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

Returns:

the whatIfSettings value.

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.

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:

withTemplate in class DeploymentProperties

Parameters:

template - the template value to set.

Returns:

the DeploymentProperties object itself.

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:

withTemplateLink in class DeploymentProperties

Parameters:

templateLink - the templateLink value to set.

Returns:

the DeploymentProperties object itself.

withParameters

public DeploymentWhatIfProperties withParameters(Object 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:

withParameters in class DeploymentProperties

Parameters:

parameters - the parameters value to set.

Returns:

the DeploymentProperties object itself.

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:

withParametersLink in class DeploymentProperties

Parameters:

parametersLink - the parametersLink value to set.

Returns:

the DeploymentProperties object itself.

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:

withMode in class DeploymentProperties

Parameters:

mode - the mode value to set.

Returns:

the DeploymentProperties object itself.

withDebugSetting

public DeploymentWhatIfProperties withDebugSetting(DebugSetting debugSetting)

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

Overrides:

withDebugSetting in class DeploymentProperties

Parameters:

debugSetting - the debugSetting value to set.

Returns:

the DeploymentProperties object itself.

withOnErrorDeployment

public DeploymentWhatIfProperties withOnErrorDeployment(OnErrorDeployment onErrorDeployment)

Set the onErrorDeployment property: The deployment on error behavior.

Overrides:

withOnErrorDeployment in class DeploymentProperties

Parameters:

onErrorDeployment - the onErrorDeployment value to set.

Returns:

the DeploymentProperties object itself.

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:

withExpressionEvaluationOptions in class DeploymentProperties

Parameters:

expressionEvaluationOptions - the expressionEvaluationOptions value to set.

Returns:

the DeploymentProperties object itself.

validate

public void validate()

Validates the instance.

Overrides:

validate in class DeploymentProperties

Throws:

IllegalArgumentException - thrown if the instance is not valid.