Package com.azure.resourcemanager.resources.models

Interface Deployment

All Superinterfaces:
HasId, HasInnerModel<DeploymentExtendedInner>, HasManager<ResourceManager>, HasName, Indexable, Refreshable<Deployment>, Updatable<Deployment.Update>
public interface Deployment extends Indexable, Refreshable<Deployment>, Updatable<Deployment.Update>, HasInnerModel<DeploymentExtendedInner>, HasManager<ResourceManager>, HasName, HasId
An immutable client-side representation of an Azure deployment.

  • Method Details

    • resourceGroupName

      String resourceGroupName()
      Gets the name of this deployment's resource group.
      Returns:
      the name of this deployment's resource group

    • provisioningState

      String provisioningState()
      Gets the state of the provisioning process of the resources being deployed.
      Returns:
      the state of the provisioning process of the resources being deployed

    • correlationId

      String correlationId()
      Gets the correlation ID of the deployment.
      Returns:
      the correlation ID of the deployment

    • timestamp

      OffsetDateTime timestamp()
      Gets the timestamp of the template deployment.
      Returns:
      the timestamp of the template deployment

    • outputs

      Object outputs()
      Gets key/value pairs that represent deployment output.
      Returns:
      key/value pairs that represent deployment output

    • providers

      List<Provider> providers()
      Gets the list of resource providers needed for the deployment.
      Returns:
      the list of resource providers needed for the deployment

    • dependencies

      List<Dependency> dependencies()
      Gets the list of deployment dependencies.
      Returns:
      the list of deployment dependencies

    • templateHash

      String templateHash()
      Gets the hash produced for the template.
      Returns:
      the hash produced for the template

    • templateLink

      TemplateLink templateLink()
      Gets the URI referencing the template.
      Returns:
      the URI referencing the template

    • parameters

      Object parameters()
      Gets the deployment parameters.
      Returns:
      the deployment parameters

    • parametersLink

      ParametersLink parametersLink()
      Gets the URI referencing the parameters.
      Returns:
      the URI referencing the parameters

    • mode

      DeploymentMode mode()
      Gets the deployment mode.
      Returns:
      the deployment mode. Possible values include: 'Incremental', 'Complete'.

    • error

      com.azure.core.management.exception.ManagementError error()
      Gets the ManagementError.
      Returns:
      the ManagementError, if deployment fails.

    • outputResources

      List<ResourceReference> outputResources()
      Get array of provisioned resources.
      Returns:
      the outputResources value

    • deploymentOperations

      DeploymentOperations deploymentOperations()
      Gets the operations related to this deployment.
      Returns:
      the operations related to this deployment

    • cancel

      void cancel()
      Cancel a currently running template deployment.

    • cancelAsync

      Mono<Void> cancelAsync()
      Cancel a currently running template deployment asynchronously.
      Returns:
      a representation of the deferred computation of this call

    • exportTemplate

      DeploymentExportResult exportTemplate()
      Exports a deployment template.
      Returns:
      the export result

    • exportTemplateAsync

      Mono<DeploymentExportResult> exportTemplateAsync()
      Exports a deployment template asynchronously.
      Returns:
      a representation of the deferred computation of this call returning the export result

    • prepareWhatIf

      Deployment.Execution prepareWhatIf()
      Prepares a What-if operation.
      Returns:
      the What-if execution.