Deployment Interface

  • Reference
Package:
com.microsoft.azure.management.resources
Maven Artifact:
com.microsoft.azure:azure-mgmt-resources:1.41.4

Implements

HasId HasManager<com.microsoft.azure.management.resources.implementation.ResourceManager> HasName HasInner<com.microsoft.azure.management.resources.implementation.DeploymentExtendedInner> Indexable Refreshable<Deployment> Updatable<Update>

public interface Deployment
extends Indexable, Refreshable<Deployment>, Updatable<Update>, HasInner<com.microsoft.azure.management.resources.implementation.DeploymentExtendedInner>, HasManager<com.microsoft.azure.management.resources.implementation.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 rx.Completable cancelAsync()

Cancel a currently running template deployment asynchronously.
abstract com.microsoft.rest.ServiceFuture<java.lang.Void> cancelAsync(ServiceCallback<Void> callback)

Cancel a currently running template deployment asynchronously.
abstract java.lang.String correlationId()
abstract java.util.List<Dependency> dependencies()
abstract DeploymentOperations deploymentOperations()
abstract DeploymentExportResult exportTemplate()

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

Exports a deployment template asynchronously.
abstract com.microsoft.rest.ServiceFuture<DeploymentExportResult> exportTemplateAsync(ServiceCallback<DeploymentExportResult> callback)

Exports a deployment template asynchronously.
abstract DeploymentMode mode()
abstract java.util.List<ResourceReference> outputResources()

Get array of provisioned resources.
abstract java.lang.Object outputs()
abstract java.lang.Object parameters()
abstract ParametersLink parametersLink()
abstract Execution prepareWhatIf()

Prepares a What-if operation.
abstract java.util.List<Provider> providers()
abstract java.lang.String provisioningState()
abstract java.lang.String resourceGroupName()
abstract java.lang.String templateHash()
abstract TemplateLink templateLink()
abstract org.joda.time.DateTime timestamp()

Method Details

cancel

public abstract void cancel()

Cancel a currently running template deployment.

cancelAsync

public abstract Completable cancelAsync()

Cancel a currently running template deployment asynchronously.

Returns:

a representation of the deferred computation of this call

cancelAsync

public abstract ServiceFuture cancelAsync(ServiceCallback callback)

Cancel a currently running template deployment asynchronously.

Parameters:

callback - the callback to call on success or failure

Returns:

a handle to cancel the request

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

exportTemplate

public abstract DeploymentExportResult exportTemplate()

Exports a deployment template.

Returns:

the export result

exportTemplateAsync

public abstract Observable exportTemplateAsync()

Exports a deployment template asynchronously.

Returns:

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

exportTemplateAsync

public abstract ServiceFuture exportTemplateAsync(ServiceCallback callback)

Exports a deployment template asynchronously.

Parameters:

callback - the callback to call on success or failure with export result as parameter

Returns:

a handle to cancel the request

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 DateTime timestamp()

Returns:

the timestamp of the template deployment

Applies to