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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Deployment.Definition Container interface for all the deployment definitions.
static interface	Deployment.DefinitionStages Grouping of all the deployment definition stages.
static interface	Deployment.Execution Container interface for all the deployment execution.
static interface	Deployment.ExecutionStages Grouping of all the deployment execution stages.
static interface	Deployment.Update The template for a deployment update operation, containing all the settings that can be modified.
static interface	Deployment.UpdateStages Grouping of all the deployment updates stages.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel a currently running template deployment.
Mono<Void>	cancelAsync() Cancel a currently running template deployment asynchronously.
String	correlationId()
List<Dependency>	dependencies()
DeploymentOperations	deploymentOperations()
com.azure.core.management.exception.ManagementError	error()
DeploymentExportResult	exportTemplate() Exports a deployment template.
Mono<DeploymentExportResult>	exportTemplateAsync() Exports a deployment template asynchronously.
DeploymentMode	mode()
List<ResourceReference>	outputResources() Get array of provisioned resources.
Object	outputs()
Object	parameters()
ParametersLink	parametersLink()
Deployment.Execution	prepareWhatIf() Prepares a What-if operation.
List<Provider>	providers()
String	provisioningState()
String	resourceGroupName()
String	templateHash()
TemplateLink	templateLink()
OffsetDateTime	timestamp()

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Indexable

key

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Refreshable

refresh, refreshAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Updatable

update

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel

innerModel

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager

manager

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasName

name

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasId

id

Method Detail

resourceGroupName

String resourceGroupName()

Returns:

the name of this deployment's resource group

provisioningState

String provisioningState()

Returns:

the state of the provisioning process of the resources being deployed

correlationId

String correlationId()

Returns:

the correlation ID of the deployment

timestamp

OffsetDateTime timestamp()

Returns:

the timestamp of the template deployment

outputs

Object outputs()

Returns:

key/value pairs that represent deployment output

providers

List<Provider> providers()

Returns:

the list of resource providers needed for the deployment

dependencies

List<Dependency> dependencies()

Returns:

the list of deployment dependencies

templateHash

String templateHash()

Returns:

the hash produced for the template

templateLink

TemplateLink templateLink()

Returns:

the URI referencing the template

parameters

Object parameters()

Returns:

the deployment parameters

parametersLink

ParametersLink parametersLink()

Returns:

the URI referencing the parameters

mode

DeploymentMode mode()

Returns:

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

error

com.azure.core.management.exception.ManagementError error()

Returns:

the ManagementError, if deployment fails.

outputResources

List<ResourceReference> outputResources()

Get array of provisioned resources.

Returns:

the outputResources value

deploymentOperations

DeploymentOperations deploymentOperations()

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.