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 Description static interfaceDeployment.DefinitionContainer interface for all the deployment definitions.static interfaceDeployment.DefinitionStagesGrouping of all the deployment definition stages.static interfaceDeployment.ExecutionContainer interface for all the deployment execution.static interfaceDeployment.ExecutionStagesGrouping of all the deployment execution stages.static interfaceDeployment.UpdateThe template for a deployment update operation, containing all the settings that can be modified.static interfaceDeployment.UpdateStagesGrouping of all the deployment updates stages.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidcancel()Cancel a currently running template deployment.Mono<Void>cancelAsync()Cancel a currently running template deployment asynchronously.StringcorrelationId()List<Dependency>dependencies()DeploymentOperationsdeploymentOperations()com.azure.core.management.exception.ManagementErrorerror()DeploymentExportResultexportTemplate()Exports a deployment template.Mono<DeploymentExportResult>exportTemplateAsync()Exports a deployment template asynchronously.DeploymentModemode()List<ResourceReference>outputResources()Get array of provisioned resources.Objectoutputs()Objectparameters()ParametersLinkparametersLink()Deployment.ExecutionprepareWhatIf()Prepares a What-if operation.List<Provider>providers()StringprovisioningState()StringresourceGroupName()StringtemplateHash()TemplateLinktemplateLink()OffsetDateTimetimestamp()-
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.model.Refreshable
refresh, refreshAsync
-
-
-
-
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.
-
-