Deployments Interface

public interface Deployments

Resource collection API of Deployments.

Method Summary

Modifier and Type Method and Description
abstract TemplateHashResult calculateTemplateHash(BinaryData template)

Calculate the hash of the given template.

abstract Response<TemplateHashResult> calculateTemplateHashWithResponse(BinaryData template, Context context)

Calculate the hash of the given template.

abstract void cancel(String resourceGroupName, String deploymentName)

Cancels a currently running template deployment.

abstract void cancelAtManagementGroupScope(String groupId, String deploymentName)

Cancels a currently running template deployment.

abstract Response<Void> cancelAtManagementGroupScopeWithResponse(String groupId, String deploymentName, Context context)

Cancels a currently running template deployment.

abstract void cancelAtScope(String scope, String deploymentName)

Cancels a currently running template deployment.

abstract Response<Void> cancelAtScopeWithResponse(String scope, String deploymentName, Context context)

Cancels a currently running template deployment.

abstract void cancelAtSubscriptionScope(String deploymentName)

Cancels a currently running template deployment.

abstract Response<Void> cancelAtSubscriptionScopeWithResponse(String deploymentName, Context context)

Cancels a currently running template deployment.

abstract void cancelAtTenantScope(String deploymentName)

Cancels a currently running template deployment.

abstract Response<Void> cancelAtTenantScopeWithResponse(String deploymentName, Context context)

Cancels a currently running template deployment.

abstract Response<Void> cancelWithResponse(String resourceGroupName, String deploymentName, Context context)

Cancels a currently running template deployment.

abstract boolean checkExistence(String resourceGroupName, String deploymentName)

Checks whether the deployment exists.

abstract boolean checkExistenceAtManagementGroupScope(String groupId, String deploymentName)

Checks whether the deployment exists.

abstract Response<Boolean> checkExistenceAtManagementGroupScopeWithResponse(String groupId, String deploymentName, Context context)

Checks whether the deployment exists.

abstract boolean checkExistenceAtScope(String scope, String deploymentName)

Checks whether the deployment exists.

abstract Response<Boolean> checkExistenceAtScopeWithResponse(String scope, String deploymentName, Context context)

Checks whether the deployment exists.

abstract boolean checkExistenceAtSubscriptionScope(String deploymentName)

Checks whether the deployment exists.

abstract Response<Boolean> checkExistenceAtSubscriptionScopeWithResponse(String deploymentName, Context context)

Checks whether the deployment exists.

abstract boolean checkExistenceAtTenantScope(String deploymentName)

Checks whether the deployment exists.

abstract Response<Boolean> checkExistenceAtTenantScopeWithResponse(String deploymentName, Context context)

Checks whether the deployment exists.

abstract Response<Boolean> checkExistenceWithResponse(String resourceGroupName, String deploymentName, Context context)

Checks whether the deployment exists.

abstract DeploymentExtended createOrUpdateAtManagementGroupScope(String groupId, String deploymentName, ScopedDeployment parameters)

Deploys resources at management group scope.

abstract DeploymentExtended createOrUpdateAtManagementGroupScope(String groupId, String deploymentName, ScopedDeployment parameters, Context context)

Deploys resources at management group scope.

abstract DeploymentExtended createOrUpdateAtScope(String scope, String deploymentName, Deployment parameters)

Deploys resources at a given scope.

abstract DeploymentExtended createOrUpdateAtScope(String scope, String deploymentName, Deployment parameters, Context context)

Deploys resources at a given scope.

abstract DeploymentExtended createOrUpdateAtSubscriptionScope(String deploymentName, Deployment parameters)

Deploys resources at subscription scope.

abstract DeploymentExtended createOrUpdateAtSubscriptionScope(String deploymentName, Deployment parameters, Context context)

Deploys resources at subscription scope.

abstract DeploymentExtended createOrUpdateAtTenantScope(String deploymentName, ScopedDeployment parameters)

Deploys resources at tenant scope.

abstract DeploymentExtended createOrUpdateAtTenantScope(String deploymentName, ScopedDeployment parameters, Context context)

Deploys resources at tenant scope.

abstract Blank define(String name)

Begins definition for a new DeploymentExtended resource.

abstract void delete(String resourceGroupName, String deploymentName, Context context)

Deletes a deployment from the deployment history.

abstract void deleteAtManagementGroupScope(String groupId, String deploymentName)

Deletes a deployment from the deployment history.

abstract void deleteAtManagementGroupScope(String groupId, String deploymentName, Context context)

Deletes a deployment from the deployment history.

abstract void deleteAtScope(String scope, String deploymentName)

Deletes a deployment from the deployment history.

abstract void deleteAtScope(String scope, String deploymentName, Context context)

Deletes a deployment from the deployment history.

abstract void deleteAtSubscriptionScope(String deploymentName)

Deletes a deployment from the deployment history.

abstract void deleteAtSubscriptionScope(String deploymentName, Context context)

