DeploymentExtended Interface

Package:

com.azure.resourcemanager.resources.deployments.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-resources-deployments:1.0.0

public interface DeploymentExtended

An immutable client-side representation of DeploymentExtended.

Method Summary

Modifier and Type	Method and Description
abstract void	cancel() Cancels a currently running template deployment.
abstract Response<Void>	cancelWithResponse(Context context) Cancels a currently running template deployment.
abstract DeploymentExportResult	exportTemplate() Exports the template used for specified deployment.
abstract Response<DeploymentExportResult>	exportTemplateWithResponse(Context context) Exports the template used for specified deployment.
abstract String	id() Gets the id property: Fully qualified resource Id for the resource.
abstract DeploymentExtendedInner	innerModel() Gets the inner com.azure.resourcemanager.resources.deployments.fluent.models.DeploymentExtendedInner object.
abstract String	location() Gets the location property: the location of the deployment.
abstract String	name() Gets the name property: The name of the resource.
abstract DeploymentPropertiesExtended	properties() Gets the properties property: Deployment properties.
abstract DeploymentExtended	refresh() Refreshes the resource to sync with Azure.
abstract DeploymentExtended	refresh(Context context) Refreshes the resource to sync with Azure.
abstract Region	region() Gets the region of the resource.
abstract String	regionName() Gets the name of the resource region.
abstract String	resourceGroupName() Gets the name of the resource group.
abstract SystemData	systemData() Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
abstract Map<String,String>	tags() Gets the tags property: Deployment tags.
abstract String	type() Gets the type property: The type of the resource.
abstract Update	update() Begins update for the DeploymentExtended resource.
abstract DeploymentValidateResult	validate(Deployment parameters) Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
abstract DeploymentValidateResult	validate(Deployment parameters, Context context) Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
abstract WhatIfOperationResult	whatIf(DeploymentWhatIf parameters) Returns changes that will be made by the deployment if executed at the scope of the resource group.
abstract WhatIfOperationResult	whatIf(DeploymentWhatIf parameters, Context context) Returns changes that will be made by the deployment if executed at the scope of the resource group.

Method Details

cancel

public abstract void cancel()

Cancels a currently running template deployment. You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resource group partially deployed.

cancelWithResponse

public abstract Response<Void> cancelWithResponse(Context context)

Cancels a currently running template deployment. You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resource group partially deployed.

Parameters:

context - The context to associate with this operation.

Returns:

the Response<T>.

exportTemplate

public abstract DeploymentExportResult exportTemplate()

Exports the template used for specified deployment.

Returns:

the deployment export result.

exportTemplateWithResponse

public abstract Response<DeploymentExportResult> exportTemplateWithResponse(Context context)

Exports the template used for specified deployment.

Parameters:

context - The context to associate with this operation.

Returns:

the deployment export result along with Response<T>.

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

innerModel

public abstract DeploymentExtendedInner innerModel()

Gets the inner com.azure.resourcemanager.resources.deployments.fluent.models.DeploymentExtendedInner object.

Returns:

the inner object.

location

public abstract String location()

Gets the location property: the location of the deployment.

Returns:

the location value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

properties

public abstract DeploymentPropertiesExtended properties()

Gets the properties property: Deployment properties.

Returns:

the properties value.

refresh

public abstract DeploymentExtended refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract DeploymentExtended refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

region

public abstract Region region()

Gets the region of the resource.

Returns:

the region of the resource.

regionName

public abstract String regionName()

Gets the name of the resource region.

Returns:

the name of the resource region.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

systemData

public abstract SystemData systemData()

Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

tags

public abstract Map<String,String> tags()

Gets the tags property: Deployment tags.

Returns:

the tags value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract DeploymentExtended.Update update()

Begins update for the DeploymentExtended resource.

Returns:

the stage of resource update.

validate

public abstract DeploymentValidateResult validate(Deployment parameters)

Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..

Parameters:

parameters - Parameters to validate.

Returns:

information from validate template deployment response.

validate

public abstract DeploymentValidateResult validate(Deployment parameters, Context context)

Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..

Parameters:

parameters - Parameters to validate.

context - The context to associate with this operation.

Returns:

information from validate template deployment response.

whatIf

public abstract WhatIfOperationResult whatIf(DeploymentWhatIf parameters)

Returns changes that will be made by the deployment if executed at the scope of the resource group.

Parameters:

parameters - Parameters to validate.

Returns:

result of the What-If operation.

whatIf

public abstract WhatIfOperationResult whatIf(DeploymentWhatIf parameters, Context context)

Returns changes that will be made by the deployment if executed at the scope of the resource group.

Parameters:

parameters - Parameters to validate.

context - The context to associate with this operation.

Returns:

result of the What-If operation.