DeploymentsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ResourceManagementClient's

<xref:deployments> attribute.

Inheritance
builtins.object
DeploymentsOperations

Constructor

DeploymentsOperations(*args, **kwargs)

Methods

begin_create_or_update

Deploys resources to a resource group.

You can provide the template and parameters directly in the request or link to JSON files.
begin_create_or_update_at_management_group_scope

Deploys resources at management group scope.

You can provide the template and parameters directly in the request or link to JSON files.
begin_create_or_update_at_scope

Deploys resources at a given scope.

You can provide the template and parameters directly in the request or link to JSON files.
begin_create_or_update_at_subscription_scope

Deploys resources at subscription scope.

You can provide the template and parameters directly in the request or link to JSON files.
begin_create_or_update_at_tenant_scope

Deploys resources at tenant scope.

You can provide the template and parameters directly in the request or link to JSON files.
begin_delete

Deletes a deployment from the deployment history.

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

Deletes a deployment from the deployment history.

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

Deletes a deployment from the deployment history.

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

Deletes a deployment from the deployment history.

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

Deletes a deployment from the deployment history.

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

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

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

Calculate the hash of the given template.
cancel

Cancels a currently running template deployment.

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

Cancels a currently running template deployment.

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

Cancels a currently running template deployment.

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

Cancels a currently running template deployment.

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

Cancels a currently running template deployment.

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

Checks whether the deployment exists.
check_existence_at_management_group_scope

Checks whether the deployment exists.
check_existence_at_scope

Checks whether the deployment exists.
check_existence_at_subscription_scope

Checks whether the deployment exists.
check_existence_at_tenant_scope

Checks whether the deployment exists.
export_template

Exports the template used for specified deployment.
export_template_at_management_group_scope

Exports the template used for specified deployment.
export_template_at_scope

Exports the template used for specified deployment.
export_template_at_subscription_scope

Exports the template used for specified deployment.
export_template_at_tenant_scope

Exports the template used for specified deployment.
get

Gets a deployment.
get_at_management_group_scope

Gets a deployment.
get_at_scope

Gets a deployment.
get_at_subscription_scope

Gets a deployment.
get_at_tenant_scope

Gets a deployment.
list_at_management_group_scope

Get all the deployments for a management group.
list_at_scope

Get all the deployments at the given scope.
list_at_subscription_scope

Get all the deployments for a subscription.
list_at_tenant_scope

Get all the deployments at the tenant scope.
list_by_resource_group

Get all the deployments for a resource group.
validate

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

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

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

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

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

begin_create_or_update

Deploys resources to a resource group.

You can provide the template and parameters directly in the request or link to JSON files.

async begin_create_or_update(resource_group_name: str, deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.DeploymentExtended]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group to deploy the resources to. The name is case insensitive. The resource group must already exist. Required.
deployment_name
Required
str

The name of the deployment. Required.
parameters
Required
Deployment or IO[bytes]

Additional parameters supplied to the operation. Is either a Deployment type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[DeploymentExtended]

An instance of AsyncLROPoller that returns either DeploymentExtended or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_create_or_update_at_management_group_scope

Deploys resources at management group scope.

You can provide the template and parameters directly in the request or link to JSON files.

async begin_create_or_update_at_management_group_scope(group_id: str, deployment_name: str, parameters: _models.ScopedDeployment, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.DeploymentExtended]

Parameters

Name Description
group_id
Required
str

The management group ID. Required.
deployment_name
Required
str

The name of the deployment. Required.
parameters
Required
ScopedDeployment or IO[bytes]

Additional parameters supplied to the operation. Is either a ScopedDeployment type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[DeploymentExtended]

An instance of AsyncLROPoller that returns either DeploymentExtended or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_create_or_update_at_scope

Deploys resources at a given scope.

You can provide the template and parameters directly in the request or link to JSON files.

async begin_create_or_update_at_scope(scope: str, deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.DeploymentExtended]

Parameters

Name Description
scope
Required
str

The scope of a deployment. Required.
deployment_name
Required
str

The name of the deployment. Required.
parameters
Required
Deployment or IO[bytes]

Additional parameters supplied to the operation. Is either a Deployment type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[DeploymentExtended]

An instance of AsyncLROPoller that returns either DeploymentExtended or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_create_or_update_at_subscription_scope