Deletes a deployment from the deployment history.

abstract void deleteAtTenantScope(String deploymentName)

Deletes a deployment from the deployment history.

abstract void deleteAtTenantScope(String deploymentName, Context context)

Deletes a deployment from the deployment history.

abstract void deleteById(String id)

Deletes a deployment from the deployment history.

abstract void deleteByIdWithResponse(String id, Context context)

Deletes a deployment from the deployment history.

abstract void deleteByResourceGroup(String resourceGroupName, String deploymentName)

Deletes a deployment from the deployment history.

abstract DeploymentExportResult exportTemplate(String resourceGroupName, String deploymentName)

Exports the template used for specified deployment.

abstract DeploymentExportResult exportTemplateAtManagementGroupScope(String groupId, String deploymentName)

Exports the template used for specified deployment.

abstract Response<DeploymentExportResult> exportTemplateAtManagementGroupScopeWithResponse(String groupId, String deploymentName, Context context)

Exports the template used for specified deployment.

abstract DeploymentExportResult exportTemplateAtScope(String scope, String deploymentName)

Exports the template used for specified deployment.

abstract Response<DeploymentExportResult> exportTemplateAtScopeWithResponse(String scope, String deploymentName, Context context)

Exports the template used for specified deployment.

abstract DeploymentExportResult exportTemplateAtSubscriptionScope(String deploymentName)

Exports the template used for specified deployment.

abstract Response<DeploymentExportResult> exportTemplateAtSubscriptionScopeWithResponse(String deploymentName, Context context)

Exports the template used for specified deployment.

abstract DeploymentExportResult exportTemplateAtTenantScope(String deploymentName)

Exports the template used for specified deployment.

abstract Response<DeploymentExportResult> exportTemplateAtTenantScopeWithResponse(String deploymentName, Context context)

Exports the template used for specified deployment.

abstract Response<DeploymentExportResult> exportTemplateWithResponse(String resourceGroupName, String deploymentName, Context context)

Exports the template used for specified deployment.

abstract DeploymentExtended getAtManagementGroupScope(String groupId, String deploymentName)

Gets a deployment.

abstract Response<DeploymentExtended> getAtManagementGroupScopeWithResponse(String groupId, String deploymentName, Context context)

Gets a deployment.

abstract DeploymentExtended getAtScope(String scope, String deploymentName)

Gets a deployment.

abstract Response<DeploymentExtended> getAtScopeWithResponse(String scope, String deploymentName, Context context)

Gets a deployment.

abstract DeploymentExtended getAtSubscriptionScope(String deploymentName)

Gets a deployment.

abstract Response<DeploymentExtended> getAtSubscriptionScopeWithResponse(String deploymentName, Context context)

Gets a deployment.

abstract DeploymentExtended getAtTenantScope(String deploymentName)

Gets a deployment.

abstract Response<DeploymentExtended> getAtTenantScopeWithResponse(String deploymentName, Context context)

Gets a deployment.

abstract DeploymentExtended getById(String id)

Gets a deployment.

abstract Response<DeploymentExtended> getByIdWithResponse(String id, Context context)

Gets a deployment.

abstract DeploymentExtended getByResourceGroup(String resourceGroupName, String deploymentName)

Gets a deployment.

abstract Response<DeploymentExtended> getByResourceGroupWithResponse(String resourceGroupName, String deploymentName, Context context)

Gets a deployment.

abstract PagedIterable<DeploymentExtended> list()

Get all the deployments for a subscription.

abstract PagedIterable<DeploymentExtended> list(String filter, Integer top, Context context)

Get all the deployments for a subscription.

abstract PagedIterable<DeploymentExtended> listAtManagementGroupScope(String groupId)

Get all the deployments for a management group.

abstract PagedIterable<DeploymentExtended> listAtManagementGroupScope(String groupId, String filter, Integer top, Context context)

Get all the deployments for a management group.

abstract PagedIterable<DeploymentExtended> listAtScope(String scope)

Get all the deployments at the given scope.

abstract PagedIterable<DeploymentExtended> listAtScope(String scope, String filter, Integer top, Context context)

Get all the deployments at the given scope.

abstract PagedIterable<DeploymentExtended> listAtTenantScope()

Get all the deployments at the tenant scope.

abstract PagedIterable<DeploymentExtended> listAtTenantScope(String filter, Integer top, Context context)

Get all the deployments at the tenant scope.

abstract PagedIterable<DeploymentExtended> listByResourceGroup(String resourceGroupName)

Get all the deployments for a resource group.

abstract PagedIterable<DeploymentExtended> listByResourceGroup(String resourceGroupName, String filter, Integer top, Context context)

Get all the deployments for a resource group.

abstract DeploymentValidateResult validate(String resourceGroupName, String deploymentName, Deployment parameters)

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

abstract DeploymentValidateResult validate(String resourceGroupName, String deploymentName, Deployment parameters, Context context)

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

