com.microsoft.azure.management.resources

Class DeploymentProperties

java.lang.Object

com.microsoft.azure.management.resources.DeploymentProperties

Direct Known Subclasses:

DeploymentWhatIfProperties

public class DeploymentProperties
extends Object

Deployment properties.

Constructor Summary

Constructors

Constructor and Description
DeploymentProperties()

Method Summary

Modifier and Type	Method and Description
DebugSetting	debugSetting() Get the debug setting of the deployment.
ExpressionEvaluationOptions	expressionEvaluationOptions() Get specifies whether template expressions are evaluated within the scope of the parent template or nested template.
DeploymentMode	mode() Get the mode that is used to deploy resources.
OnErrorDeployment	onErrorDeployment() Get the deployment on error behavior.
Object	parameters() Get name and value pairs that define the deployment parameters for the template.
ParametersLink	parametersLink() Get the URI of parameters file.
Object	template() Get the template content.
TemplateLink	templateLink() Get the URI of the template.
DeploymentProperties	withDebugSetting(DebugSetting debugSetting) Set the debug setting of the deployment.
DeploymentProperties	withExpressionEvaluationOptions(ExpressionEvaluationOptions expressionEvaluationOptions) Set specifies whether template expressions are evaluated within the scope of the parent template or nested template.
DeploymentProperties	withMode(DeploymentMode mode) Set the mode that is used to deploy resources.
DeploymentProperties	withOnErrorDeployment(OnErrorDeployment onErrorDeployment) Set the deployment on error behavior.
DeploymentProperties	withParameters(Object parameters) Set name and value pairs that define the deployment parameters for the template.
DeploymentProperties	withParametersLink(ParametersLink parametersLink) Set the URI of parameters file.
DeploymentProperties	withTemplate(Object template) Set the template content.
DeploymentProperties	withTemplateLink(TemplateLink templateLink) Set the URI of the template.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeploymentProperties

public DeploymentProperties()

Method Detail

template

public Object template()

Get 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.

Returns:

the template value

withTemplate

public DeploymentProperties withTemplate(Object template)

Set 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.

Parameters:

template - the template value to set

Returns:

the DeploymentProperties object itself.

templateLink

public TemplateLink templateLink()

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

Returns:

the templateLink value

withTemplateLink

public DeploymentProperties withTemplateLink(TemplateLink templateLink)

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

Parameters:

templateLink - the templateLink value to set

Returns:

the DeploymentProperties object itself.

parameters

public Object parameters()

Get 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.

Returns:

the parameters value

withParameters

public DeploymentProperties withParameters(Object parameters)

Set 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:

parameters - the parameters value to set

Returns:

the DeploymentProperties object itself.

parametersLink

public ParametersLink parametersLink()

Get 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.

Returns:

the parametersLink value

withParametersLink

public DeploymentProperties withParametersLink(ParametersLink parametersLink)

Set 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.

Parameters:

parametersLink - the parametersLink value to set

Returns:

the DeploymentProperties object itself.

mode

public DeploymentMode mode()

Get 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. Possible values include: 'Incremental', 'Complete'.

Returns:

the mode value

withMode

public DeploymentProperties withMode(DeploymentMode mode)

Set 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. Possible values include: 'Incremental', 'Complete'.

Parameters:

mode - the mode value to set

Returns:

the DeploymentProperties object itself.

debugSetting

public DebugSetting debugSetting()

Get the debug setting of the deployment.

Returns:

the debugSetting value

withDebugSetting

public DeploymentProperties withDebugSetting(DebugSetting debugSetting)

Set the debug setting of the deployment.

Parameters:

debugSetting - the debugSetting value to set

Returns:

the DeploymentProperties object itself.

onErrorDeployment

public OnErrorDeployment onErrorDeployment()

Get the deployment on error behavior.

Returns:

the onErrorDeployment value

withOnErrorDeployment

public DeploymentProperties withOnErrorDeployment(OnErrorDeployment onErrorDeployment)

Set the deployment on error behavior.

Parameters:

onErrorDeployment - the onErrorDeployment value to set

Returns:

the DeploymentProperties object itself.

expressionEvaluationOptions

public ExpressionEvaluationOptions expressionEvaluationOptions()

Get 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.

Returns:

the expressionEvaluationOptions value

withExpressionEvaluationOptions

public DeploymentProperties withExpressionEvaluationOptions(ExpressionEvaluationOptions expressionEvaluationOptions)

Set 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.

Parameters:

expressionEvaluationOptions - the expressionEvaluationOptions value to set

Returns:

the DeploymentProperties object itself.