Deploys resources at subscription scope.

You can provide the template and parameters directly in the request or link to JSON files.

async begin_create_or_update_at_subscription_scope(deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.DeploymentExtended]

Parameters

Name Description
deployment_name
Required
str

The name of the deployment. Required.
parameters
Required
Deployment or IO[bytes]

Additional parameters supplied to the operation. Is either a Deployment type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[DeploymentExtended]

An instance of AsyncLROPoller that returns either DeploymentExtended or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_create_or_update_at_tenant_scope

Deploys resources at tenant scope.

You can provide the template and parameters directly in the request or link to JSON files.

async begin_create_or_update_at_tenant_scope(deployment_name: str, parameters: _models.ScopedDeployment, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.DeploymentExtended]

Parameters

Name Description
deployment_name
Required
str

The name of the deployment. Required.
parameters
Required
ScopedDeployment or IO[bytes]

Additional parameters supplied to the operation. Is either a ScopedDeployment type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[DeploymentExtended]

An instance of AsyncLROPoller that returns either DeploymentExtended or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes a deployment from the deployment history.

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

async begin_delete(resource_group_name: str, deployment_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group with the deployment to delete. The name is case insensitive. Required.
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete_at_management_group_scope

Deletes a deployment from the deployment history.

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

async begin_delete_at_management_group_scope(group_id: str, deployment_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name Description
group_id
Required
str

The management group ID. Required.
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete_at_scope

Deletes a deployment from the deployment history.

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

async begin_delete_at_scope(scope: str, deployment_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name Description
scope
Required
str

The scope of a deployment. Required.
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete_at_subscription_scope

Deletes a deployment from the deployment history.

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

async begin_delete_at_subscription_scope(deployment_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name Description
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete_at_tenant_scope

Deletes a deployment from the deployment history.

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

async begin_delete_at_tenant_scope(deployment_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name Description
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_what_if

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

async begin_what_if(resource_group_name: str, deployment_name: str, parameters: _models.DeploymentWhatIf, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.WhatIfOperationResult]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group the template will be deployed to. The name is case insensitive. Required.
deployment_name
Required
str

The name of the deployment. Required.
parameters
Required
DeploymentWhatIf or IO[bytes]

Parameters to validate. Is either a DeploymentWhatIf type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[WhatIfOperationResult]

An instance of AsyncLROPoller that returns either WhatIfOperationResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_what_if_at_subscription_scope

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

async begin_what_if_at_subscription_scope(deployment_name: str, parameters: _models.DeploymentWhatIf, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.WhatIfOperationResult]

Parameters

Name Description
deployment_name
Required
str

The name of the deployment. Required.
parameters
Required
DeploymentWhatIf or IO[bytes]

Parameters to What If. Is either a DeploymentWhatIf type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[WhatIfOperationResult]

An instance of AsyncLROPoller that returns either WhatIfOperationResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

calculate_template_hash

Calculate the hash of the given template.

async calculate_template_hash(template: MutableMapping[str, Any], **kwargs: Any) -> TemplateHashResult

Parameters

Name Description
template
Required
<xref:JSON>

The template provided to calculate hash. Required.

Returns

Type Description
TemplateHashResult

TemplateHashResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

cancel

Cancels a currently running template deployment.

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

async cancel(resource_group_name: str, deployment_name: str, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

cancel_at_management_group_scope

Cancels a currently running template deployment.

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

async cancel_at_management_group_scope(group_id: str, deployment_name: str, **kwargs: Any) -> None

Parameters

Name Description
group_id
Required
str

The management group ID. Required.
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

cancel_at_scope

Cancels a currently running template deployment.

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

async cancel_at_scope(scope: str, deployment_name: str, **kwargs: Any) -> None

Parameters

Name Description
scope
Required
str

The scope of a deployment. Required.
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

cancel_at_subscription_scope

Cancels a currently running template deployment.

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

async cancel_at_subscription_scope(deployment_name: str, **kwargs: Any) -> None

Parameters

Name Description
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

cancel_at_tenant_scope

Cancels a currently running template deployment.

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

async cancel_at_tenant_scope(deployment_name: str, **kwargs: Any) -> None

Parameters

Name Description
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

check_existence

Checks whether the deployment exists.

async check_existence(resource_group_name: str, deployment_name: str, **kwargs: Any) -> bool

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group with the deployment to check. The name is case insensitive. Required.
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
bool

bool or the result of cls(response)

Exceptions

Type Description
HttpResponseError

check_existence_at_management_group_scope

Checks whether the deployment exists.

async check_existence_at_management_group_scope(group_id: str, deployment_name: str, **kwargs: Any) -> bool

Parameters

Name Description
group_id
Required
str

The management group ID. Required.
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
bool

bool or the result of cls(response)

Exceptions

Type Description
HttpResponseError

check_existence_at_scope

Checks whether the deployment exists.

async check_existence_at_scope(scope: str, deployment_name: str, **kwargs: Any) -> bool

Parameters

Name Description
scope
Required
str

The scope of a deployment. Required.
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
bool

bool or the result of cls(response)

Exceptions

Type Description
HttpResponseError

check_existence_at_subscription_scope

Checks whether the deployment exists.

async check_existence_at_subscription_scope(deployment_name: str, **kwargs: Any) -> bool

Parameters

Name Description
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
bool

bool or the result of cls(response)

Exceptions

Type Description
HttpResponseError

check_existence_at_tenant_scope

Checks whether the deployment exists.

async check_existence_at_tenant_scope(deployment_name: str, **kwargs: Any) -> bool

Parameters

Name Description
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
bool

bool or the result of cls(response)

Exceptions

Type Description
HttpResponseError

export_template

Exports the template used for specified deployment.

async export_template(resource_group_name: str, deployment_name: str, **kwargs: Any) -> DeploymentExportResult

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
DeploymentExportResult

DeploymentExportResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

export_template_at_management_group_scope

Exports the template used for specified deployment.

async export_template_at_management_group_scope(group_id: str, deployment_name: str, **kwargs: Any) -> DeploymentExportResult

Parameters

Name Description
group_id
Required
str

The management group ID. Required.
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
DeploymentExportResult

DeploymentExportResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

export_template_at_scope

Exports the template used for specified deployment.

async export_template_at_scope(scope: str, deployment_name: str, **kwargs: Any) -> DeploymentExportResult

Parameters

Name Description
scope
Required
str

The scope of a deployment. Required.
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
DeploymentExportResult

DeploymentExportResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

export_template_at_subscription_scope

Exports the template used for specified deployment.

async export_template_at_subscription_scope(deployment_name: str, **kwargs: Any) -> DeploymentExportResult

Parameters

Name Description
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
DeploymentExportResult

DeploymentExportResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

export_template_at_tenant_scope

Exports the template used for specified deployment.

async export_template_at_tenant_scope(deployment_name: str, **kwargs: Any) -> DeploymentExportResult

Parameters

Name Description
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
DeploymentExportResult

DeploymentExportResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets a deployment.

async get(resource_group_name: str, deployment_name: str, **kwargs: Any) -> DeploymentExtended

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
DeploymentExtended

DeploymentExtended or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_at_management_group_scope

Gets a deployment.

async get_at_management_group_scope(group_id: str, deployment_name: str, **kwargs: Any) -> DeploymentExtended

Parameters

Name Description
group_id
Required
str

The management group ID. Required.
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
DeploymentExtended

DeploymentExtended or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_at_scope

Gets a deployment.

async get_at_scope(scope: str, deployment_name: str, **kwargs: Any) -> DeploymentExtended

Parameters

Name Description
scope
Required
str

The scope of a deployment. Required.
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
DeploymentExtended

DeploymentExtended or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_at_subscription_scope

Gets a deployment.

async get_at_subscription_scope(deployment_name: str, **kwargs: Any) -> DeploymentExtended

Parameters

Name Description
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
DeploymentExtended

DeploymentExtended or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_at_tenant_scope

Gets a deployment.

async get_at_tenant_scope(deployment_name: str, **kwargs: Any) -> DeploymentExtended

Parameters

Name Description
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
DeploymentExtended

DeploymentExtended or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_at_management_group_scope

Get all the deployments for a management group.

list_at_management_group_scope(group_id: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[DeploymentExtended]

Parameters

Name Description
group_id
Required
str

The management group ID. Required.
filter
Required
str

The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. Default value is None.
top
Required
int

The number of results to get. If null is passed, returns all deployments. Default value is None.

Returns

Type Description
AsyncItemPaged[DeploymentExtended]

An iterator like instance of either DeploymentExtended or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_at_scope

Get all the deployments at the given scope.

list_at_scope(scope: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[DeploymentExtended]

Parameters

Name Description
scope
Required
str

The scope of a deployment. Required.
filter
Required
str

The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. Default value is None.
top
Required
int

The number of results to get. If null is passed, returns all deployments. Default value is None.

Returns

Type Description
AsyncItemPaged[DeploymentExtended]

An iterator like instance of either DeploymentExtended or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_at_subscription_scope

Get all the deployments for a subscription.

list_at_subscription_scope(filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[DeploymentExtended]

Parameters

Name Description
filter
Required
str

The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. Default value is None.
top
Required
int

The number of results to get. If null is passed, returns all deployments. Default value is None.

Returns

Type Description
AsyncItemPaged[DeploymentExtended]

An iterator like instance of either DeploymentExtended or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_at_tenant_scope

Get all the deployments at the tenant scope.

list_at_tenant_scope(filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[DeploymentExtended]

Parameters

Name Description
filter
Required
str

The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. Default value is None.
top
Required
int

The number of results to get. If null is passed, returns all deployments. Default value is None.

Returns

Type Description
AsyncItemPaged[DeploymentExtended]

An iterator like instance of either DeploymentExtended or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_resource_group

Get all the deployments for a resource group.

list_by_resource_group(resource_group_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[DeploymentExtended]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group with the deployments to get. The name is case insensitive. Required.
filter
Required
str

The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. Default value is None.
top
Required
int

The number of results to get. If null is passed, returns all deployments. Default value is None.

Returns

Type Description
AsyncItemPaged[DeploymentExtended]

An iterator like instance of either DeploymentExtended or the result of cls(response)

Exceptions

Type Description
HttpResponseError

validate

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

async validate(resource_group_name: str, deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DeploymentValidateResult

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group the template will be deployed to. The name is case insensitive. Required.
deployment_name
Required
str

The name of the deployment. Required.
parameters
Required
Deployment or IO[bytes]

Parameters to validate. Is either a Deployment type or a IO[bytes] type. Required.

Returns

Type Description
DeploymentValidateResult

DeploymentValidateResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

validate_at_management_group_scope

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

async validate_at_management_group_scope(group_id: str, deployment_name: str, parameters: _models.ScopedDeployment, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DeploymentValidateResult

Parameters

Name Description
group_id
Required
str

The management group ID. Required.
deployment_name
Required
str

The name of the deployment. Required.
parameters
Required
ScopedDeployment or IO[bytes]

Parameters to validate. Is either a ScopedDeployment type or a IO[bytes] type. Required.

Returns

Type Description
DeploymentValidateResult

DeploymentValidateResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

validate_at_scope

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

async validate_at_scope(scope: str, deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DeploymentValidateResult

Parameters

Name Description
scope
Required
str

The scope of a deployment. Required.
deployment_name
Required
str

The name of the deployment. Required.
parameters
Required
Deployment or IO[bytes]

Parameters to validate. Is either a Deployment type or a IO[bytes] type. Required.

Returns

Type Description
DeploymentValidateResult

DeploymentValidateResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

validate_at_subscription_scope

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

async validate_at_subscription_scope(deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DeploymentValidateResult

Parameters

Name Description
deployment_name
Required
str

The name of the deployment. Required.
parameters
Required
Deployment or IO[bytes]

Parameters to validate. Is either a Deployment type or a IO[bytes] type. Required.

Returns

Type Description
DeploymentValidateResult

DeploymentValidateResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

validate_at_tenant_scope

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

async validate_at_tenant_scope(deployment_name: str, parameters: _models.ScopedDeployment, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DeploymentValidateResult

Parameters

Name Description
deployment_name
Required
str

The name of the deployment. Required.
parameters
Required
ScopedDeployment or IO[bytes]

Parameters to validate. Is either a ScopedDeployment type or a IO[bytes] type. Required.

Returns

Type Description
DeploymentValidateResult

DeploymentValidateResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.resource.resources.v2019_08_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2019_08_01\\models\\__init__.py'>