abstract DeploymentValidateResult validateAtManagementGroupScope(String groupId, String deploymentName, ScopedDeployment parameters)

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

abstract DeploymentValidateResult validateAtManagementGroupScope(String groupId, String deploymentName, ScopedDeployment parameters, Context context)

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

abstract DeploymentValidateResult validateAtScope(String scope, String deploymentName, Deployment parameters)

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

abstract DeploymentValidateResult validateAtScope(String scope, String deploymentName, Deployment parameters, Context context)

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

abstract DeploymentValidateResult validateAtSubscriptionScope(String deploymentName, Deployment parameters)

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

abstract DeploymentValidateResult validateAtSubscriptionScope(String deploymentName, Deployment parameters, Context context)

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

abstract DeploymentValidateResult validateAtTenantScope(String deploymentName, ScopedDeployment parameters)

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

abstract DeploymentValidateResult validateAtTenantScope(String deploymentName, ScopedDeployment parameters, Context context)

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

abstract WhatIfOperationResult whatIf(String resourceGroupName, String deploymentName, DeploymentWhatIf parameters)

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

abstract WhatIfOperationResult whatIf(String resourceGroupName, String deploymentName, DeploymentWhatIf parameters, Context context)

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

abstract WhatIfOperationResult whatIfAtManagementGroupScope(String groupId, String deploymentName, ScopedDeploymentWhatIf parameters)

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

abstract WhatIfOperationResult whatIfAtManagementGroupScope(String groupId, String deploymentName, ScopedDeploymentWhatIf parameters, Context context)

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

abstract WhatIfOperationResult whatIfAtSubscriptionScope(String deploymentName, DeploymentWhatIf parameters)

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

abstract WhatIfOperationResult whatIfAtSubscriptionScope(String deploymentName, DeploymentWhatIf parameters, Context context)

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

abstract WhatIfOperationResult whatIfAtTenantScope(String deploymentName, ScopedDeploymentWhatIf parameters)

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

abstract WhatIfOperationResult whatIfAtTenantScope(String deploymentName, ScopedDeploymentWhatIf parameters, Context context)

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

Method Details

calculateTemplateHash

public abstract TemplateHashResult calculateTemplateHash(BinaryData template)

Calculate the hash of the given template.

Parameters:

template - The request body.

Returns:

result of the request to calculate template hash.

calculateTemplateHashWithResponse

public abstract Response<TemplateHashResult> calculateTemplateHashWithResponse(BinaryData template, Context context)

Calculate the hash of the given template.

Parameters:

template - The request body.
context - The context to associate with this operation.

Returns:

result of the request to calculate template hash along with Response<T>.

cancel

public abstract void cancel(String resourceGroupName, String deploymentName)

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:

resourceGroupName - The name of the resource group.
deploymentName - The name of the deployment.

cancelAtManagementGroupScope

public abstract void cancelAtManagementGroupScope(String groupId, String deploymentName)

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 resources partially deployed.

Parameters:

groupId - The management group ID.
deploymentName - The name of the deployment.

cancelAtManagementGroupScopeWithResponse

