DeploymentProperties Class

Package:

com.azure.resourcemanager.resources.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-resources:2.52.0

• java.lang.Object
• • com.azure.resourcemanager.resources.models.DeploymentProperties

Implements

JsonSerializable<DeploymentProperties>

public class DeploymentProperties
implements JsonSerializable<DeploymentProperties>

Deployment properties.

Constructor Summary

Constructor	Description
DeploymentProperties()	Creates an instance of DeploymentProperties class.

Method Summary

Modifier and Type	Method and Description
DebugSetting	debugSetting() Get the debugSetting property: The debug setting of the deployment.
ExpressionEvaluationOptions	expressionEvaluationOptions() Get the expressionEvaluationOptions property: Specifies whether template expressions are evaluated within the scope of the parent template or nested template.
Map<String,Map<String,DeploymentExtensionConfigItem>>	extensionConfigs() Get the extensionConfigs property: The configurations to use for deployment extensions.
Map<String,DeploymentExternalInputDefinition>	externalInputDefinitions() Get the externalInputDefinitions property: External input definitions, used by external tooling to define expected external input values.
Map<String,DeploymentExternalInput>	externalInputs() Get the externalInputs property: External input values, used by external tooling for parameter evaluation.
static DeploymentProperties	fromJson(JsonReader jsonReader) Reads an instance of DeploymentProperties from the JsonReader.
DeploymentMode	mode() Get the mode property: The mode that is used to deploy resources.
OnErrorDeployment	onErrorDeployment() Get the onErrorDeployment property: The deployment on error behavior.
Map<String,DeploymentParameter>	parameters() Get the parameters property: Name and value pairs that define the deployment parameters for the template.
ParametersLink	parametersLink() Get the parametersLink property: The URI of parameters file.
Object	template() Get the template property: The template content.
TemplateLink	templateLink() Get the templateLink property: The URI of the template.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
ValidationLevel	validationLevel() Get the validationLevel property: The validation level of the deployment.
DeploymentProperties	withDebugSetting(DebugSetting debugSetting) Set the debugSetting property: The debug setting of the deployment.
DeploymentProperties	withExpressionEvaluationOptions(ExpressionEvaluationOptions expressionEvaluationOptions) Set the expressionEvaluationOptions property: Specifies whether template expressions are evaluated within the scope of the parent template or nested template.
DeploymentProperties	withExtensionConfigs(Map<String,Map<String,DeploymentExtensionConfigItem>> extensionConfigs) Set the extensionConfigs property: The configurations to use for deployment extensions.
DeploymentProperties	withExternalInputDefinitions(Map<String,DeploymentExternalInputDefinition> externalInputDefinitions) Set the externalInputDefinitions property: External input definitions, used by external tooling to define expected external input values.
DeploymentProperties	withExternalInputs(Map<String,DeploymentExternalInput> externalInputs) Set the externalInputs property: External input values, used by external tooling for parameter evaluation.
DeploymentProperties	withMode(DeploymentMode mode) Set the mode property: The mode that is used to deploy resources.
DeploymentProperties	withOnErrorDeployment(OnErrorDeployment onErrorDeployment) Set the onErrorDeployment property: The deployment on error behavior.
DeploymentProperties	withParameters(Map<String,DeploymentParameter> parameters) Set the parameters property: Name and value pairs that define the deployment parameters for the template.
DeploymentProperties	withParametersLink(ParametersLink parametersLink) Set the parametersLink property: The URI of parameters file.
DeploymentProperties	withTemplate(Object template) Set the template property: The template content.
DeploymentProperties	withTemplateLink(TemplateLink templateLink) Set the templateLink property: The URI of the template.
DeploymentProperties	withValidationLevel(ValidationLevel validationLevel) Set the validationLevel property: The validation level of the deployment.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DeploymentProperties

public DeploymentProperties()

Creates an instance of DeploymentProperties class.

Method Details

debugSetting

public DebugSetting debugSetting()

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

Returns:

the debugSetting value.

expressionEvaluationOptions

public ExpressionEvaluationOptions expressionEvaluationOptions()

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

Returns:

