Package com.azure.resourcemanager.resources.fluent.models

Class DeploymentStackProperties

java.lang.Object
com.azure.resourcemanager.resources.fluent.models.DeploymentStackProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<DeploymentStackProperties>
public final class DeploymentStackProperties extends Object implements com.azure.json.JsonSerializable<DeploymentStackProperties>
Deployment stack properties.

  • Constructor Details

    • DeploymentStackProperties

      public DeploymentStackProperties()
      Creates an instance of DeploymentStackProperties 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 DeploymentStackProperties 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 DeploymentStackProperties object itself.

    • templateLink

      public DeploymentStacksTemplateLink 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 DeploymentStackProperties withTemplateLink(DeploymentStacksTemplateLink 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 DeploymentStackProperties object itself.

    • parameters

      public Map<String,DeploymentParameter> parameters()
      Get the parameters property: Name and value pairs that define the deployment parameters for the template. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both.
      Returns:
      the parameters value.

    • withParameters

      public DeploymentStackProperties withParameters(Map<String,DeploymentParameter> parameters)
      Set the parameters property: Name and value pairs that define the deployment parameters for the template. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both.
      Parameters:
      parameters - the parameters value to set.
      Returns:
      the DeploymentStackProperties object itself.

    • parametersLink

      public DeploymentStacksParametersLink parametersLink()
      Get the parametersLink property: The URI of parameters file. 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 DeploymentStackProperties withParametersLink(DeploymentStacksParametersLink parametersLink)
      Set the parametersLink property: The URI of parameters file. 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 DeploymentStackProperties object itself.

    • actionOnUnmanage

      public ActionOnUnmanage actionOnUnmanage()
      Get the actionOnUnmanage property: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted.
      Returns:
      the actionOnUnmanage value.

    • withActionOnUnmanage

      public DeploymentStackProperties withActionOnUnmanage(ActionOnUnmanage actionOnUnmanage)
      Set the actionOnUnmanage property: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted.
      Parameters:
      actionOnUnmanage - the actionOnUnmanage value to set.
      Returns:
      the DeploymentStackProperties object itself.

    • debugSetting

      public DeploymentStacksDebugSetting debugSetting()
      Get the debugSetting property: The debug setting of the deployment.
      Returns:
      the debugSetting value.

    • withDebugSetting

      public DeploymentStackProperties withDebugSetting(DeploymentStacksDebugSetting debugSetting)
      Set the debugSetting property: The debug setting of the deployment.
      Parameters:
      debugSetting - the debugSetting value to set.
      Returns:
      the DeploymentStackProperties object itself.

    • bypassStackOutOfSyncError

      public Boolean bypassStackOutOfSyncError()
      Get the bypassStackOutOfSyncError property: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized.
      Returns:
      the bypassStackOutOfSyncError value.

    • withBypassStackOutOfSyncError

      public DeploymentStackProperties withBypassStackOutOfSyncError(Boolean bypassStackOutOfSyncError)
      Set the bypassStackOutOfSyncError property: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized.
      Parameters:
      bypassStackOutOfSyncError - the bypassStackOutOfSyncError value to set.
      Returns:
      the DeploymentStackProperties object itself.

    • deploymentScope

      public String deploymentScope()
      Get the deploymentScope property: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}').
      Returns:
      the deploymentScope value.

    • withDeploymentScope

      public DeploymentStackProperties withDeploymentScope(String deploymentScope)
      Set the deploymentScope property: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}').
      Parameters:
      deploymentScope - the deploymentScope value to set.
      Returns:
      the DeploymentStackProperties object itself.

    • description

      public String description()
      Get the description property: Deployment stack description. Max length of 4096 characters.
      Returns:
      the description value.

    • withDescription

      public DeploymentStackProperties withDescription(String description)
      Set the description property: Deployment stack description. Max length of 4096 characters.
      Parameters:
      description - the description value to set.
      Returns:
      the DeploymentStackProperties object itself.

    • denySettings

      public DenySettings denySettings()
      Get the denySettings property: Defines how resources deployed by the stack are locked.
      Returns:
      the denySettings value.

    • withDenySettings

      public DeploymentStackProperties withDenySettings(DenySettings denySettings)
      Set the denySettings property: Defines how resources deployed by the stack are locked.
      Parameters:
      denySettings - the denySettings value to set.
      Returns:
      the DeploymentStackProperties object itself.

    • provisioningState

      public DeploymentStackProvisioningState provisioningState()
      Get the provisioningState property: State of the deployment stack.
      Returns:
      the provisioningState value.

    • correlationId

      public String correlationId()
      Get the correlationId property: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing.
      Returns:
      the correlationId value.

    • detachedResources

      public List<ResourceReference> detachedResources()
      Get the detachedResources property: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack.
      Returns:
      the detachedResources value.

    • deletedResources

      public List<ResourceReference> deletedResources()
      Get the deletedResources property: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified.
      Returns:
      the deletedResources value.

    • failedResources

      public List<ResourceReferenceExtended> failedResources()
      Get the failedResources property: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message.
      Returns:
      the failedResources value.

    • resources

      public List<ManagedResourceReference> resources()
      Get the resources property: An array of resources currently managed by the deployment stack.
      Returns:
      the resources value.

    • deploymentId

      public String deploymentId()
      Get the deploymentId property: The resourceId of the deployment resource created by the deployment stack.
      Returns:
      the deploymentId value.

    • outputs

      public Object outputs()
      Get the outputs property: The outputs of the deployment resource created by the deployment stack.
      Returns:
      the outputs value.

    • duration

      public String duration()
      Get the duration property: The duration of the last successful Deployment stack update.
      Returns:
      the duration value.

    • error

      public com.azure.core.management.exception.ManagementError error()
      Get the error property: The error detail.
      Returns:
      the error value.

    • withError

      public DeploymentStackProperties withError(com.azure.core.management.exception.ManagementError error)
      Set the error property: The error detail.
      Parameters:
      error - the error value to set.
      Returns:
      the DeploymentStackProperties 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<DeploymentStackProperties>
      Throws:
      IOException

    • fromJson

      public static DeploymentStackProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of DeploymentStackProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of DeploymentStackProperties 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 DeploymentStackProperties.