Deployments interface
Interface representing a Deployments.
Methods
| begin |
You can provide the template and parameters directly in the request or link to JSON files. |
| begin |
You can provide the template and parameters directly in the request or link to JSON files. |
| begin |
You can provide the template and parameters directly in the request or link to JSON files. |
| begin |
You can provide the template and parameters directly in the request or link to JSON files. |
| begin |
You can provide the template and parameters directly in the request or link to JSON files. |
| begin |
You can provide the template and parameters directly in the request or link to JSON files. |
| begin |
You can provide the template and parameters directly in the request or link to JSON files. |
| begin |
You can provide the template and parameters directly in the request or link to JSON files. |
| begin |
You can provide the template and parameters directly in the request or link to JSON files. |
| begin |
You can provide the template and parameters directly in the request or link to JSON files. |
| begin |
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. |
| begin |
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. |
| begin |
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. |
| begin |
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. |
| begin |
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. |
| begin |
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. |
| begin |
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. |
| begin |
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. |
| begin |
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. |
| begin |
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. |
| begin |
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. |
| begin |
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. |
| begin |
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. |
| begin |
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. |
| begin |
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. |
| begin |
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. |
| begin |
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. |
| begin |
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. |
| begin |
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. |
| begin |
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. |
| begin |
Returns changes that will be made by the deployment if executed at the scope of the resource group. |
| begin |
Returns changes that will be made by the deployment if executed at the scope of the resource group. |
| begin |
Returns changes that will be made by the deployment if executed at the scope of the management group. |
| begin |
Returns changes that will be made by the deployment if executed at the scope of the management group. |
| begin |
Returns changes that will be made by the deployment if executed at the scope of the subscription. |
| begin |
Returns changes that will be made by the deployment if executed at the scope of the subscription. |
| begin |
Returns changes that will be made by the deployment if executed at the scope of the tenant group. |
| begin |
Returns changes that will be made by the deployment if executed at the scope of the tenant group. |
| calculate |
Calculate the hash of the given template. |
| cancel(string, string, Deployments |
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. |
| cancel |
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. |
| cancel |
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. |
| cancel |
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. |
| cancel |
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. |
| check |
Checks whether the deployment exists. |
| check |
Checks whether the deployment exists. |
| check |
Checks whether the deployment exists. |
| check |
Checks whether the deployment exists. |
| check |
Checks whether the deployment exists. |
| export |
Exports the template used for specified deployment. |
| export |
Exports the template used for specified deployment. |
| export |
Exports the template used for specified deployment. |
| export |
Exports the template used for specified deployment. |
| export |
Exports the template used for specified deployment. |
| get(string, string, Deployments |
Gets a deployment. |
| get |
Gets a deployment. |
| get |
Gets a deployment. |
| get |
Gets a deployment. |
| get |
Gets a deployment. |
| list |
Get all the deployments for a management group. |
| list |
Get all the deployments at the given scope. |
| list |
Get all the deployments for a subscription. |
| list |
Get all the deployments at the tenant scope. |
| list |
Get all the deployments for a resource group. |
Method Details
beginCreateOrUpdate(string, string, Deployment, DeploymentsCreateOrUpdateOptionalParams)
You can provide the template and parameters directly in the request or link to JSON files.
function beginCreateOrUpdate(resourceGroupName: string, deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DeploymentExtended>, DeploymentExtended>>Parameters
- resourceGroupName
-
string
The name of the resource group to deploy the resources to. The name is case insensitive. The resource group must already exist.
- deploymentName
-
string
The name of the deployment.
- parameters
- Deployment
Additional parameters supplied to the operation.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<DeploymentExtended>, DeploymentExtended>>
beginCreateOrUpdateAndWait(string, string, Deployment, DeploymentsCreateOrUpdateOptionalParams)
You can provide the template and parameters directly in the request or link to JSON files.
function beginCreateOrUpdateAndWait(resourceGroupName: string, deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateOptionalParams): Promise<DeploymentExtended>Parameters
- resourceGroupName
-
string
The name of the resource group to deploy the resources to. The name is case insensitive. The resource group must already exist.
- deploymentName
-
string
The name of the deployment.
- parameters
- Deployment
Additional parameters supplied to the operation.
The options parameters.
Returns
Promise<DeploymentExtended>
beginCreateOrUpdateAtManagementGroupScope(string, string, ScopedDeployment, DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams)
You can provide the template and parameters directly in the request or link to JSON files.
function beginCreateOrUpdateAtManagementGroupScope(groupId: string, deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams): Promise<PollerLike<PollOperationState<DeploymentExtended>, DeploymentExtended>>Parameters
- groupId
-
string
The management group ID.
- deploymentName
-
string
The name of the deployment.
- parameters
- ScopedDeployment
Additional parameters supplied to the operation.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<DeploymentExtended>, DeploymentExtended>>
beginCreateOrUpdateAtManagementGroupScopeAndWait(string, string, ScopedDeployment, DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams)
You can provide the template and parameters directly in the request or link to JSON files.
function beginCreateOrUpdateAtManagementGroupScopeAndWait(groupId: string, deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams): Promise<DeploymentExtended>Parameters
- groupId
-
string
The management group ID.
- deploymentName
-
string
The name of the deployment.
- parameters
- ScopedDeployment
Additional parameters supplied to the operation.
The options parameters.
Returns
Promise<DeploymentExtended>
beginCreateOrUpdateAtScope(string, string, Deployment, DeploymentsCreateOrUpdateAtScopeOptionalParams)
You can provide the template and parameters directly in the request or link to JSON files.
function beginCreateOrUpdateAtScope(scope: string, deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateAtScopeOptionalParams): Promise<PollerLike<PollOperationState<DeploymentExtended>, DeploymentExtended>>Parameters
- scope
-
string
The resource scope.
- deploymentName
-
string
The name of the deployment.
- parameters
- Deployment
Additional parameters supplied to the operation.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<DeploymentExtended>, DeploymentExtended>>
beginCreateOrUpdateAtScopeAndWait(string, string, Deployment, DeploymentsCreateOrUpdateAtScopeOptionalParams)
You can provide the template and parameters directly in the request or link to JSON files.
function beginCreateOrUpdateAtScopeAndWait(scope: string, deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateAtScopeOptionalParams): Promise<DeploymentExtended>Parameters
- scope
-
string
The resource scope.
- deploymentName
-
string
The name of the deployment.
- parameters
- Deployment
Additional parameters supplied to the operation.
The options parameters.
Returns
Promise<DeploymentExtended>
beginCreateOrUpdateAtSubscriptionScope(string, Deployment, DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams)
You can provide the template and parameters directly in the request or link to JSON files.
function beginCreateOrUpdateAtSubscriptionScope(deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams): Promise<PollerLike<PollOperationState<DeploymentExtended>, DeploymentExtended>>Parameters
- deploymentName
-
string
The name of the deployment.
- parameters
- Deployment
Additional parameters supplied to the operation.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<DeploymentExtended>, DeploymentExtended>>
beginCreateOrUpdateAtSubscriptionScopeAndWait(string, Deployment, DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams)
You can provide the template and parameters directly in the request or link to JSON files.
function beginCreateOrUpdateAtSubscriptionScopeAndWait(deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams): Promise<DeploymentExtended>Parameters
- deploymentName
-
string
The name of the deployment.
- parameters
- Deployment
Additional parameters supplied to the operation.
The options parameters.
Returns
Promise<DeploymentExtended>
beginCreateOrUpdateAtTenantScope(string, ScopedDeployment, DeploymentsCreateOrUpdateAtTenantScopeOptionalParams)
You can provide the template and parameters directly in the request or link to JSON files.
function beginCreateOrUpdateAtTenantScope(deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsCreateOrUpdateAtTenantScopeOptionalParams): Promise<PollerLike<PollOperationState<DeploymentExtended>, DeploymentExtended>>Parameters
- deploymentName
-
string
The name of the deployment.
- parameters
- ScopedDeployment
Additional parameters supplied to the operation.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<DeploymentExtended>, DeploymentExtended>>
beginCreateOrUpdateAtTenantScopeAndWait(string, ScopedDeployment, DeploymentsCreateOrUpdateAtTenantScopeOptionalParams)
You can provide the template and parameters directly in the request or link to JSON files.
function beginCreateOrUpdateAtTenantScopeAndWait(deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsCreateOrUpdateAtTenantScopeOptionalParams): Promise<DeploymentExtended>Parameters
- deploymentName
-
string
The name of the deployment.
- parameters
- ScopedDeployment
Additional parameters supplied to the operation.
The options parameters.
Returns
Promise<DeploymentExtended>
beginDelete(string, string, DeploymentsDeleteOptionalParams)
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.
function beginDelete(resourceGroupName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group with the deployment to delete. The name is case insensitive.
- deploymentName
-
string
The name of the deployment.
- options
- DeploymentsDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, DeploymentsDeleteOptionalParams)
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.
function beginDeleteAndWait(resourceGroupName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group with the deployment to delete. The name is case insensitive.
- deploymentName
-
string
The name of the deployment.
- options
- DeploymentsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginDeleteAtManagementGroupScope(string, string, DeploymentsDeleteAtManagementGroupScopeOptionalParams)
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.
function beginDeleteAtManagementGroupScope(groupId: string, deploymentName: string, options?: DeploymentsDeleteAtManagementGroupScopeOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- groupId
-
string
The management group ID.
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAtManagementGroupScopeAndWait(string, string, DeploymentsDeleteAtManagementGroupScopeOptionalParams)
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.
function beginDeleteAtManagementGroupScopeAndWait(groupId: string, deploymentName: string, options?: DeploymentsDeleteAtManagementGroupScopeOptionalParams): Promise<void>Parameters
- groupId
-
string
The management group ID.
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
Promise<void>
beginDeleteAtScope(string, string, DeploymentsDeleteAtScopeOptionalParams)
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.
function beginDeleteAtScope(scope: string, deploymentName: string, options?: DeploymentsDeleteAtScopeOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- scope
-
string
The resource scope.
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAtScopeAndWait(string, string, DeploymentsDeleteAtScopeOptionalParams)
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.
function beginDeleteAtScopeAndWait(scope: string, deploymentName: string, options?: DeploymentsDeleteAtScopeOptionalParams): Promise<void>Parameters
- scope
-
string
The resource scope.
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
Promise<void>
beginDeleteAtSubscriptionScope(string, DeploymentsDeleteAtSubscriptionScopeOptionalParams)
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.
function beginDeleteAtSubscriptionScope(deploymentName: string, options?: DeploymentsDeleteAtSubscriptionScopeOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAtSubscriptionScopeAndWait(string, DeploymentsDeleteAtSubscriptionScopeOptionalParams)
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.
function beginDeleteAtSubscriptionScopeAndWait(deploymentName: string, options?: DeploymentsDeleteAtSubscriptionScopeOptionalParams): Promise<void>Parameters
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
Promise<void>
beginDeleteAtTenantScope(string, DeploymentsDeleteAtTenantScopeOptionalParams)
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.
function beginDeleteAtTenantScope(deploymentName: string, options?: DeploymentsDeleteAtTenantScopeOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAtTenantScopeAndWait(string, DeploymentsDeleteAtTenantScopeOptionalParams)
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.
function beginDeleteAtTenantScopeAndWait(deploymentName: string, options?: DeploymentsDeleteAtTenantScopeOptionalParams): Promise<void>Parameters
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
Promise<void>
beginValidate(string, string, Deployment, DeploymentsValidateOptionalParams)
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
function beginValidate(resourceGroupName: string, deploymentName: string, parameters: Deployment, options?: DeploymentsValidateOptionalParams): Promise<PollerLike<PollOperationState<DeploymentValidateResult>, DeploymentValidateResult>>Parameters
- resourceGroupName
-
string
The name of the resource group the template will be deployed to. The name is case insensitive.
- deploymentName
-
string
The name of the deployment.
- parameters
- Deployment
Parameters to validate.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<DeploymentValidateResult>, DeploymentValidateResult>>
beginValidateAndWait(string, string, Deployment, DeploymentsValidateOptionalParams)
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
function beginValidateAndWait(resourceGroupName: string, deploymentName: string, parameters: Deployment, options?: DeploymentsValidateOptionalParams): Promise<DeploymentValidateResult>Parameters
- resourceGroupName
-
string
The name of the resource group the template will be deployed to. The name is case insensitive.
- deploymentName
-
string
The name of the deployment.
- parameters
- Deployment
Parameters to validate.
The options parameters.
Returns
Promise<DeploymentValidateResult>
beginValidateAtManagementGroupScope(string, string, ScopedDeployment, DeploymentsValidateAtManagementGroupScopeOptionalParams)
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
function beginValidateAtManagementGroupScope(groupId: string, deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsValidateAtManagementGroupScopeOptionalParams): Promise<PollerLike<PollOperationState<DeploymentValidateResult>, DeploymentValidateResult>>Parameters
- groupId
-
string
The management group ID.
- deploymentName
-
string
The name of the deployment.
- parameters
- ScopedDeployment
Parameters to validate.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<DeploymentValidateResult>, DeploymentValidateResult>>
beginValidateAtManagementGroupScopeAndWait(string, string, ScopedDeployment, DeploymentsValidateAtManagementGroupScopeOptionalParams)
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
function beginValidateAtManagementGroupScopeAndWait(groupId: string, deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsValidateAtManagementGroupScopeOptionalParams): Promise<DeploymentValidateResult>Parameters
- groupId
-
string
The management group ID.
- deploymentName
-
string
The name of the deployment.
- parameters
- ScopedDeployment
Parameters to validate.
The options parameters.
Returns
Promise<DeploymentValidateResult>
beginValidateAtScope(string, string, Deployment, DeploymentsValidateAtScopeOptionalParams)
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
function beginValidateAtScope(scope: string, deploymentName: string, parameters: Deployment, options?: DeploymentsValidateAtScopeOptionalParams): Promise<PollerLike<PollOperationState<DeploymentValidateResult>, DeploymentValidateResult>>Parameters
- scope
-
string
The resource scope.
- deploymentName
-
string
The name of the deployment.
- parameters
- Deployment
Parameters to validate.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<DeploymentValidateResult>, DeploymentValidateResult>>
beginValidateAtScopeAndWait(string, string, Deployment, DeploymentsValidateAtScopeOptionalParams)
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
function beginValidateAtScopeAndWait(scope: string, deploymentName: string, parameters: Deployment, options?: DeploymentsValidateAtScopeOptionalParams): Promise<DeploymentValidateResult>Parameters
- scope
-
string
The resource scope.
- deploymentName
-
string
The name of the deployment.
- parameters
- Deployment
Parameters to validate.
The options parameters.
Returns
Promise<DeploymentValidateResult>
beginValidateAtSubscriptionScope(string, Deployment, DeploymentsValidateAtSubscriptionScopeOptionalParams)
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
function beginValidateAtSubscriptionScope(deploymentName: string, parameters: Deployment, options?: DeploymentsValidateAtSubscriptionScopeOptionalParams): Promise<PollerLike<PollOperationState<DeploymentValidateResult>, DeploymentValidateResult>>Parameters
- deploymentName
-
string
The name of the deployment.
- parameters
- Deployment
Parameters to validate.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<DeploymentValidateResult>, DeploymentValidateResult>>
beginValidateAtSubscriptionScopeAndWait(string, Deployment, DeploymentsValidateAtSubscriptionScopeOptionalParams)
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
function beginValidateAtSubscriptionScopeAndWait(deploymentName: string, parameters: Deployment, options?: DeploymentsValidateAtSubscriptionScopeOptionalParams): Promise<DeploymentValidateResult>Parameters
- deploymentName
-
string
The name of the deployment.
- parameters
- Deployment
Parameters to validate.
The options parameters.
Returns
Promise<DeploymentValidateResult>
beginValidateAtTenantScope(string, ScopedDeployment, DeploymentsValidateAtTenantScopeOptionalParams)
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
function beginValidateAtTenantScope(deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsValidateAtTenantScopeOptionalParams): Promise<PollerLike<PollOperationState<DeploymentValidateResult>, DeploymentValidateResult>>Parameters
- deploymentName
-
string
The name of the deployment.
- parameters
- ScopedDeployment
Parameters to validate.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<DeploymentValidateResult>, DeploymentValidateResult>>
beginValidateAtTenantScopeAndWait(string, ScopedDeployment, DeploymentsValidateAtTenantScopeOptionalParams)
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
function beginValidateAtTenantScopeAndWait(deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsValidateAtTenantScopeOptionalParams): Promise<DeploymentValidateResult>Parameters
- deploymentName
-
string
The name of the deployment.
- parameters
- ScopedDeployment
Parameters to validate.
The options parameters.
Returns
Promise<DeploymentValidateResult>
beginWhatIf(string, string, DeploymentWhatIf, DeploymentsWhatIfOptionalParams)
Returns changes that will be made by the deployment if executed at the scope of the resource group.
function beginWhatIf(resourceGroupName: string, deploymentName: string, parameters: DeploymentWhatIf, options?: DeploymentsWhatIfOptionalParams): Promise<PollerLike<PollOperationState<WhatIfOperationResult>, WhatIfOperationResult>>Parameters
- resourceGroupName
-
string
The name of the resource group the template will be deployed to. The name is case insensitive.
- deploymentName
-
string
The name of the deployment.
- parameters
- DeploymentWhatIf
Parameters to validate.
- options
- DeploymentsWhatIfOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<WhatIfOperationResult>, WhatIfOperationResult>>
beginWhatIfAndWait(string, string, DeploymentWhatIf, DeploymentsWhatIfOptionalParams)
Returns changes that will be made by the deployment if executed at the scope of the resource group.
function beginWhatIfAndWait(resourceGroupName: string, deploymentName: string, parameters: DeploymentWhatIf, options?: DeploymentsWhatIfOptionalParams): Promise<WhatIfOperationResult>Parameters
- resourceGroupName
-
string
The name of the resource group the template will be deployed to. The name is case insensitive.
- deploymentName
-
string
The name of the deployment.
- parameters
- DeploymentWhatIf
Parameters to validate.
- options
- DeploymentsWhatIfOptionalParams
The options parameters.
Returns
Promise<WhatIfOperationResult>
beginWhatIfAtManagementGroupScope(string, string, ScopedDeploymentWhatIf, DeploymentsWhatIfAtManagementGroupScopeOptionalParams)
Returns changes that will be made by the deployment if executed at the scope of the management group.
function beginWhatIfAtManagementGroupScope(groupId: string, deploymentName: string, parameters: ScopedDeploymentWhatIf, options?: DeploymentsWhatIfAtManagementGroupScopeOptionalParams): Promise<PollerLike<PollOperationState<WhatIfOperationResult>, WhatIfOperationResult>>Parameters
- groupId
-
string
The management group ID.
- deploymentName
-
string
The name of the deployment.
- parameters
- ScopedDeploymentWhatIf
Parameters to validate.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<WhatIfOperationResult>, WhatIfOperationResult>>
beginWhatIfAtManagementGroupScopeAndWait(string, string, ScopedDeploymentWhatIf, DeploymentsWhatIfAtManagementGroupScopeOptionalParams)
Returns changes that will be made by the deployment if executed at the scope of the management group.
function beginWhatIfAtManagementGroupScopeAndWait(groupId: string, deploymentName: string, parameters: ScopedDeploymentWhatIf, options?: DeploymentsWhatIfAtManagementGroupScopeOptionalParams): Promise<WhatIfOperationResult>Parameters
- groupId
-
string
The management group ID.
- deploymentName
-
string
The name of the deployment.
- parameters
- ScopedDeploymentWhatIf
Parameters to validate.
The options parameters.
Returns
Promise<WhatIfOperationResult>
beginWhatIfAtSubscriptionScope(string, DeploymentWhatIf, DeploymentsWhatIfAtSubscriptionScopeOptionalParams)
Returns changes that will be made by the deployment if executed at the scope of the subscription.
function beginWhatIfAtSubscriptionScope(deploymentName: string, parameters: DeploymentWhatIf, options?: DeploymentsWhatIfAtSubscriptionScopeOptionalParams): Promise<PollerLike<PollOperationState<WhatIfOperationResult>, WhatIfOperationResult>>Parameters
- deploymentName
-
string
The name of the deployment.
- parameters
- DeploymentWhatIf
Parameters to What If.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<WhatIfOperationResult>, WhatIfOperationResult>>
beginWhatIfAtSubscriptionScopeAndWait(string, DeploymentWhatIf, DeploymentsWhatIfAtSubscriptionScopeOptionalParams)
Returns changes that will be made by the deployment if executed at the scope of the subscription.
function beginWhatIfAtSubscriptionScopeAndWait(deploymentName: string, parameters: DeploymentWhatIf, options?: DeploymentsWhatIfAtSubscriptionScopeOptionalParams): Promise<WhatIfOperationResult>Parameters
- deploymentName
-
string
The name of the deployment.
- parameters
- DeploymentWhatIf
Parameters to What If.
The options parameters.
Returns
Promise<WhatIfOperationResult>
beginWhatIfAtTenantScope(string, ScopedDeploymentWhatIf, DeploymentsWhatIfAtTenantScopeOptionalParams)
Returns changes that will be made by the deployment if executed at the scope of the tenant group.
function beginWhatIfAtTenantScope(deploymentName: string, parameters: ScopedDeploymentWhatIf, options?: DeploymentsWhatIfAtTenantScopeOptionalParams): Promise<PollerLike<PollOperationState<WhatIfOperationResult>, WhatIfOperationResult>>Parameters
- deploymentName
-
string
The name of the deployment.
- parameters
- ScopedDeploymentWhatIf
Parameters to validate.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<WhatIfOperationResult>, WhatIfOperationResult>>
beginWhatIfAtTenantScopeAndWait(string, ScopedDeploymentWhatIf, DeploymentsWhatIfAtTenantScopeOptionalParams)
Returns changes that will be made by the deployment if executed at the scope of the tenant group.
function beginWhatIfAtTenantScopeAndWait(deploymentName: string, parameters: ScopedDeploymentWhatIf, options?: DeploymentsWhatIfAtTenantScopeOptionalParams): Promise<WhatIfOperationResult>Parameters
- deploymentName
-
string
The name of the deployment.
- parameters
- ScopedDeploymentWhatIf
Parameters to validate.
The options parameters.
Returns
Promise<WhatIfOperationResult>
calculateTemplateHash(Record<string, unknown>, DeploymentsCalculateTemplateHashOptionalParams)
Calculate the hash of the given template.
function calculateTemplateHash(template: Record<string, unknown>, options?: DeploymentsCalculateTemplateHashOptionalParams): Promise<TemplateHashResult>Parameters
- template
-
Record<string, unknown>
The template provided to calculate hash.
The options parameters.
Returns
Promise<TemplateHashResult>
cancel(string, string, DeploymentsCancelOptionalParams)
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.
function cancel(resourceGroupName: string, deploymentName: string, options?: DeploymentsCancelOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- deploymentName
-
string
The name of the deployment.
- options
- DeploymentsCancelOptionalParams
The options parameters.
Returns
Promise<void>
cancelAtManagementGroupScope(string, string, DeploymentsCancelAtManagementGroupScopeOptionalParams)
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.
function cancelAtManagementGroupScope(groupId: string, deploymentName: string, options?: DeploymentsCancelAtManagementGroupScopeOptionalParams): Promise<void>Parameters
- groupId
-
string
The management group ID.
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
Promise<void>
cancelAtScope(string, string, DeploymentsCancelAtScopeOptionalParams)
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.
function cancelAtScope(scope: string, deploymentName: string, options?: DeploymentsCancelAtScopeOptionalParams): Promise<void>Parameters
- scope
-
string
The resource scope.
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
Promise<void>
cancelAtSubscriptionScope(string, DeploymentsCancelAtSubscriptionScopeOptionalParams)
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.
function cancelAtSubscriptionScope(deploymentName: string, options?: DeploymentsCancelAtSubscriptionScopeOptionalParams): Promise<void>Parameters
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
Promise<void>
cancelAtTenantScope(string, DeploymentsCancelAtTenantScopeOptionalParams)
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.
function cancelAtTenantScope(deploymentName: string, options?: DeploymentsCancelAtTenantScopeOptionalParams): Promise<void>Parameters
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
Promise<void>
checkExistence(string, string, DeploymentsCheckExistenceOptionalParams)
Checks whether the deployment exists.
function checkExistence(resourceGroupName: string, deploymentName: string, options?: DeploymentsCheckExistenceOptionalParams): Promise<DeploymentsCheckExistenceResponse>Parameters
- resourceGroupName
-
string
The name of the resource group with the deployment to check. The name is case insensitive.
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
Promise<DeploymentsCheckExistenceResponse>
checkExistenceAtManagementGroupScope(string, string, DeploymentsCheckExistenceAtManagementGroupScopeOptionalParams)
Checks whether the deployment exists.
function checkExistenceAtManagementGroupScope(groupId: string, deploymentName: string, options?: DeploymentsCheckExistenceAtManagementGroupScopeOptionalParams): Promise<DeploymentsCheckExistenceAtManagementGroupScopeResponse>Parameters
- groupId
-
string
The management group ID.
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
checkExistenceAtScope(string, string, DeploymentsCheckExistenceAtScopeOptionalParams)
Checks whether the deployment exists.
function checkExistenceAtScope(scope: string, deploymentName: string, options?: DeploymentsCheckExistenceAtScopeOptionalParams): Promise<DeploymentsCheckExistenceAtScopeResponse>Parameters
- scope
-
string
The resource scope.
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
checkExistenceAtSubscriptionScope(string, DeploymentsCheckExistenceAtSubscriptionScopeOptionalParams)
Checks whether the deployment exists.
function checkExistenceAtSubscriptionScope(deploymentName: string, options?: DeploymentsCheckExistenceAtSubscriptionScopeOptionalParams): Promise<DeploymentsCheckExistenceAtSubscriptionScopeResponse>Parameters
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
checkExistenceAtTenantScope(string, DeploymentsCheckExistenceAtTenantScopeOptionalParams)
Checks whether the deployment exists.
function checkExistenceAtTenantScope(deploymentName: string, options?: DeploymentsCheckExistenceAtTenantScopeOptionalParams): Promise<DeploymentsCheckExistenceAtTenantScopeResponse>Parameters
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
exportTemplate(string, string, DeploymentsExportTemplateOptionalParams)
Exports the template used for specified deployment.
function exportTemplate(resourceGroupName: string, deploymentName: string, options?: DeploymentsExportTemplateOptionalParams): Promise<DeploymentExportResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
Promise<DeploymentExportResult>
exportTemplateAtManagementGroupScope(string, string, DeploymentsExportTemplateAtManagementGroupScopeOptionalParams)
Exports the template used for specified deployment.
function exportTemplateAtManagementGroupScope(groupId: string, deploymentName: string, options?: DeploymentsExportTemplateAtManagementGroupScopeOptionalParams): Promise<DeploymentExportResult>Parameters
- groupId
-
string
The management group ID.
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
Promise<DeploymentExportResult>
exportTemplateAtScope(string, string, DeploymentsExportTemplateAtScopeOptionalParams)
Exports the template used for specified deployment.
function exportTemplateAtScope(scope: string, deploymentName: string, options?: DeploymentsExportTemplateAtScopeOptionalParams): Promise<DeploymentExportResult>Parameters
- scope
-
string
The resource scope.
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
Promise<DeploymentExportResult>
exportTemplateAtSubscriptionScope(string, DeploymentsExportTemplateAtSubscriptionScopeOptionalParams)
Exports the template used for specified deployment.
function exportTemplateAtSubscriptionScope(deploymentName: string, options?: DeploymentsExportTemplateAtSubscriptionScopeOptionalParams): Promise<DeploymentExportResult>Parameters
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
Promise<DeploymentExportResult>
exportTemplateAtTenantScope(string, DeploymentsExportTemplateAtTenantScopeOptionalParams)
Exports the template used for specified deployment.
function exportTemplateAtTenantScope(deploymentName: string, options?: DeploymentsExportTemplateAtTenantScopeOptionalParams): Promise<DeploymentExportResult>Parameters
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
Promise<DeploymentExportResult>
get(string, string, DeploymentsGetOptionalParams)
Gets a deployment.
function get(resourceGroupName: string, deploymentName: string, options?: DeploymentsGetOptionalParams): Promise<DeploymentExtended>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- deploymentName
-
string
The name of the deployment.
- options
- DeploymentsGetOptionalParams
The options parameters.
Returns
Promise<DeploymentExtended>
getAtManagementGroupScope(string, string, DeploymentsGetAtManagementGroupScopeOptionalParams)
Gets a deployment.
function getAtManagementGroupScope(groupId: string, deploymentName: string, options?: DeploymentsGetAtManagementGroupScopeOptionalParams): Promise<DeploymentExtended>Parameters
- groupId
-
string
The management group ID.
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
Promise<DeploymentExtended>
getAtScope(string, string, DeploymentsGetAtScopeOptionalParams)
Gets a deployment.
function getAtScope(scope: string, deploymentName: string, options?: DeploymentsGetAtScopeOptionalParams): Promise<DeploymentExtended>Parameters
- scope
-
string
The resource scope.
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
Promise<DeploymentExtended>
getAtSubscriptionScope(string, DeploymentsGetAtSubscriptionScopeOptionalParams)
Gets a deployment.
function getAtSubscriptionScope(deploymentName: string, options?: DeploymentsGetAtSubscriptionScopeOptionalParams): Promise<DeploymentExtended>Parameters
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
Promise<DeploymentExtended>
getAtTenantScope(string, DeploymentsGetAtTenantScopeOptionalParams)
Gets a deployment.
function getAtTenantScope(deploymentName: string, options?: DeploymentsGetAtTenantScopeOptionalParams): Promise<DeploymentExtended>Parameters
- deploymentName
-
string
The name of the deployment.
The options parameters.
Returns
Promise<DeploymentExtended>
listAtManagementGroupScope(string, DeploymentsListAtManagementGroupScopeOptionalParams)
Get all the deployments for a management group.
function listAtManagementGroupScope(groupId: string, options?: DeploymentsListAtManagementGroupScopeOptionalParams): PagedAsyncIterableIterator<DeploymentExtended, DeploymentExtended[], PageSettings>Parameters
- groupId
-
string
The management group ID.
The options parameters.
Returns
listAtScope(string, DeploymentsListAtScopeOptionalParams)
Get all the deployments at the given scope.
function listAtScope(scope: string, options?: DeploymentsListAtScopeOptionalParams): PagedAsyncIterableIterator<DeploymentExtended, DeploymentExtended[], PageSettings>Parameters
- scope
-
string
The resource scope.
The options parameters.
Returns
listAtSubscriptionScope(DeploymentsListAtSubscriptionScopeOptionalParams)
Get all the deployments for a subscription.
function listAtSubscriptionScope(options?: DeploymentsListAtSubscriptionScopeOptionalParams): PagedAsyncIterableIterator<DeploymentExtended, DeploymentExtended[], PageSettings>Parameters
The options parameters.
Returns
listAtTenantScope(DeploymentsListAtTenantScopeOptionalParams)
Get all the deployments at the tenant scope.
function listAtTenantScope(options?: DeploymentsListAtTenantScopeOptionalParams): PagedAsyncIterableIterator<DeploymentExtended, DeploymentExtended[], PageSettings>Parameters
The options parameters.
Returns
listByResourceGroup(string, DeploymentsListByResourceGroupOptionalParams)
Get all the deployments for a resource group.
function listByResourceGroup(resourceGroupName: string, options?: DeploymentsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DeploymentExtended, DeploymentExtended[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group with the deployments to get. The name is case insensitive.
The options parameters.