Share via

Deployment Interface

Package:
com.azure.resourcemanager.resources.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-resources:2.53.5

Implements

HasId HasManager<ResourceManager> HasName HasInnerModel<DeploymentExtendedInner> Indexable Refreshable<Deployment> Updatable<Update>

public interface Deployment
extends Indexable, Refreshable<Deployment>, Updatable<Update>, HasInnerModel<DeploymentExtendedInner>, HasManager<ResourceManager>, HasName, HasId

An immutable client-side representation of an Azure deployment.

Method Summary

Modifier and Type Method and Description
abstract void cancel()

Cancel a currently running template deployment.
abstract Mono<Void> cancelAsync()

Cancel a currently running template deployment asynchronously.
abstract String correlationId()

Gets the correlation ID of the deployment.
abstract List<Dependency> dependencies()

Gets the list of deployment dependencies.
abstract DeploymentOperations deploymentOperations()

Gets the operations related to this deployment.
abstract ManagementError error()

Gets the ManagementError.
abstract DeploymentExportResult exportTemplate()

Exports a deployment template.
abstract Mono<DeploymentExportResult> exportTemplateAsync()

Exports a deployment template asynchronously.
abstract DeploymentMode mode()

Gets the deployment mode.
abstract List<ResourceReference> outputResources()

Get array of provisioned resources.
abstract Object outputs()

Gets key/value pairs that represent deployment output.
abstract Object parameters()

Gets the deployment parameters.
abstract ParametersLink parametersLink()

Gets the URI referencing the parameters.
abstract Execution prepareWhatIf()

Prepares a What-if operation.
abstract List<Provider> providers()

Gets the list of resource providers needed for the deployment.
abstract String provisioningState()

Gets the state of the provisioning process of the resources being deployed.
abstract String resourceGroupName()

Gets the name of this deployment's resource group.
abstract String templateHash()

Gets the hash produced for the template.
abstract TemplateLink templateLink()

Gets the URI referencing the template.
abstract OffsetDateTime timestamp()

Gets the timestamp of the template deployment.

Method Details

cancel

public abstract void cancel()

Cancel a currently running template deployment.

cancelAsync

public abstract Mono<Void> cancelAsync()

Cancel a currently running template deployment asynchronously.

Returns:

a representation of the deferred computation of this call

correlationId

public abstract String correlationId()

Gets the correlation ID of the deployment.

Returns:

the correlation ID of the deployment

dependencies

public abstract List<Dependency> dependencies()

Gets the list of deployment dependencies.

Returns:

the list of deployment dependencies

deploymentOperations

public abstract DeploymentOperations deploymentOperations()

Gets the operations related to this deployment.

Returns:

the operations related to this deployment

error

public abstract ManagementError error()

Gets the ManagementError.

Returns:

the ManagementError, if deployment fails.

exportTemplate

public abstract DeploymentExportResult exportTemplate()

Exports a deployment template.

Returns:

the export result

exportTemplateAsync

public abstract Mono<DeploymentExportResult> exportTemplateAsync()

Exports a deployment template asynchronously.

Returns:

a representation of the deferred computation of this call returning the export result

mode

public abstract DeploymentMode mode()

Gets the deployment mode.

Returns:

the deployment mode. Possible values include: 'Incremental', 'Complete'.

outputResources

public abstract List<ResourceReference> outputResources()

Get array of provisioned resources.

Returns:

the outputResources value

outputs

public abstract Object outputs()

Gets key/value pairs that represent deployment output.

Returns:

key/value pairs that represent deployment output

parameters

public abstract Object parameters()

Gets the deployment parameters.

Returns:

the deployment parameters

parametersLink

public abstract ParametersLink parametersLink()

Gets the URI referencing the parameters.

Returns:

the URI referencing the parameters

prepareWhatIf

public abstract Deployment.Execution prepareWhatIf()

Prepares a What-if operation.

Returns:

the What-if execution.

providers

public abstract List<Provider> providers()

Gets the list of resource providers needed for the deployment.

Returns:

the list of resource providers needed for the deployment

provisioningState

public abstract 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

resourceGroupName

public abstract String resourceGroupName()

Gets the name of this deployment's resource group.

Returns:

the name of this deployment's resource group

templateHash

public abstract String templateHash()

Gets the hash produced for the template.

Returns:

the hash produced for the template

templateLink

public abstract TemplateLink templateLink()

Gets the URI referencing the template.

Returns:

the URI referencing the template

timestamp

public abstract OffsetDateTime timestamp()

Gets the timestamp of the template deployment.

Returns:

the timestamp of the template deployment

Applies to