Deployment Interface

Package:

com.azure.resourcemanager.resources.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-resources:2.45.0

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()
abstract List<Dependency>	dependencies()
abstract DeploymentOperations	deploymentOperations()
abstract ManagementError	error()
abstract DeploymentExportResult	exportTemplate() Exports a deployment template.
abstract Mono<DeploymentExportResult>	exportTemplateAsync() Exports a deployment template asynchronously.
abstract DeploymentMode	mode()
abstract List<ResourceReference>	outputResources() Get array of provisioned resources.
abstract Object	outputs()
abstract Object	parameters()
abstract ParametersLink	parametersLink()
abstract Execution	prepareWhatIf() Prepares a What-if operation.
abstract List<Provider>	providers()
abstract String	provisioningState()
abstract String	resourceGroupName()
abstract String	templateHash()
abstract TemplateLink	templateLink()
abstract OffsetDateTime	timestamp()

Method Details

cancel

public abstract void cancel()

Cancel a currently running template deployment.

cancelAsync

public abstract Mono cancelAsync()

Cancel a currently running template deployment asynchronously.

Returns:

a representation of the deferred computation of this call

correlationId

public abstract String correlationId()

Returns:

the correlation ID of the deployment

dependencies

public abstract List dependencies()

Returns:

the list of deployment dependencies

deploymentOperations

public abstract DeploymentOperations deploymentOperations()

Returns:

the operations related to this deployment

error

public abstract ManagementError error()

Returns:

the ManagementError, if deployment fails.

exportTemplate

public abstract DeploymentExportResult exportTemplate()

Exports a deployment template.

Returns:

the export result

exportTemplateAsync

public abstract Mono 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()

Returns:

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

outputResources

public abstract List outputResources()

Get array of provisioned resources.

Returns:

the outputResources value

outputs

public abstract Object outputs()

Returns:

key/value pairs that represent deployment output

parameters

public abstract Object parameters()

Returns:

the deployment parameters

parametersLink

public abstract ParametersLink parametersLink()

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 providers()

Returns:

the list of resource providers needed for the deployment

provisioningState

public abstract String provisioningState()

Returns:

the state of the provisioning process of the resources being deployed

resourceGroupName

public abstract String resourceGroupName()

Returns:

the name of this deployment's resource group

templateHash

public abstract String templateHash()

Returns:

the hash produced for the template

templateLink

public abstract TemplateLink templateLink()

Returns:

the URI referencing the template

timestamp

public abstract OffsetDateTime timestamp()

Returns:

the timestamp of the template deployment