public abstract Response<Void> cancelAtManagementGroupScopeWithResponse(String groupId, String deploymentName, 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 resources partially deployed.

Parameters:

groupId - The management group ID.
deploymentName - The name of the deployment.
context - The context to associate with this operation.

Returns:

cancelAtScope

public abstract void cancelAtScope(String scope, String deploymentName)

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 resources partially deployed.

Parameters:

scope - The fully qualified Azure Resource manager identifier of the resource.
deploymentName - The name of the deployment.

cancelAtScopeWithResponse

public abstract Response<Void> cancelAtScopeWithResponse(String scope, String deploymentName, 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 resources partially deployed.

Parameters:

scope - The fully qualified Azure Resource manager identifier of the resource.
deploymentName - The name of the deployment.
context - The context to associate with this operation.

Returns:

cancelAtSubscriptionScope

public abstract void cancelAtSubscriptionScope(String deploymentName)

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 resources partially deployed.

Parameters:

deploymentName - The name of the deployment.

cancelAtSubscriptionScopeWithResponse

public abstract Response<Void> cancelAtSubscriptionScopeWithResponse(String deploymentName, 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 resources partially deployed.

Parameters:

deploymentName - The name of the deployment.
context - The context to associate with this operation.

Returns:

cancelAtTenantScope

public abstract void cancelAtTenantScope(String deploymentName)

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 resources partially deployed.

Parameters:

deploymentName - The name of the deployment.

cancelAtTenantScopeWithResponse

public abstract Response<Void> cancelAtTenantScopeWithResponse(String deploymentName, 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 resources partially deployed.

Parameters:

deploymentName - The name of the deployment.
context - The context to associate with this operation.

Returns:

cancelWithResponse

public abstract Response<Void> cancelWithResponse(String resourceGroupName, String deploymentName, 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:

resourceGroupName - The name of the resource group.
deploymentName - The name of the deployment.
context - The context to associate with this operation.

Returns:

checkExistence

public abstract boolean checkExistence(String resourceGroupName, String deploymentName)

Checks whether the deployment exists.

Parameters:

resourceGroupName - The name of the resource group.
deploymentName - The name of the deployment.

Returns:

whether resource exists.

checkExistenceAtManagementGroupScope

public abstract boolean checkExistenceAtManagementGroupScope(String groupId, String deploymentName)

Checks whether the deployment exists.

Parameters:

groupId - The management group ID.
deploymentName - The name of the deployment.

Returns:

whether resource exists.

checkExistenceAtManagementGroupScopeWithResponse

public abstract Response<Boolean> checkExistenceAtManagementGroupScopeWithResponse(String groupId, String deploymentName, Context context)

Checks whether the deployment exists.

Parameters:

groupId - The management group ID.
deploymentName - The name of the deployment.
context - The context to associate with this operation.

Returns:

whether resource exists along with Response<T>.

checkExistenceAtScope

public abstract boolean checkExistenceAtScope(String scope, String deploymentName)

Checks whether the deployment exists.

Parameters:

scope - The fully qualified Azure Resource manager identifier of the resource.
deploymentName - The name of the deployment.

Returns:

whether resource exists.

checkExistenceAtScopeWithResponse

public abstract Response<Boolean> checkExistenceAtScopeWithResponse(String scope, String deploymentName, Context context)

Checks whether the deployment exists.

Parameters:

scope - The fully qualified Azure Resource manager identifier of the resource.
deploymentName - The name of the deployment.
context - The context to associate with this operation.

Returns:

whether resource exists along with Response<T>.

checkExistenceAtSubscriptionScope

public abstract boolean checkExistenceAtSubscriptionScope(String deploymentName)

Checks whether the deployment exists.

Parameters:

deploymentName - The name of the deployment.

Returns:

whether resource exists.

checkExistenceAtSubscriptionScopeWithResponse

public abstract Response<Boolean> checkExistenceAtSubscriptionScopeWithResponse(String deploymentName, Context context)

Checks whether the deployment exists.

Parameters:

deploymentName - The name of the deployment.
context - The context to associate with this operation.

Returns:

whether resource exists along with Response<T>.

checkExistenceAtTenantScope

public abstract boolean checkExistenceAtTenantScope(String deploymentName)

Checks whether the deployment exists.

Parameters:

deploymentName - The name of the deployment.

Returns:

whether resource exists.

checkExistenceAtTenantScopeWithResponse

public abstract Response<Boolean> checkExistenceAtTenantScopeWithResponse(String deploymentName, Context context)

Checks whether the deployment exists.

Parameters:

deploymentName - The name of the deployment.
context - The context to associate with this operation.

Returns:

whether resource exists along with Response<T>.

checkExistenceWithResponse

public abstract Response<Boolean> checkExistenceWithResponse(String resourceGroupName, String deploymentName, Context context)

Checks whether the deployment exists.

Parameters:

resourceGroupName - The name of the resource group.
deploymentName - The name of the deployment.
context - The context to associate with this operation.

Returns:

whether resource exists along with Response<T>.

createOrUpdateAtManagementGroupScope

public abstract DeploymentExtended createOrUpdateAtManagementGroupScope(String groupId, String deploymentName, ScopedDeployment parameters)

Deploys resources at management group scope. You can provide the template and parameters directly in the request or link to JSON files.

Parameters:

groupId - The management group ID.
deploymentName - The name of the deployment.
parameters - Additional parameters supplied to the operation.

Returns:

deployment information.

createOrUpdateAtManagementGroupScope

public abstract DeploymentExtended createOrUpdateAtManagementGroupScope(String groupId, String deploymentName, ScopedDeployment parameters, Context context)

Deploys resources at management group scope. You can provide the template and parameters directly in the request or link to JSON files.

Parameters:

groupId - The management group ID.
deploymentName - The name of the deployment.
parameters - Additional parameters supplied to the operation.
context - The context to associate with this operation.

Returns:

deployment information.

createOrUpdateAtScope

public abstract DeploymentExtended createOrUpdateAtScope(String scope, String deploymentName, Deployment parameters)

Deploys resources at a given scope. You can provide the template and parameters directly in the request or link to JSON files.

Parameters:

scope - The fully qualified Azure Resource manager identifier of the resource.
deploymentName - The name of the deployment.
parameters - Additional parameters supplied to the operation.

Returns:

deployment information.

createOrUpdateAtScope

public abstract DeploymentExtended createOrUpdateAtScope(String scope, String deploymentName, Deployment parameters, Context context)

Deploys resources at a given scope. You can provide the template and parameters directly in the request or link to JSON files.

Parameters:

scope - The fully qualified Azure Resource manager identifier of the resource.
deploymentName - The name of the deployment.
parameters - Additional parameters supplied to the operation.
context - The context to associate with this operation.

Returns:

deployment information.

createOrUpdateAtSubscriptionScope

public abstract DeploymentExtended createOrUpdateAtSubscriptionScope(String deploymentName, Deployment parameters)

Deploys resources at subscription scope. You can provide the template and parameters directly in the request or link to JSON files.

Parameters:

deploymentName - The name of the deployment.
parameters - Additional parameters supplied to the operation.

Returns:

deployment information.

createOrUpdateAtSubscriptionScope

public abstract DeploymentExtended createOrUpdateAtSubscriptionScope(String deploymentName, Deployment parameters, Context context)

Deploys resources at subscription scope. You can provide the template and parameters directly in the request or link to JSON files.

Parameters:

deploymentName - The name of the deployment.
parameters - Additional parameters supplied to the operation.
context - The context to associate with this operation.

Returns:

deployment information.

createOrUpdateAtTenantScope

public abstract DeploymentExtended createOrUpdateAtTenantScope(String deploymentName, ScopedDeployment parameters)

Deploys resources at tenant scope. You can provide the template and parameters directly in the request or link to JSON files.

Parameters:

deploymentName - The name of the deployment.
parameters - Additional parameters supplied to the operation.

Returns:

deployment information.

createOrUpdateAtTenantScope

public abstract DeploymentExtended createOrUpdateAtTenantScope(String deploymentName, ScopedDeployment parameters, Context context)

Deploys resources at tenant scope. You can provide the template and parameters directly in the request or link to JSON files.

Parameters:

deploymentName - The name of the deployment.
parameters - Additional parameters supplied to the operation.
context - The context to associate with this operation.

Returns:

deployment information.

define

public abstract DeploymentExtended.DefinitionStages.Blank define(String name)

Begins definition for a new DeploymentExtended resource.

Parameters:

name - resource name.

Returns:

the first stage of the new DeploymentExtended definition.

delete

public abstract void delete(String resourceGroupName, String deploymentName, Context context)

Deletes a deployment from the deployment history. A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.

Parameters:

resourceGroupName - The name of the resource group.
deploymentName - The name of the deployment.
context - The context to associate with this operation.

deleteAtManagementGroupScope

public abstract void deleteAtManagementGroupScope(String groupId, String deploymentName)

Deletes a deployment from the deployment history. A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.

Parameters:

groupId - The management group ID.
deploymentName - The name of the deployment.

deleteAtManagementGroupScope

public abstract void deleteAtManagementGroupScope(String groupId, String deploymentName, Context context)

Deletes a deployment from the deployment history. A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.

Parameters:

groupId - The management group ID.
deploymentName - The name of the deployment.
context - The context to associate with this operation.

deleteAtScope

public abstract void deleteAtScope(String scope, String deploymentName)

Deletes a deployment from the deployment history. A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.

Parameters:

scope - The fully qualified Azure Resource manager identifier of the resource.
deploymentName - The name of the deployment.

deleteAtScope

public abstract void deleteAtScope(String scope, String deploymentName, Context context)

Deletes a deployment from the deployment history. A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.

Parameters:

scope - The fully qualified Azure Resource manager identifier of the resource.
deploymentName - The name of the deployment.
context - The context to associate with this operation.

deleteAtSubscriptionScope

public abstract void deleteAtSubscriptionScope(String deploymentName)

Deletes a deployment from the deployment history. A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.

Parameters:

deploymentName - The name of the deployment.

deleteAtSubscriptionScope

public abstract void deleteAtSubscriptionScope(String deploymentName, Context context)

Deletes a deployment from the deployment history. A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.

Parameters:

deploymentName - The name of the deployment.
context - The context to associate with this operation.

deleteAtTenantScope

public abstract void deleteAtTenantScope(String deploymentName)

Deletes a deployment from the deployment history. A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.

Parameters:

deploymentName - The name of the deployment.

deleteAtTenantScope

public abstract void deleteAtTenantScope(String deploymentName, Context context)

Deletes a deployment from the deployment history. A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.

Parameters:

deploymentName - The name of the deployment.
context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Deletes a deployment from the deployment history. A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Deletes a deployment from the deployment history. A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

deleteByResourceGroup

public abstract void deleteByResourceGroup(String resourceGroupName, String deploymentName)

Deletes a deployment from the deployment history. A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.

Parameters:

resourceGroupName - The name of the resource group.
deploymentName - The name of the deployment.

exportTemplate

public abstract DeploymentExportResult exportTemplate(String resourceGroupName, String deploymentName)

Exports the template used for specified deployment.

Parameters:

resourceGroupName - The name of the resource group.
deploymentName - The name of the deployment.

Returns:

the deployment export result.

exportTemplateAtManagementGroupScope

public abstract DeploymentExportResult exportTemplateAtManagementGroupScope(String groupId, String deploymentName)

Exports the template used for specified deployment.

Parameters:

groupId - The management group ID.
deploymentName - The name of the deployment.

Returns:

the deployment export result.

exportTemplateAtManagementGroupScopeWithResponse

public abstract Response<DeploymentExportResult> exportTemplateAtManagementGroupScopeWithResponse(String groupId, String deploymentName, Context context)

Exports the template used for specified deployment.

Parameters:

groupId - The management group ID.
deploymentName - The name of the deployment.
context - The context to associate with this operation.

Returns:

the deployment export result along with Response<T>.

exportTemplateAtScope

public abstract DeploymentExportResult exportTemplateAtScope(String scope, String deploymentName)

Exports the template used for specified deployment.

Parameters:

scope - The fully qualified Azure Resource manager identifier of the resource.
deploymentName - The name of the deployment.

Returns:

the deployment export result.

exportTemplateAtScopeWithResponse

public abstract Response<DeploymentExportResult> exportTemplateAtScopeWithResponse(String scope, String deploymentName, Context context)

Exports the template used for specified deployment.

Parameters:

scope - The fully qualified Azure Resource manager identifier of the resource.
deploymentName - The name of the deployment.
context - The context to associate with this operation.

Returns:

the deployment export result along with Response<T>.

exportTemplateAtSubscriptionScope

public abstract DeploymentExportResult exportTemplateAtSubscriptionScope(String deploymentName)

Exports the template used for specified deployment.

Parameters:

deploymentName - The name of the deployment.

Returns:

the deployment export result.

exportTemplateAtSubscriptionScopeWithResponse

public abstract Response<DeploymentExportResult> exportTemplateAtSubscriptionScopeWithResponse(String deploymentName, Context context)

Exports the template used for specified deployment.

Parameters:

deploymentName - The name of the deployment.
context - The context to associate with this operation.

Returns:

the deployment export result along with Response<T>.

exportTemplateAtTenantScope

public abstract DeploymentExportResult exportTemplateAtTenantScope(String deploymentName)

Exports the template used for specified deployment.

Parameters:

deploymentName - The name of the deployment.

Returns:

the deployment export result.

exportTemplateAtTenantScopeWithResponse

public abstract Response<DeploymentExportResult> exportTemplateAtTenantScopeWithResponse(String deploymentName, Context context)

Exports the template used for specified deployment.

Parameters:

deploymentName - The name of the deployment.
context - The context to associate with this operation.

Returns:

the deployment export result along with Response<T>.

exportTemplateWithResponse

public abstract Response<DeploymentExportResult> exportTemplateWithResponse(String resourceGroupName, String deploymentName, Context context)

Exports the template used for specified deployment.

Parameters:

resourceGroupName - The name of the resource group.
deploymentName - The name of the deployment.
context - The context to associate with this operation.

Returns:

the deployment export result along with Response<T>.

getAtManagementGroupScope

public abstract DeploymentExtended getAtManagementGroupScope(String groupId, String deploymentName)

Gets a deployment.

Parameters:

groupId - The management group ID.
deploymentName - The name of the deployment.

Returns:

a deployment.

getAtManagementGroupScopeWithResponse

public abstract Response<DeploymentExtended> getAtManagementGroupScopeWithResponse(String groupId, String deploymentName, Context context)

Gets a deployment.

Parameters:

groupId - The management group ID.
deploymentName - The name of the deployment.
context - The context to associate with this operation.

Returns:

a deployment along with Response<T>.

getAtScope

public abstract DeploymentExtended getAtScope(String scope, String deploymentName)

Gets a deployment.

Parameters:

scope - The fully qualified Azure Resource manager identifier of the resource.
deploymentName - The name of the deployment.

Returns:

a deployment.

getAtScopeWithResponse

public abstract Response<DeploymentExtended> getAtScopeWithResponse(String scope, String deploymentName, Context context)

Gets a deployment.

Parameters:

scope - The fully qualified Azure Resource manager identifier of the resource.
deploymentName - The name of the deployment.
context - The context to associate with this operation.

Returns:

a deployment along with Response<T>.

getAtSubscriptionScope

public abstract DeploymentExtended getAtSubscriptionScope(String deploymentName)

Gets a deployment.

Parameters:

deploymentName - The name of the deployment.

Returns:

a deployment.

getAtSubscriptionScopeWithResponse

public abstract Response<DeploymentExtended> getAtSubscriptionScopeWithResponse(String deploymentName, Context context)

Gets a deployment.

Parameters:

deploymentName - The name of the deployment.
context - The context to associate with this operation.

Returns:

a deployment along with Response<T>.

getAtTenantScope

public abstract DeploymentExtended getAtTenantScope(String deploymentName)

Gets a deployment.

Parameters:

deploymentName - The name of the deployment.

Returns:

a deployment.

getAtTenantScopeWithResponse

public abstract Response<DeploymentExtended> getAtTenantScopeWithResponse(String deploymentName, Context context)

Gets a deployment.

Parameters:

deploymentName - The name of the deployment.
context - The context to associate with this operation.

Returns:

a deployment along with Response<T>.

getById

public abstract DeploymentExtended getById(String id)

Gets a deployment.

Parameters:

id - the resource ID.

Returns:

a deployment along with Response<T>.

getByIdWithResponse

public abstract Response<DeploymentExtended> getByIdWithResponse(String id, Context context)

Gets a deployment.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

a deployment along with Response<T>.

getByResourceGroup

public abstract DeploymentExtended getByResourceGroup(String resourceGroupName, String deploymentName)

Gets a deployment.

Parameters:

resourceGroupName - The name of the resource group.
deploymentName - The name of the deployment.

Returns:

a deployment.

getByResourceGroupWithResponse

public abstract Response<DeploymentExtended> getByResourceGroupWithResponse(String resourceGroupName, String deploymentName, Context context)

Gets a deployment.

Parameters:

resourceGroupName - The name of the resource group.
deploymentName - The name of the deployment.
context - The context to associate with this operation.

Returns:

a deployment along with Response<T>.

list

public abstract PagedIterable<DeploymentExtended> list()

Get all the deployments for a subscription.

Returns:

all the deployments for a subscription as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<DeploymentExtended> list(String filter, Integer top, Context context)

Get all the deployments for a subscription.

Parameters:

filter - The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.
top - The number of results to get. If null is passed, returns all deployments.
context - The context to associate with this operation.

Returns:

all the deployments for a subscription as paginated response with PagedIterable<T>.

listAtManagementGroupScope

public abstract PagedIterable<DeploymentExtended> listAtManagementGroupScope(String groupId)

Get all the deployments for a management group.

Parameters:

groupId - The management group ID.

Returns:

all the deployments for a management group as paginated response with PagedIterable<T>.

listAtManagementGroupScope

public abstract PagedIterable<DeploymentExtended> listAtManagementGroupScope(String groupId, String filter, Integer top, Context context)

Get all the deployments for a management group.

Parameters:

groupId - The management group ID.
filter - The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.
top - The number of results to get. If null is passed, returns all deployments.
context - The context to associate with this operation.

Returns:

all the deployments for a management group as paginated response with PagedIterable<T>.

listAtScope

public abstract PagedIterable<DeploymentExtended> listAtScope(String scope)

Get all the deployments at the given scope.

Parameters:

scope - The fully qualified Azure Resource manager identifier of the resource.

Returns:

all the deployments at the given scope as paginated response with PagedIterable<T>.

listAtScope

public abstract PagedIterable<DeploymentExtended> listAtScope(String scope, String filter, Integer top, Context context)

Get all the deployments at the given scope.

Parameters:

scope - The fully qualified Azure Resource manager identifier of the resource.
filter - The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.
top - The number of results to get. If null is passed, returns all deployments.
context - The context to associate with this operation.

Returns:

all the deployments at the given scope as paginated response with PagedIterable<T>.

listAtTenantScope

public abstract PagedIterable<DeploymentExtended> listAtTenantScope()

Get all the deployments at the tenant scope.

Returns:

all the deployments at the tenant scope as paginated response with PagedIterable<T>.

listAtTenantScope

public abstract PagedIterable<DeploymentExtended> listAtTenantScope(String filter, Integer top, Context context)

Get all the deployments at the tenant scope.

Parameters:

filter - The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.
top - The number of results to get. If null is passed, returns all deployments.
context - The context to associate with this operation.

Returns:

all the deployments at the tenant scope as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<DeploymentExtended> listByResourceGroup(String resourceGroupName)

Get all the deployments for a resource group.

Parameters:

resourceGroupName - The name of the resource group.

Returns:

all the deployments for a resource group as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<DeploymentExtended> listByResourceGroup(String resourceGroupName, String filter, Integer top, Context context)

Get all the deployments for a resource group.

Parameters:

resourceGroupName - The name of the resource group.
filter - The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.
top - The number of results to get. If null is passed, returns all deployments.
context - The context to associate with this operation.

Returns:

all the deployments for a resource group as paginated response with PagedIterable<T>.

validate

public abstract DeploymentValidateResult validate(String resourceGroupName, String deploymentName, Deployment parameters)

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

Parameters:

resourceGroupName - The name of the resource group.
deploymentName - The name of the deployment.
parameters - Parameters to validate.

Returns:

information from validate template deployment response.

validate

public abstract DeploymentValidateResult validate(String resourceGroupName, String deploymentName, Deployment parameters, Context context)

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

Parameters:

resourceGroupName - The name of the resource group.
deploymentName - The name of the deployment.
parameters - Parameters to validate.
context - The context to associate with this operation.

Returns:

information from validate template deployment response.

validateAtManagementGroupScope

public abstract DeploymentValidateResult validateAtManagementGroupScope(String groupId, String deploymentName, ScopedDeployment parameters)

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

Parameters:

groupId - The management group ID.
deploymentName - The name of the deployment.
parameters - Parameters to validate.

Returns:

information from validate template deployment response.

validateAtManagementGroupScope

public abstract DeploymentValidateResult validateAtManagementGroupScope(String groupId, String deploymentName, ScopedDeployment parameters, Context context)

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

Parameters:

groupId - The management group ID.
deploymentName - The name of the deployment.
parameters - Parameters to validate.
context - The context to associate with this operation.

Returns:

information from validate template deployment response.

validateAtScope

public abstract DeploymentValidateResult validateAtScope(String scope, String deploymentName, Deployment parameters)

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

Parameters:

scope - The fully qualified Azure Resource manager identifier of the resource.
deploymentName - The name of the deployment.
parameters - Parameters to validate.

Returns:

information from validate template deployment response.

validateAtScope

public abstract DeploymentValidateResult validateAtScope(String scope, String deploymentName, Deployment parameters, Context context)

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

Parameters:

scope - The fully qualified Azure Resource manager identifier of the resource.
deploymentName - The name of the deployment.
parameters - Parameters to validate.
context - The context to associate with this operation.

Returns:

information from validate template deployment response.

validateAtSubscriptionScope

public abstract DeploymentValidateResult validateAtSubscriptionScope(String deploymentName, Deployment parameters)

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

Parameters:

deploymentName - The name of the deployment.
parameters - Parameters to validate.

Returns:

information from validate template deployment response.

validateAtSubscriptionScope

public abstract DeploymentValidateResult validateAtSubscriptionScope(String deploymentName, Deployment parameters, Context context)

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

Parameters:

deploymentName - The name of the deployment.
parameters - Parameters to validate.
context - The context to associate with this operation.

Returns:

information from validate template deployment response.

validateAtTenantScope

public abstract DeploymentValidateResult validateAtTenantScope(String deploymentName, ScopedDeployment parameters)

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

Parameters:

deploymentName - The name of the deployment.
parameters - Parameters to validate.

Returns:

information from validate template deployment response.

validateAtTenantScope

public abstract DeploymentValidateResult validateAtTenantScope(String deploymentName, ScopedDeployment parameters, Context context)

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

Parameters:

deploymentName - The name of the deployment.
parameters - Parameters to validate.
context - The context to associate with this operation.

Returns:

information from validate template deployment response.

whatIf

public abstract WhatIfOperationResult whatIf(String resourceGroupName, String deploymentName, DeploymentWhatIf parameters)

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

Parameters:

resourceGroupName - The name of the resource group.
deploymentName - The name of the deployment.
parameters - Parameters to validate.

Returns:

result of the What-If operation.

whatIf

public abstract WhatIfOperationResult whatIf(String resourceGroupName, String deploymentName, DeploymentWhatIf parameters, Context context)

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

Parameters:

resourceGroupName - The name of the resource group.
deploymentName - The name of the deployment.
parameters - Parameters to validate.
context - The context to associate with this operation.

Returns:

result of the What-If operation.

whatIfAtManagementGroupScope

public abstract WhatIfOperationResult whatIfAtManagementGroupScope(String groupId, String deploymentName, ScopedDeploymentWhatIf parameters)

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

Parameters:

groupId - The management group ID.
deploymentName - The name of the deployment.
parameters - Parameters to validate.

Returns:

result of the What-If operation.

whatIfAtManagementGroupScope

public abstract WhatIfOperationResult whatIfAtManagementGroupScope(String groupId, String deploymentName, ScopedDeploymentWhatIf parameters, Context context)

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

Parameters:

groupId - The management group ID.
deploymentName - The name of the deployment.
parameters - Parameters to validate.
context - The context to associate with this operation.

Returns:

result of the What-If operation.

whatIfAtSubscriptionScope

public abstract WhatIfOperationResult whatIfAtSubscriptionScope(String deploymentName, DeploymentWhatIf parameters)

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

Parameters:

deploymentName - The name of the deployment.
parameters - Parameters to What If.

Returns:

result of the What-If operation.

whatIfAtSubscriptionScope

public abstract WhatIfOperationResult whatIfAtSubscriptionScope(String deploymentName, DeploymentWhatIf parameters, Context context)

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

Parameters:

deploymentName - The name of the deployment.
parameters - Parameters to What If.
context - The context to associate with this operation.

Returns:

result of the What-If operation.

whatIfAtTenantScope

public abstract WhatIfOperationResult whatIfAtTenantScope(String deploymentName, ScopedDeploymentWhatIf parameters)

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

Parameters:

deploymentName - The name of the deployment.
parameters - Parameters to validate.

Returns:

result of the What-If operation.

whatIfAtTenantScope

public abstract WhatIfOperationResult whatIfAtTenantScope(String deploymentName, ScopedDeploymentWhatIf parameters, Context context)

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

Parameters:

deploymentName - The name of the deployment.
parameters - Parameters to validate.
context - The context to associate with this operation.

Returns:

result of the What-If operation.

Applies to