Package com.azure.resourcemanager.resources.models

Class DeploymentProperties

java.lang.Object
com.azure.resourcemanager.resources.models.DeploymentProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<DeploymentProperties>
Direct Known Subclasses:
DeploymentWhatIfProperties
public class DeploymentProperties extends Object implements com.azure.json.JsonSerializable<DeploymentProperties>
Deployment properties.

  • Constructor Details

    • DeploymentProperties

      public DeploymentProperties()
      Creates an instance of DeploymentProperties class.

  • Method Details

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

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

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

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

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

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

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

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

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

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

    • debugSetting

      public DebugSetting debugSetting()
      Get the debugSetting property: The debug setting of the deployment.
      Returns:
      the debugSetting 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.

    • onErrorDeployment

      public OnErrorDeployment onErrorDeployment()
      Get the onErrorDeployment property: The deployment on error behavior.
      Returns:
      the onErrorDeployment value.

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

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

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

    • validationLevel

      public ValidationLevel validationLevel()
      Get the validationLevel property: The validation level of the deployment.
      Returns:
      the validationLevel value.

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

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<DeploymentProperties>
      Throws:
      IOException

    • fromJson

      public static DeploymentProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the DeploymentProperties.