/*
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/
import { PagedAsyncIterableIterator } from "@azure/core-paging";
import { PollerLike, PollOperationState } from "@azure/core-lro";
import {
DeploymentExtended,
DeploymentsListAtScopeOptionalParams,
DeploymentsListAtTenantScopeOptionalParams,
DeploymentsListAtManagementGroupScopeOptionalParams,
DeploymentsListAtSubscriptionScopeOptionalParams,
DeploymentsListByResourceGroupOptionalParams,
DeploymentsDeleteAtScopeOptionalParams,
DeploymentsCheckExistenceAtScopeOptionalParams,
DeploymentsCheckExistenceAtScopeResponse,
Deployment,
DeploymentsCreateOrUpdateAtScopeOptionalParams,
DeploymentsCreateOrUpdateAtScopeResponse,
DeploymentsGetAtScopeOptionalParams,
DeploymentsGetAtScopeResponse,
DeploymentsCancelAtScopeOptionalParams,
DeploymentsValidateAtScopeOptionalParams,
DeploymentsValidateAtScopeResponse,
DeploymentsExportTemplateAtScopeOptionalParams,
DeploymentsExportTemplateAtScopeResponse,
DeploymentsDeleteAtTenantScopeOptionalParams,
DeploymentsCheckExistenceAtTenantScopeOptionalParams,
DeploymentsCheckExistenceAtTenantScopeResponse,
ScopedDeployment,
DeploymentsCreateOrUpdateAtTenantScopeOptionalParams,
DeploymentsCreateOrUpdateAtTenantScopeResponse,
DeploymentsGetAtTenantScopeOptionalParams,
DeploymentsGetAtTenantScopeResponse,
DeploymentsCancelAtTenantScopeOptionalParams,
DeploymentsValidateAtTenantScopeOptionalParams,
DeploymentsValidateAtTenantScopeResponse,
ScopedDeploymentWhatIf,
DeploymentsWhatIfAtTenantScopeOptionalParams,
DeploymentsWhatIfAtTenantScopeResponse,
DeploymentsExportTemplateAtTenantScopeOptionalParams,
DeploymentsExportTemplateAtTenantScopeResponse,
DeploymentsDeleteAtManagementGroupScopeOptionalParams,
DeploymentsCheckExistenceAtManagementGroupScopeOptionalParams,
DeploymentsCheckExistenceAtManagementGroupScopeResponse,
DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams,
DeploymentsCreateOrUpdateAtManagementGroupScopeResponse,
DeploymentsGetAtManagementGroupScopeOptionalParams,
DeploymentsGetAtManagementGroupScopeResponse,
DeploymentsCancelAtManagementGroupScopeOptionalParams,
DeploymentsValidateAtManagementGroupScopeOptionalParams,
DeploymentsValidateAtManagementGroupScopeResponse,
DeploymentsWhatIfAtManagementGroupScopeOptionalParams,
DeploymentsWhatIfAtManagementGroupScopeResponse,
DeploymentsExportTemplateAtManagementGroupScopeOptionalParams,
DeploymentsExportTemplateAtManagementGroupScopeResponse,
DeploymentsDeleteAtSubscriptionScopeOptionalParams,
DeploymentsCheckExistenceAtSubscriptionScopeOptionalParams,
DeploymentsCheckExistenceAtSubscriptionScopeResponse,
DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams,
DeploymentsCreateOrUpdateAtSubscriptionScopeResponse,
DeploymentsGetAtSubscriptionScopeOptionalParams,
DeploymentsGetAtSubscriptionScopeResponse,
DeploymentsCancelAtSubscriptionScopeOptionalParams,
DeploymentsValidateAtSubscriptionScopeOptionalParams,
DeploymentsValidateAtSubscriptionScopeResponse,
DeploymentWhatIf,
DeploymentsWhatIfAtSubscriptionScopeOptionalParams,
DeploymentsWhatIfAtSubscriptionScopeResponse,
DeploymentsExportTemplateAtSubscriptionScopeOptionalParams,
DeploymentsExportTemplateAtSubscriptionScopeResponse,
DeploymentsDeleteOptionalParams,
DeploymentsCheckExistenceOptionalParams,
DeploymentsCheckExistenceResponse,
DeploymentsCreateOrUpdateOptionalParams,
DeploymentsCreateOrUpdateResponse,
DeploymentsGetOptionalParams,
DeploymentsGetResponse,
DeploymentsCancelOptionalParams,
DeploymentsValidateOptionalParams,
DeploymentsValidateResponse,
DeploymentsWhatIfOptionalParams,
DeploymentsWhatIfResponse,
DeploymentsExportTemplateOptionalParams,
DeploymentsExportTemplateResponse,
DeploymentsCalculateTemplateHashOptionalParams,
DeploymentsCalculateTemplateHashResponse
} from "../models";
///
/** Interface representing a Deployments. */
export interface Deployments {
/**
* Get all the deployments at the given scope.
* @param scope The resource scope.
* @param options The options parameters.
*/
listAtScope(
scope: string,
options?: DeploymentsListAtScopeOptionalParams
): PagedAsyncIterableIterator;
/**
* Get all the deployments at the tenant scope.
* @param options The options parameters.
*/
listAtTenantScope(
options?: DeploymentsListAtTenantScopeOptionalParams
): PagedAsyncIterableIterator;
/**
* Get all the deployments for a management group.
* @param groupId The management group ID.
* @param options The options parameters.
*/
listAtManagementGroupScope(
groupId: string,
options?: DeploymentsListAtManagementGroupScopeOptionalParams
): PagedAsyncIterableIterator;
/**
* Get all the deployments for a subscription.
* @param options The options parameters.
*/
listAtSubscriptionScope(
options?: DeploymentsListAtSubscriptionScopeOptionalParams
): PagedAsyncIterableIterator;
/**
* Get all the deployments for a resource group.
* @param resourceGroupName The name of the resource group with the deployments to get. The name is
* case insensitive.
* @param options The options parameters.
*/
listByResourceGroup(
resourceGroupName: string,
options?: DeploymentsListByResourceGroupOptionalParams
): PagedAsyncIterableIterator;
/**
* 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.
* @param scope The resource scope.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
beginDeleteAtScope(
scope: string,
deploymentName: string,
options?: DeploymentsDeleteAtScopeOptionalParams
): Promise, void>>;
/**
* 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.
* @param scope The resource scope.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
beginDeleteAtScopeAndWait(
scope: string,
deploymentName: string,
options?: DeploymentsDeleteAtScopeOptionalParams
): Promise;
/**
* Checks whether the deployment exists.
* @param scope The resource scope.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
checkExistenceAtScope(
scope: string,
deploymentName: string,
options?: DeploymentsCheckExistenceAtScopeOptionalParams
): Promise;
/**
* You can provide the template and parameters directly in the request or link to JSON files.
* @param scope The resource scope.
* @param deploymentName The name of the deployment.
* @param parameters Additional parameters supplied to the operation.
* @param options The options parameters.
*/
beginCreateOrUpdateAtScope(
scope: string,
deploymentName: string,
parameters: Deployment,
options?: DeploymentsCreateOrUpdateAtScopeOptionalParams
): Promise<
PollerLike<
PollOperationState,
DeploymentsCreateOrUpdateAtScopeResponse
>
>;
/**
* You can provide the template and parameters directly in the request or link to JSON files.
* @param scope The resource scope.
* @param deploymentName The name of the deployment.
* @param parameters Additional parameters supplied to the operation.
* @param options The options parameters.
*/
beginCreateOrUpdateAtScopeAndWait(
scope: string,
deploymentName: string,
parameters: Deployment,
options?: DeploymentsCreateOrUpdateAtScopeOptionalParams
): Promise;
/**
* Gets a deployment.
* @param scope The resource scope.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
getAtScope(
scope: string,
deploymentName: string,
options?: DeploymentsGetAtScopeOptionalParams
): Promise;
/**
* 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.
* @param scope The resource scope.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
cancelAtScope(
scope: string,
deploymentName: string,
options?: DeploymentsCancelAtScopeOptionalParams
): Promise;
/**
* Validates whether the specified template is syntactically correct and will be accepted by Azure
* Resource Manager..
* @param scope The resource scope.
* @param deploymentName The name of the deployment.
* @param parameters Parameters to validate.
* @param options The options parameters.
*/
beginValidateAtScope(
scope: string,
deploymentName: string,
parameters: Deployment,
options?: DeploymentsValidateAtScopeOptionalParams
): Promise<
PollerLike<
PollOperationState,
DeploymentsValidateAtScopeResponse
>
>;
/**
* Validates whether the specified template is syntactically correct and will be accepted by Azure
* Resource Manager..
* @param scope The resource scope.
* @param deploymentName The name of the deployment.
* @param parameters Parameters to validate.
* @param options The options parameters.
*/
beginValidateAtScopeAndWait(
scope: string,
deploymentName: string,
parameters: Deployment,
options?: DeploymentsValidateAtScopeOptionalParams
): Promise;
/**
* Exports the template used for specified deployment.
* @param scope The resource scope.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
exportTemplateAtScope(
scope: string,
deploymentName: string,
options?: DeploymentsExportTemplateAtScopeOptionalParams
): Promise;
/**
* 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.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
beginDeleteAtTenantScope(
deploymentName: string,
options?: DeploymentsDeleteAtTenantScopeOptionalParams
): Promise, void>>;
/**
* 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.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
beginDeleteAtTenantScopeAndWait(
deploymentName: string,
options?: DeploymentsDeleteAtTenantScopeOptionalParams
): Promise;
/**
* Checks whether the deployment exists.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
checkExistenceAtTenantScope(
deploymentName: string,
options?: DeploymentsCheckExistenceAtTenantScopeOptionalParams
): Promise;
/**
* You can provide the template and parameters directly in the request or link to JSON files.
* @param deploymentName The name of the deployment.
* @param parameters Additional parameters supplied to the operation.
* @param options The options parameters.
*/
beginCreateOrUpdateAtTenantScope(
deploymentName: string,
parameters: ScopedDeployment,
options?: DeploymentsCreateOrUpdateAtTenantScopeOptionalParams
): Promise<
PollerLike<
PollOperationState,
DeploymentsCreateOrUpdateAtTenantScopeResponse
>
>;
/**
* You can provide the template and parameters directly in the request or link to JSON files.
* @param deploymentName The name of the deployment.
* @param parameters Additional parameters supplied to the operation.
* @param options The options parameters.
*/
beginCreateOrUpdateAtTenantScopeAndWait(
deploymentName: string,
parameters: ScopedDeployment,
options?: DeploymentsCreateOrUpdateAtTenantScopeOptionalParams
): Promise;
/**
* Gets a deployment.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
getAtTenantScope(
deploymentName: string,
options?: DeploymentsGetAtTenantScopeOptionalParams
): Promise;
/**
* 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.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
cancelAtTenantScope(
deploymentName: string,
options?: DeploymentsCancelAtTenantScopeOptionalParams
): Promise;
/**
* Validates whether the specified template is syntactically correct and will be accepted by Azure
* Resource Manager..
* @param deploymentName The name of the deployment.
* @param parameters Parameters to validate.
* @param options The options parameters.
*/
beginValidateAtTenantScope(
deploymentName: string,
parameters: ScopedDeployment,
options?: DeploymentsValidateAtTenantScopeOptionalParams
): Promise<
PollerLike<
PollOperationState,
DeploymentsValidateAtTenantScopeResponse
>
>;
/**
* Validates whether the specified template is syntactically correct and will be accepted by Azure
* Resource Manager..
* @param deploymentName The name of the deployment.
* @param parameters Parameters to validate.
* @param options The options parameters.
*/
beginValidateAtTenantScopeAndWait(
deploymentName: string,
parameters: ScopedDeployment,
options?: DeploymentsValidateAtTenantScopeOptionalParams
): Promise;
/**
* Returns changes that will be made by the deployment if executed at the scope of the tenant group.
* @param deploymentName The name of the deployment.
* @param parameters Parameters to validate.
* @param options The options parameters.
*/
beginWhatIfAtTenantScope(
deploymentName: string,
parameters: ScopedDeploymentWhatIf,
options?: DeploymentsWhatIfAtTenantScopeOptionalParams
): Promise<
PollerLike<
PollOperationState,
DeploymentsWhatIfAtTenantScopeResponse
>
>;
/**
* Returns changes that will be made by the deployment if executed at the scope of the tenant group.
* @param deploymentName The name of the deployment.
* @param parameters Parameters to validate.
* @param options The options parameters.
*/
beginWhatIfAtTenantScopeAndWait(
deploymentName: string,
parameters: ScopedDeploymentWhatIf,
options?: DeploymentsWhatIfAtTenantScopeOptionalParams
): Promise;
/**
* Exports the template used for specified deployment.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
exportTemplateAtTenantScope(
deploymentName: string,
options?: DeploymentsExportTemplateAtTenantScopeOptionalParams
): Promise;
/**
* 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.
* @param groupId The management group ID.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
beginDeleteAtManagementGroupScope(
groupId: string,
deploymentName: string,
options?: DeploymentsDeleteAtManagementGroupScopeOptionalParams
): Promise, void>>;
/**
* 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.
* @param groupId The management group ID.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
beginDeleteAtManagementGroupScopeAndWait(
groupId: string,
deploymentName: string,
options?: DeploymentsDeleteAtManagementGroupScopeOptionalParams
): Promise;
/**
* Checks whether the deployment exists.
* @param groupId The management group ID.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
checkExistenceAtManagementGroupScope(
groupId: string,
deploymentName: string,
options?: DeploymentsCheckExistenceAtManagementGroupScopeOptionalParams
): Promise;
/**
* You can provide the template and parameters directly in the request or link to JSON files.
* @param groupId The management group ID.
* @param deploymentName The name of the deployment.
* @param parameters Additional parameters supplied to the operation.
* @param options The options parameters.
*/
beginCreateOrUpdateAtManagementGroupScope(
groupId: string,
deploymentName: string,
parameters: ScopedDeployment,
options?: DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams
): Promise<
PollerLike<
PollOperationState<
DeploymentsCreateOrUpdateAtManagementGroupScopeResponse
>,
DeploymentsCreateOrUpdateAtManagementGroupScopeResponse
>
>;
/**
* You can provide the template and parameters directly in the request or link to JSON files.
* @param groupId The management group ID.
* @param deploymentName The name of the deployment.
* @param parameters Additional parameters supplied to the operation.
* @param options The options parameters.
*/
beginCreateOrUpdateAtManagementGroupScopeAndWait(
groupId: string,
deploymentName: string,
parameters: ScopedDeployment,
options?: DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams
): Promise;
/**
* Gets a deployment.
* @param groupId The management group ID.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
getAtManagementGroupScope(
groupId: string,
deploymentName: string,
options?: DeploymentsGetAtManagementGroupScopeOptionalParams
): Promise;
/**
* 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.
* @param groupId The management group ID.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
cancelAtManagementGroupScope(
groupId: string,
deploymentName: string,
options?: DeploymentsCancelAtManagementGroupScopeOptionalParams
): Promise;
/**
* Validates whether the specified template is syntactically correct and will be accepted by Azure
* Resource Manager..
* @param groupId The management group ID.
* @param deploymentName The name of the deployment.
* @param parameters Parameters to validate.
* @param options The options parameters.
*/
beginValidateAtManagementGroupScope(
groupId: string,
deploymentName: string,
parameters: ScopedDeployment,
options?: DeploymentsValidateAtManagementGroupScopeOptionalParams
): Promise<
PollerLike<
PollOperationState,
DeploymentsValidateAtManagementGroupScopeResponse
>
>;
/**
* Validates whether the specified template is syntactically correct and will be accepted by Azure
* Resource Manager..
* @param groupId The management group ID.
* @param deploymentName The name of the deployment.
* @param parameters Parameters to validate.
* @param options The options parameters.
*/
beginValidateAtManagementGroupScopeAndWait(
groupId: string,
deploymentName: string,
parameters: ScopedDeployment,
options?: DeploymentsValidateAtManagementGroupScopeOptionalParams
): Promise;
/**
* Returns changes that will be made by the deployment if executed at the scope of the management
* group.
* @param groupId The management group ID.
* @param deploymentName The name of the deployment.
* @param parameters Parameters to validate.
* @param options The options parameters.
*/
beginWhatIfAtManagementGroupScope(
groupId: string,
deploymentName: string,
parameters: ScopedDeploymentWhatIf,
options?: DeploymentsWhatIfAtManagementGroupScopeOptionalParams
): Promise<
PollerLike<
PollOperationState,
DeploymentsWhatIfAtManagementGroupScopeResponse
>
>;
/**
* Returns changes that will be made by the deployment if executed at the scope of the management
* group.
* @param groupId The management group ID.
* @param deploymentName The name of the deployment.
* @param parameters Parameters to validate.
* @param options The options parameters.
*/
beginWhatIfAtManagementGroupScopeAndWait(
groupId: string,
deploymentName: string,
parameters: ScopedDeploymentWhatIf,
options?: DeploymentsWhatIfAtManagementGroupScopeOptionalParams
): Promise;
/**
* Exports the template used for specified deployment.
* @param groupId The management group ID.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
exportTemplateAtManagementGroupScope(
groupId: string,
deploymentName: string,
options?: DeploymentsExportTemplateAtManagementGroupScopeOptionalParams
): Promise;
/**
* 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.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
beginDeleteAtSubscriptionScope(
deploymentName: string,
options?: DeploymentsDeleteAtSubscriptionScopeOptionalParams
): Promise, void>>;
/**
* 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.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
beginDeleteAtSubscriptionScopeAndWait(
deploymentName: string,
options?: DeploymentsDeleteAtSubscriptionScopeOptionalParams
): Promise;
/**
* Checks whether the deployment exists.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
checkExistenceAtSubscriptionScope(
deploymentName: string,
options?: DeploymentsCheckExistenceAtSubscriptionScopeOptionalParams
): Promise;
/**
* You can provide the template and parameters directly in the request or link to JSON files.
* @param deploymentName The name of the deployment.
* @param parameters Additional parameters supplied to the operation.
* @param options The options parameters.
*/
beginCreateOrUpdateAtSubscriptionScope(
deploymentName: string,
parameters: Deployment,
options?: DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams
): Promise<
PollerLike<
PollOperationState,
DeploymentsCreateOrUpdateAtSubscriptionScopeResponse
>
>;
/**
* You can provide the template and parameters directly in the request or link to JSON files.
* @param deploymentName The name of the deployment.
* @param parameters Additional parameters supplied to the operation.
* @param options The options parameters.
*/
beginCreateOrUpdateAtSubscriptionScopeAndWait(
deploymentName: string,
parameters: Deployment,
options?: DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams
): Promise;
/**
* Gets a deployment.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
getAtSubscriptionScope(
deploymentName: string,
options?: DeploymentsGetAtSubscriptionScopeOptionalParams
): Promise;
/**
* 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.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
cancelAtSubscriptionScope(
deploymentName: string,
options?: DeploymentsCancelAtSubscriptionScopeOptionalParams
): Promise;
/**
* Validates whether the specified template is syntactically correct and will be accepted by Azure
* Resource Manager..
* @param deploymentName The name of the deployment.
* @param parameters Parameters to validate.
* @param options The options parameters.
*/
beginValidateAtSubscriptionScope(
deploymentName: string,
parameters: Deployment,
options?: DeploymentsValidateAtSubscriptionScopeOptionalParams
): Promise<
PollerLike<
PollOperationState,
DeploymentsValidateAtSubscriptionScopeResponse
>
>;
/**
* Validates whether the specified template is syntactically correct and will be accepted by Azure
* Resource Manager..
* @param deploymentName The name of the deployment.
* @param parameters Parameters to validate.
* @param options The options parameters.
*/
beginValidateAtSubscriptionScopeAndWait(
deploymentName: string,
parameters: Deployment,
options?: DeploymentsValidateAtSubscriptionScopeOptionalParams
): Promise;
/**
* Returns changes that will be made by the deployment if executed at the scope of the subscription.
* @param deploymentName The name of the deployment.
* @param parameters Parameters to What If.
* @param options The options parameters.
*/
beginWhatIfAtSubscriptionScope(
deploymentName: string,
parameters: DeploymentWhatIf,
options?: DeploymentsWhatIfAtSubscriptionScopeOptionalParams
): Promise<
PollerLike<
PollOperationState,
DeploymentsWhatIfAtSubscriptionScopeResponse
>
>;
/**
* Returns changes that will be made by the deployment if executed at the scope of the subscription.
* @param deploymentName The name of the deployment.
* @param parameters Parameters to What If.
* @param options The options parameters.
*/
beginWhatIfAtSubscriptionScopeAndWait(
deploymentName: string,
parameters: DeploymentWhatIf,
options?: DeploymentsWhatIfAtSubscriptionScopeOptionalParams
): Promise;
/**
* Exports the template used for specified deployment.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
exportTemplateAtSubscriptionScope(
deploymentName: string,
options?: DeploymentsExportTemplateAtSubscriptionScopeOptionalParams
): Promise;
/**
* 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.
* @param resourceGroupName The name of the resource group with the deployment to delete. The name is
* case insensitive.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
beginDelete(
resourceGroupName: string,
deploymentName: string,
options?: DeploymentsDeleteOptionalParams
): Promise, void>>;
/**
* 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.
* @param resourceGroupName The name of the resource group with the deployment to delete. The name is
* case insensitive.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
beginDeleteAndWait(
resourceGroupName: string,
deploymentName: string,
options?: DeploymentsDeleteOptionalParams
): Promise;
/**
* Checks whether the deployment exists.
* @param resourceGroupName The name of the resource group with the deployment to check. The name is
* case insensitive.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
checkExistence(
resourceGroupName: string,
deploymentName: string,
options?: DeploymentsCheckExistenceOptionalParams
): Promise;
/**
* You can provide the template and parameters directly in the request or link to JSON files.
* @param resourceGroupName The name of the resource group to deploy the resources to. The name is case
* insensitive. The resource group must already exist.
* @param deploymentName The name of the deployment.
* @param parameters Additional parameters supplied to the operation.
* @param options The options parameters.
*/
beginCreateOrUpdate(
resourceGroupName: string,
deploymentName: string,
parameters: Deployment,
options?: DeploymentsCreateOrUpdateOptionalParams
): Promise<
PollerLike<
PollOperationState,
DeploymentsCreateOrUpdateResponse
>
>;
/**
* You can provide the template and parameters directly in the request or link to JSON files.
* @param resourceGroupName The name of the resource group to deploy the resources to. The name is case
* insensitive. The resource group must already exist.
* @param deploymentName The name of the deployment.
* @param parameters Additional parameters supplied to the operation.
* @param options The options parameters.
*/
beginCreateOrUpdateAndWait(
resourceGroupName: string,
deploymentName: string,
parameters: Deployment,
options?: DeploymentsCreateOrUpdateOptionalParams
): Promise;
/**
* Gets a deployment.
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
get(
resourceGroupName: string,
deploymentName: string,
options?: DeploymentsGetOptionalParams
): Promise;
/**
* 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.
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
cancel(
resourceGroupName: string,
deploymentName: string,
options?: DeploymentsCancelOptionalParams
): Promise;
/**
* Validates whether the specified template is syntactically correct and will be accepted by Azure
* Resource Manager..
* @param resourceGroupName The name of the resource group the template will be deployed to. The name
* is case insensitive.
* @param deploymentName The name of the deployment.
* @param parameters Parameters to validate.
* @param options The options parameters.
*/
beginValidate(
resourceGroupName: string,
deploymentName: string,
parameters: Deployment,
options?: DeploymentsValidateOptionalParams
): Promise<
PollerLike<
PollOperationState,
DeploymentsValidateResponse
>
>;
/**
* Validates whether the specified template is syntactically correct and will be accepted by Azure
* Resource Manager..
* @param resourceGroupName The name of the resource group the template will be deployed to. The name
* is case insensitive.
* @param deploymentName The name of the deployment.
* @param parameters Parameters to validate.
* @param options The options parameters.
*/
beginValidateAndWait(
resourceGroupName: string,
deploymentName: string,
parameters: Deployment,
options?: DeploymentsValidateOptionalParams
): Promise;
/**
* Returns changes that will be made by the deployment if executed at the scope of the resource group.
* @param resourceGroupName The name of the resource group the template will be deployed to. The name
* is case insensitive.
* @param deploymentName The name of the deployment.
* @param parameters Parameters to validate.
* @param options The options parameters.
*/
beginWhatIf(
resourceGroupName: string,
deploymentName: string,
parameters: DeploymentWhatIf,
options?: DeploymentsWhatIfOptionalParams
): Promise<
PollerLike<
PollOperationState,
DeploymentsWhatIfResponse
>
>;
/**
* Returns changes that will be made by the deployment if executed at the scope of the resource group.
* @param resourceGroupName The name of the resource group the template will be deployed to. The name
* is case insensitive.
* @param deploymentName The name of the deployment.
* @param parameters Parameters to validate.
* @param options The options parameters.
*/
beginWhatIfAndWait(
resourceGroupName: string,
deploymentName: string,
parameters: DeploymentWhatIf,
options?: DeploymentsWhatIfOptionalParams
): Promise;
/**
* Exports the template used for specified deployment.
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param deploymentName The name of the deployment.
* @param options The options parameters.
*/
exportTemplate(
resourceGroupName: string,
deploymentName: string,
options?: DeploymentsExportTemplateOptionalParams
): Promise;
/**
* Calculate the hash of the given template.
* @param template The template provided to calculate hash.
* @param options The options parameters.
*/
calculateTemplateHash(
template: Record,
options?: DeploymentsCalculateTemplateHashOptionalParams
): Promise;
}