the expressionEvaluationOptions value.

extensionConfigs

public Map<String,Map<String,DeploymentExtensionConfigItem>> extensionConfigs()

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

Returns:

the extensionConfigs value.

externalInputDefinitions

public Map<String,DeploymentExternalInputDefinition> externalInputDefinitions()

Get the externalInputDefinitions property: External input definitions, used by external tooling to define expected external input values.

Returns:

the externalInputDefinitions value.

externalInputs

public Map<String,DeploymentExternalInput> externalInputs()

Get the externalInputs property: External input values, used by external tooling for parameter evaluation.

Returns:

the externalInputs value.

fromJson

public static DeploymentProperties fromJson(JsonReader jsonReader)

Reads an instance of DeploymentProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DeploymentProperties 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.

mode

public DeploymentMode mode()

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

Returns:

the mode value.

onErrorDeployment

public OnErrorDeployment onErrorDeployment()

Get the onErrorDeployment property: The deployment on error behavior.

Returns:

the onErrorDeployment value.

parameters

public Map<String,DeploymentParameter> parameters()

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

Returns:

the parameters value.

parametersLink

public ParametersLink parametersLink()

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

Returns:

the parametersLink value.

template

public Object template()

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

Returns:

the template value.

templateLink

public TemplateLink templateLink()

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

Returns:

the templateLink value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

validationLevel

public ValidationLevel validationLevel()

Get the validationLevel property: The validation level of the deployment.

Returns:

the validationLevel value.

withDebugSetting

public DeploymentProperties withDebugSetting(DebugSetting debugSetting)

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

Parameters:

debugSetting - the debugSetting value to set.

Returns:

the DeploymentProperties object itself.

withExpressionEvaluationOptions

public DeploymentProperties 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.

Parameters:

expressionEvaluationOptions - the expressionEvaluationOptions value to set.

Returns:

the DeploymentProperties object itself.

withExtensionConfigs

public DeploymentProperties withExtensionConfigs(Map<String,Map<String,DeploymentExtensionConfigItem>> extensionConfigs)

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

Parameters:

extensionConfigs - the extensionConfigs value to set.

Returns:

the DeploymentProperties object itself.

withExternalInputDefinitions

public DeploymentProperties withExternalInputDefinitions(Map<String,DeploymentExternalInputDefinition> externalInputDefinitions)

Set the externalInputDefinitions property: External input definitions, used by external tooling to define expected external input values.

Parameters:

externalInputDefinitions - the externalInputDefinitions value to set.

Returns:

the DeploymentProperties object itself.

withExternalInputs

public DeploymentProperties withExternalInputs(Map<String,DeploymentExternalInput> externalInputs)

Set the externalInputs property: External input values, used by external tooling for parameter evaluation.

Parameters:

externalInputs - the externalInputs value to set.

Returns:

the DeploymentProperties object itself.

withMode

public DeploymentProperties 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.

Parameters:

mode - the mode value to set.

Returns:

the DeploymentProperties object itself.

withOnErrorDeployment

public DeploymentProperties withOnErrorDeployment(OnErrorDeployment onErrorDeployment)

Set the onErrorDeployment property: The deployment on error behavior.

Parameters:

onErrorDeployment - the onErrorDeployment value to set.

Returns:

the DeploymentProperties object itself.

withParameters

public DeploymentProperties withParameters(Map<String,DeploymentParameter> 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.

Parameters:

parameters - the parameters value to set.

Returns:

the DeploymentProperties object itself.

withParametersLink

public DeploymentProperties 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.

Parameters:

parametersLink - the parametersLink value to set.

Returns:

the DeploymentProperties object itself.

withTemplate

public DeploymentProperties 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.

Parameters:

template - the template value to set.

Returns:

the DeploymentProperties object itself.

withTemplateLink

public DeploymentProperties withTemplateLink(TemplateLink templateLink)

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

withValidationLevel

public DeploymentProperties withValidationLevel(ValidationLevel validationLevel)

Set the validationLevel property: The validation level of the deployment.

Parameters:

validationLevel - the validationLevel value to set.

Returns:

the DeploymentProperties object itself.