azure.mgmt.resource.resources.v2020_06_01.aio.operations package

class azure.mgmt.resource.resources.v2020_06_01.aio.operations.Operations(client, config, serializer, deserializer)

Operations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list(**kwargs) → AsyncIterable[azure.mgmt.resource.features.v2015_12_01.models._models_py3.OperationListResult]

Lists all of the available Microsoft.Resources REST API operations.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

AsyncItemPaged[OperationListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.resource.resources.v2020_06_01.models' from 'c:\\repo\\azure-sdk-for-python\\sdk\\resources\\azure-mgmt-resource\\.tox\\sphinx\\lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2020_06_01\\models\\__init__.py'>

class azure.mgmt.resource.resources.v2020_06_01.aio.operations.DeploymentsOperations(client, config, serializer, deserializer)

DeploymentsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

async begin_create_or_update(resource_group_name: str, deployment_name: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.Deployment, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentExtended]

Deploys resources to a resource group.

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

Parameters

• resource_group_name (str) – The name of the resource group to deploy the resources to. The name is case insensitive. The resource group must already exist.

• deployment_name (str) – The name of the deployment.

• parameters (Deployment) – Additional parameters supplied to the operation.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[DeploymentExtended]

Raises

HttpResponseError –

async begin_create_or_update_at_management_group_scope(group_id: str, deployment_name: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.ScopedDeployment, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentExtended]

Deploys resources at management group scope.

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

Parameters

• group_id (str) – The management group ID.

• deployment_name (str) – The name of the deployment.

• parameters (ScopedDeployment) – Additional parameters supplied to the operation.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[DeploymentExtended]

Raises

HttpResponseError –

async begin_create_or_update_at_scope(scope: str, deployment_name: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.Deployment, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentExtended]

Deploys resources at a given scope.

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

Parameters

• scope (str) – The resource scope.

• deployment_name (str) – The name of the deployment.

• parameters (Deployment) – Additional parameters supplied to the operation.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[DeploymentExtended]

Raises

HttpResponseError –

async begin_create_or_update_at_subscription_scope(deployment_name: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.Deployment, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentExtended]

Deploys resources at subscription scope.

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

Parameters

• deployment_name (str) – The name of the deployment.

• parameters (Deployment) – Additional parameters supplied to the operation.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[DeploymentExtended]

Raises

HttpResponseError –

async begin_create_or_update_at_tenant_scope(deployment_name: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.ScopedDeployment, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentExtended]

Deploys resources at tenant scope.

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

Parameters

• deployment_name (str) – The name of the deployment.

• parameters (ScopedDeployment) – Additional parameters supplied to the operation.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[DeploymentExtended]

Raises

HttpResponseError –

async begin_delete(resource_group_name: str, deployment_name: str, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[None]

Deletes a deployment from the deployment history.

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

Parameters

• resource_group_name (str) – The name of the resource group with the deployment to delete. The name is case insensitive.

• deployment_name (str) – The name of the deployment.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[None]

Raises

HttpResponseError –

async begin_delete_at_management_group_scope(group_id: str, deployment_name: str, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[None]

Deletes a deployment from the deployment history.

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

Parameters

• group_id (str) – The management group ID.

• deployment_name (str) – The name of the deployment.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[None]

Raises

HttpResponseError –

async begin_delete_at_scope(scope: str, deployment_name: str, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[None]

Deletes a deployment from the deployment history.

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

Parameters

• scope (str) – The resource scope.

• deployment_name (str) – The name of the deployment.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[None]

Raises

HttpResponseError –

async begin_delete_at_subscription_scope(deployment_name: str, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[None]

Deletes a deployment from the deployment history.

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

Parameters

deployment_name (str) – The name of the deployment.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[None]

Raises

HttpResponseError –

async begin_delete_at_tenant_scope(deployment_name: str, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[None]

Deletes a deployment from the deployment history.

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

Parameters

deployment_name (str) – The name of the deployment.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[None]

Raises

HttpResponseError –

async begin_validate(resource_group_name: str, deployment_name: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.Deployment, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.resource.resources.v2019_10_01.models._models_py3.DeploymentValidateResult]

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

Parameters

• resource_group_name (str) – The name of the resource group the template will be deployed to. The name is case insensitive.

• deployment_name (str) – The name of the deployment.

• parameters (Deployment) – Parameters to validate.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[DeploymentValidateResult]

Raises

HttpResponseError –

async begin_validate_at_management_group_scope(group_id: str, deployment_name: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.ScopedDeployment, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.resource.resources.v2019_10_01.models._models_py3.DeploymentValidateResult]

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

Parameters

• group_id (str) – The management group ID.

• deployment_name (str) – The name of the deployment.

• parameters (ScopedDeployment) – Parameters to validate.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[DeploymentValidateResult]

Raises

HttpResponseError –

async begin_validate_at_scope(scope: str, deployment_name: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.Deployment, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.resource.resources.v2019_10_01.models._models_py3.DeploymentValidateResult]

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

Parameters

• scope (str) – The resource scope.

• deployment_name (str) – The name of the deployment.

• parameters (Deployment) – Parameters to validate.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[DeploymentValidateResult]

Raises

HttpResponseError –

async begin_validate_at_subscription_scope(deployment_name: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.Deployment, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.resource.resources.v2019_10_01.models._models_py3.DeploymentValidateResult]

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

Parameters

• deployment_name (str) – The name of the deployment.

• parameters (Deployment) – Parameters to validate.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[DeploymentValidateResult]

Raises

HttpResponseError –

async begin_validate_at_tenant_scope(deployment_name: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.ScopedDeployment, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.resource.resources.v2019_10_01.models._models_py3.DeploymentValidateResult]

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

Parameters

• deployment_name (str) – The name of the deployment.

• parameters (ScopedDeployment) – Parameters to validate.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[DeploymentValidateResult]

Raises

HttpResponseError –

async begin_what_if(resource_group_name: str, deployment_name: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.DeploymentWhatIf, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.resource.resources.v2019_07_01.models._models_py3.WhatIfOperationResult]

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

Parameters

• resource_group_name (str) – The name of the resource group the template will be deployed to. The name is case insensitive.

• deployment_name (str) – The name of the deployment.

• parameters (DeploymentWhatIf) – Parameters to validate.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[WhatIfOperationResult]

Raises

HttpResponseError –

async begin_what_if_at_management_group_scope(group_id: str, deployment_name: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.ScopedDeploymentWhatIf, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.resource.resources.v2019_07_01.models._models_py3.WhatIfOperationResult]

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

Parameters

• group_id (str) – The management group ID.

• deployment_name (str) – The name of the deployment.

• parameters (ScopedDeploymentWhatIf) – Parameters to validate.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[WhatIfOperationResult]

Raises

HttpResponseError –

async begin_what_if_at_subscription_scope(deployment_name: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.DeploymentWhatIf, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.resource.resources.v2019_07_01.models._models_py3.WhatIfOperationResult]

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

Parameters

• deployment_name (str) – The name of the deployment.

• parameters (DeploymentWhatIf) – Parameters to What If.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[WhatIfOperationResult]

Raises

HttpResponseError –

async begin_what_if_at_tenant_scope(deployment_name: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.ScopedDeploymentWhatIf, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.resource.resources.v2019_07_01.models._models_py3.WhatIfOperationResult]

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

Parameters

• deployment_name (str) – The name of the deployment.

• parameters (ScopedDeploymentWhatIf) – Parameters to validate.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[WhatIfOperationResult]

Raises

HttpResponseError –

async calculate_template_hash(template: object, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.TemplateHashResult

Calculate the hash of the given template.

Parameters

template (object) – The template provided to calculate hash.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TemplateHashResult, or the result of cls(response)

Return type

TemplateHashResult

Raises

~azure.core.exceptions.HttpResponseError

async cancel(resource_group_name: str, deployment_name: str, **kwargs) → None

Cancels a currently running template deployment.

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

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive.

• deployment_name (str) – The name of the deployment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

async cancel_at_management_group_scope(group_id: str, deployment_name: str, **kwargs) → None

Cancels a currently running template deployment.

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

Parameters

• group_id (str) – The management group ID.

• deployment_name (str) – The name of the deployment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

async cancel_at_scope(scope: str, deployment_name: str, **kwargs) → None

Cancels a currently running template deployment.

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

Parameters

• scope (str) – The resource scope.

• deployment_name (str) – The name of the deployment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

async cancel_at_subscription_scope(deployment_name: str, **kwargs) → None

Cancels a currently running template deployment.

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

Parameters

deployment_name (str) – The name of the deployment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

async cancel_at_tenant_scope(deployment_name: str, **kwargs) → None

Cancels a currently running template deployment.

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

Parameters

deployment_name (str) – The name of the deployment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

async check_existence(resource_group_name: str, deployment_name: str, **kwargs) → bool

Checks whether the deployment exists.

Parameters

• resource_group_name (str) – The name of the resource group with the deployment to check. The name is case insensitive.

• deployment_name (str) – The name of the deployment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

bool

Raises

~azure.core.exceptions.HttpResponseError

async check_existence_at_management_group_scope(group_id: str, deployment_name: str, **kwargs) → bool

Checks whether the deployment exists.

Parameters

• group_id (str) – The management group ID.

• deployment_name (str) – The name of the deployment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

bool

Raises

~azure.core.exceptions.HttpResponseError

async check_existence_at_scope(scope: str, deployment_name: str, **kwargs) → bool

Checks whether the deployment exists.

Parameters

• scope (str) – The resource scope.

• deployment_name (str) – The name of the deployment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

bool

Raises

~azure.core.exceptions.HttpResponseError

async check_existence_at_subscription_scope(deployment_name: str, **kwargs) → bool

Checks whether the deployment exists.

Parameters

deployment_name (str) – The name of the deployment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

bool

Raises

~azure.core.exceptions.HttpResponseError

async check_existence_at_tenant_scope(deployment_name: str, **kwargs) → bool

Checks whether the deployment exists.

Parameters

deployment_name (str) – The name of the deployment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

bool

Raises

~azure.core.exceptions.HttpResponseError

async export_template(resource_group_name: str, deployment_name: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.DeploymentExportResult

Exports the template used for specified deployment.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive.

• deployment_name (str) – The name of the deployment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeploymentExportResult, or the result of cls(response)

Return type

DeploymentExportResult

Raises

~azure.core.exceptions.HttpResponseError

async export_template_at_management_group_scope(group_id: str, deployment_name: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.DeploymentExportResult

Exports the template used for specified deployment.

Parameters

• group_id (str) – The management group ID.

• deployment_name (str) – The name of the deployment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeploymentExportResult, or the result of cls(response)

Return type

DeploymentExportResult

Raises

~azure.core.exceptions.HttpResponseError

async export_template_at_scope(scope: str, deployment_name: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.DeploymentExportResult

Exports the template used for specified deployment.

Parameters

• scope (str) – The resource scope.

• deployment_name (str) – The name of the deployment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeploymentExportResult, or the result of cls(response)

Return type

DeploymentExportResult

Raises

~azure.core.exceptions.HttpResponseError

async export_template_at_subscription_scope(deployment_name: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.DeploymentExportResult

Exports the template used for specified deployment.

Parameters

deployment_name (str) – The name of the deployment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeploymentExportResult, or the result of cls(response)

Return type

DeploymentExportResult

Raises

~azure.core.exceptions.HttpResponseError

async export_template_at_tenant_scope(deployment_name: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.DeploymentExportResult

Exports the template used for specified deployment.

Parameters

deployment_name (str) – The name of the deployment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeploymentExportResult, or the result of cls(response)

Return type

DeploymentExportResult

Raises

~azure.core.exceptions.HttpResponseError

async get(resource_group_name: str, deployment_name: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.DeploymentExtended

Gets a deployment.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive.

• deployment_name (str) – The name of the deployment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeploymentExtended, or the result of cls(response)

Return type

DeploymentExtended

Raises

~azure.core.exceptions.HttpResponseError

async get_at_management_group_scope(group_id: str, deployment_name: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.DeploymentExtended

Gets a deployment.

Parameters

• group_id (str) – The management group ID.

• deployment_name (str) – The name of the deployment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeploymentExtended, or the result of cls(response)

Return type

DeploymentExtended

Raises

~azure.core.exceptions.HttpResponseError

async get_at_scope(scope: str, deployment_name: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.DeploymentExtended

Gets a deployment.

Parameters

• scope (str) – The resource scope.

• deployment_name (str) – The name of the deployment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeploymentExtended, or the result of cls(response)

Return type

DeploymentExtended

Raises

~azure.core.exceptions.HttpResponseError

async get_at_subscription_scope(deployment_name: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.DeploymentExtended

Gets a deployment.

Parameters

deployment_name (str) – The name of the deployment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeploymentExtended, or the result of cls(response)

Return type

DeploymentExtended

Raises

~azure.core.exceptions.HttpResponseError

async get_at_tenant_scope(deployment_name: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.DeploymentExtended

Gets a deployment.

Parameters

deployment_name (str) – The name of the deployment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeploymentExtended, or the result of cls(response)

Return type

DeploymentExtended

Raises

~azure.core.exceptions.HttpResponseError

list_at_management_group_scope(group_id: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs) → AsyncIterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentListResult]

Get all the deployments for a management group.

Parameters

• group_id (str) – The management group ID.

• filter (str) – The filter to apply on the operation. For example, you can use $filter=provisioningState eq ‘{state}’.

• top (int) – The number of results to get. If null is passed, returns all deployments.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

AsyncItemPaged[DeploymentListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_at_scope(scope: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs) → AsyncIterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentListResult]

Get all the deployments at the given scope.

Parameters

• scope (str) – The resource scope.

• filter (str) – The filter to apply on the operation. For example, you can use $filter=provisioningState eq ‘{state}’.

• top (int) – The number of results to get. If null is passed, returns all deployments.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

AsyncItemPaged[DeploymentListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_at_subscription_scope(filter: Optional[str] = None, top: Optional[int] = None, **kwargs) → AsyncIterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentListResult]

Get all the deployments for a subscription.

Parameters

• filter (str) – The filter to apply on the operation. For example, you can use $filter=provisioningState eq ‘{state}’.

• top (int) – The number of results to get. If null is passed, returns all deployments.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

AsyncItemPaged[DeploymentListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_at_tenant_scope(filter: Optional[str] = None, top: Optional[int] = None, **kwargs) → AsyncIterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentListResult]

Get all the deployments at the tenant scope.

Parameters

• filter (str) – The filter to apply on the operation. For example, you can use $filter=provisioningState eq ‘{state}’.

• top (int) – The number of results to get. If null is passed, returns all deployments.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

AsyncItemPaged[DeploymentListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs) → AsyncIterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentListResult]

Get all the deployments for a resource group.

Parameters

• resource_group_name (str) – The name of the resource group with the deployments to get. The name is case insensitive.

• filter (str) – The filter to apply on the operation. For example, you can use $filter=provisioningState eq ‘{state}’.

• top (int) – The number of results to get. If null is passed, returns all deployments.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

AsyncItemPaged[DeploymentListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.resource.resources.v2020_06_01.models' from 'c:\\repo\\azure-sdk-for-python\\sdk\\resources\\azure-mgmt-resource\\.tox\\sphinx\\lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2020_06_01\\models\\__init__.py'>

class azure.mgmt.resource.resources.v2020_06_01.aio.operations.ProvidersOperations(client, config, serializer, deserializer)

ProvidersOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

async get(resource_provider_namespace: str, expand: Optional[str] = None, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.Provider

Gets the specified resource provider.

Parameters

• resource_provider_namespace (str) – The namespace of the resource provider.

• expand (str) – The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Provider, or the result of cls(response)

Return type

Provider

Raises

~azure.core.exceptions.HttpResponseError

async get_at_tenant_scope(resource_provider_namespace: str, expand: Optional[str] = None, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.Provider

Gets the specified resource provider at the tenant level.

Parameters

• resource_provider_namespace (str) – The namespace of the resource provider.

• expand (str) – The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Provider, or the result of cls(response)

Return type

Provider

Raises

~azure.core.exceptions.HttpResponseError

list(top: Optional[int] = None, expand: Optional[str] = None, **kwargs) → AsyncIterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.ProviderListResult]

Gets all resource providers for a subscription.

Parameters

• top (int) – The number of results to return. If null is passed returns all deployments.

• expand (str) – The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

AsyncItemPaged[ProviderListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_at_tenant_scope(top: Optional[int] = None, expand: Optional[str] = None, **kwargs) → AsyncIterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.ProviderListResult]

Gets all resource providers for the tenant.

Parameters

• top (int) – The number of results to return. If null is passed returns all providers.

• expand (str) – The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

AsyncItemPaged[ProviderListResult]

Raises

~azure.core.exceptions.HttpResponseError

async register(resource_provider_namespace: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.Provider

Registers a subscription with a resource provider.

Parameters

resource_provider_namespace (str) – The namespace of the resource provider to register.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Provider, or the result of cls(response)

Return type

Provider

Raises

~azure.core.exceptions.HttpResponseError

async unregister(resource_provider_namespace: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.Provider

Unregisters a subscription from a resource provider.

Parameters

resource_provider_namespace (str) – The namespace of the resource provider to unregister.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Provider, or the result of cls(response)

Return type

Provider

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.resource.resources.v2020_06_01.models' from 'c:\\repo\\azure-sdk-for-python\\sdk\\resources\\azure-mgmt-resource\\.tox\\sphinx\\lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2020_06_01\\models\\__init__.py'>

class azure.mgmt.resource.resources.v2020_06_01.aio.operations.ResourcesOperations(client, config, serializer, deserializer)

ResourcesOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

async begin_create_or_update(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.GenericResource, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.GenericResource]

Creates a resource.

Parameters

• resource_group_name (str) – The name of the resource group for the resource. The name is case insensitive.

• resource_provider_namespace (str) – The namespace of the resource provider.

• parent_resource_path (str) – The parent resource identity.

• resource_type (str) – The resource type of the resource to create.

• resource_name (str) – The name of the resource to create.

• api_version (str) – The API version to use for the operation.

• parameters (GenericResource) – Parameters for creating or updating the resource.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[GenericResource]

Raises

HttpResponseError –

async begin_create_or_update_by_id(resource_id: str, api_version: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.GenericResource, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.GenericResource]

Create a resource by ID.

Parameters

• resource_id (str) – The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group- name}/{resource-provider-namespace}/{resource-type}/{resource-name}.

• api_version (str) – The API version to use for the operation.

• parameters (GenericResource) – Create or update resource parameters.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[GenericResource]

Raises

HttpResponseError –

async begin_delete(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[None]

Deletes a resource.

Parameters

• resource_group_name (str) – The name of the resource group that contains the resource to delete. The name is case insensitive.

• resource_provider_namespace (str) – The namespace of the resource provider.

• parent_resource_path (str) – The parent resource identity.

• resource_type (str) – The resource type.

• resource_name (str) – The name of the resource to delete.

• api_version (str) – The API version to use for the operation.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[None]

Raises

HttpResponseError –

async begin_delete_by_id(resource_id: str, api_version: str, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[None]

Deletes a resource by ID.

Parameters

• resource_id (str) – The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group- name}/{resource-provider-namespace}/{resource-type}/{resource-name}.

• api_version (str) – The API version to use for the operation.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[None]

Raises

HttpResponseError –

async begin_move_resources(source_resource_group_name: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.ResourcesMoveInfo, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[None]

Moves resources from one resource group to another resource group.

The resources to move must be in the same source resource group. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes.

Parameters

• source_resource_group_name (str) – The name of the resource group containing the resources to move.

• parameters (ResourcesMoveInfo) – Parameters for moving resources.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[None]

Raises

HttpResponseError –

async begin_update(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.GenericResource, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.GenericResource]

Updates a resource.

Parameters

• resource_group_name (str) – The name of the resource group for the resource. The name is case insensitive.

• resource_provider_namespace (str) – The namespace of the resource provider.

• parent_resource_path (str) – The parent resource identity.

• resource_type (str) – The resource type of the resource to update.

• resource_name (str) – The name of the resource to update.

• api_version (str) – The API version to use for the operation.

• parameters (GenericResource) – Parameters for updating the resource.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[GenericResource]

Raises

HttpResponseError –

async begin_update_by_id(resource_id: str, api_version: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.GenericResource, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.GenericResource]

Updates a resource by ID.

Parameters

• resource_id (str) – The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group- name}/{resource-provider-namespace}/{resource-type}/{resource-name}.

• api_version (str) – The API version to use for the operation.

• parameters (GenericResource) – Update resource parameters.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[GenericResource]

Raises

HttpResponseError –

async begin_validate_move_resources(source_resource_group_name: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.ResourcesMoveInfo, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[None]

Validates whether resources can be moved from one resource group to another resource group.

This operation checks whether the specified resources can be moved to the target. The resources to move must be in the same source resource group. The target resource group may be in a different subscription. If validation succeeds, it returns HTTP response code 204 (no content). If validation fails, it returns HTTP response code 409 (Conflict) with an error message. Retrieve the URL in the Location header value to check the result of the long-running operation.

Parameters

• source_resource_group_name (str) – The name of the resource group containing the resources to validate for move.

• parameters (ResourcesMoveInfo) – Parameters for moving resources.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[None]

Raises

HttpResponseError –

async check_existence(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs) → bool

Checks whether a resource exists.

Parameters

• resource_group_name (str) – The name of the resource group containing the resource to check. The name is case insensitive.

• resource_provider_namespace (str) – The resource provider of the resource to check.

• parent_resource_path (str) – The parent resource identity.

• resource_type (str) – The resource type.

• resource_name (str) – The name of the resource to check whether it exists.

• api_version (str) – The API version to use for the operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

bool

Raises

~azure.core.exceptions.HttpResponseError

async check_existence_by_id(resource_id: str, api_version: str, **kwargs) → bool

Checks by ID whether a resource exists.

Parameters

• resource_id (str) – The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group- name}/{resource-provider-namespace}/{resource-type}/{resource-name}.

• api_version (str) – The API version to use for the operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

bool

Raises

~azure.core.exceptions.HttpResponseError

async get(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.GenericResource

Gets a resource.

Parameters

• resource_group_name (str) – The name of the resource group containing the resource to get. The name is case insensitive.

• resource_provider_namespace (str) – The namespace of the resource provider.

• parent_resource_path (str) – The parent resource identity.

• resource_type (str) – The resource type of the resource.

• resource_name (str) – The name of the resource to get.

• api_version (str) – The API version to use for the operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

GenericResource, or the result of cls(response)

Return type

GenericResource

Raises

~azure.core.exceptions.HttpResponseError

async get_by_id(resource_id: str, api_version: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.GenericResource

Gets a resource by ID.

Parameters

• resource_id (str) – The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group- name}/{resource-provider-namespace}/{resource-type}/{resource-name}.

• api_version (str) – The API version to use for the operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

GenericResource, or the result of cls(response)

Return type

GenericResource

Raises

~azure.core.exceptions.HttpResponseError

list(filter: Optional[str] = None, expand: Optional[str] = None, top: Optional[int] = None, **kwargs) → AsyncIterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.ResourceListResult]

Get all the resources in a subscription.

Parameters

• filter (str) – The filter to apply on the operation.:code:<br><br>`The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.:code:`<br><br>`For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks':code:`<br><br>`You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.:code:`<br><br>`For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name):code:`<br><br>`You can link more than one substringof together by adding and/or operators.:code:`<br><br>`You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. When you filter by a tag name and value, the tags for each resource are not returned in the results.:code:`<br>:code:`<br>`You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId.

• expand (str) – Comma-separated list of additional properties to be included in the response. Valid values include createdTime, changedTime and provisioningState. For example, $expand=createdTime,changedTime.

• top (int) – The number of results to return. If null is passed, returns all resource groups.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

AsyncItemPaged[ResourceListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, filter: Optional[str] = None, expand: Optional[str] = None, top: Optional[int] = None, **kwargs) → AsyncIterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.ResourceListResult]

Get all the resources for a resource group.

Parameters

• resource_group_name (str) – The resource group with the resources to get.

• filter (str) – The filter to apply on the operation.:code:<br><br>`The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.:code:`<br><br>`For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks':code:`<br><br>`You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.:code:`<br><br>`For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name):code:`<br><br>`You can link more than one substringof together by adding and/or operators.:code:`<br><br>`You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. When you filter by a tag name and value, the tags for each resource are not returned in the results.:code:`<br>:code:`<br>`You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId.

• expand (str) – Comma-separated list of additional properties to be included in the response. Valid values include createdTime, changedTime and provisioningState. For example, $expand=createdTime,changedTime.

• top (int) – The number of results to return. If null is passed, returns all resources.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

AsyncItemPaged[ResourceListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.resource.resources.v2020_06_01.models' from 'c:\\repo\\azure-sdk-for-python\\sdk\\resources\\azure-mgmt-resource\\.tox\\sphinx\\lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2020_06_01\\models\\__init__.py'>

class azure.mgmt.resource.resources.v2020_06_01.aio.operations.ResourceGroupsOperations(client, config, serializer, deserializer)

ResourceGroupsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

async begin_delete(resource_group_name: str, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[None]

Deletes a resource group.

When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.

Parameters

resource_group_name (str) – The name of the resource group to delete. The name is case insensitive.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[None]

Raises

HttpResponseError –

async begin_export_template(resource_group_name: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.ExportTemplateRequest, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.resource.resources.v2019_08_01.models._models_py3.ResourceGroupExportResult]

Captures the specified resource group as a template.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive.

• parameters (ExportTemplateRequest) – Parameters for exporting the template.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[ResourceGroupExportResult]

Raises

HttpResponseError –

async check_existence(resource_group_name: str, **kwargs) → bool

Checks whether a resource group exists.

Parameters

resource_group_name (str) – The name of the resource group to check. The name is case insensitive.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

bool

Raises

~azure.core.exceptions.HttpResponseError

async create_or_update(resource_group_name: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.ResourceGroup, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.ResourceGroup

Creates or updates a resource group.

Parameters

• resource_group_name (str) – The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters.

• parameters (ResourceGroup) – Parameters supplied to the create or update a resource group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ResourceGroup, or the result of cls(response)

Return type

ResourceGroup

Raises

~azure.core.exceptions.HttpResponseError

async get(resource_group_name: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.ResourceGroup

Gets a resource group.

Parameters

resource_group_name (str) – The name of the resource group to get. The name is case insensitive.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ResourceGroup, or the result of cls(response)

Return type

ResourceGroup

Raises

~azure.core.exceptions.HttpResponseError

list(filter: Optional[str] = None, top: Optional[int] = None, **kwargs) → AsyncIterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.ResourceGroupListResult]

Gets all the resource groups for a subscription.

Parameters

• filter (str) – The filter to apply on the operation.:code:<br>:code:`<br>`You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq ‘tag1’ and tagValue eq ‘Value1’.

• top (int) – The number of results to return. If null is passed, returns all resource groups.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

AsyncItemPaged[ResourceGroupListResult]

Raises

~azure.core.exceptions.HttpResponseError

async update(resource_group_name: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.ResourceGroupPatchable, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.ResourceGroup

Updates a resource group.

Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.

Parameters

• resource_group_name (str) – The name of the resource group to update. The name is case insensitive.

• parameters (ResourceGroupPatchable) – Parameters supplied to update a resource group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ResourceGroup, or the result of cls(response)

Return type

ResourceGroup

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.resource.resources.v2020_06_01.models' from 'c:\\repo\\azure-sdk-for-python\\sdk\\resources\\azure-mgmt-resource\\.tox\\sphinx\\lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2020_06_01\\models\\__init__.py'>

class azure.mgmt.resource.resources.v2020_06_01.aio.operations.TagsOperations(client, config, serializer, deserializer)

TagsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

async create_or_update(tag_name: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.TagDetails

Creates a predefined tag name.

This operation allows adding a name to the list of predefined tag names for the given subscription. A tag name can have a maximum of 512 characters and is case-insensitive. Tag names cannot have the following prefixes which are reserved for Azure use: ‘microsoft’, ‘azure’, ‘windows’.

Parameters

tag_name (str) – The name of the tag to create.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TagDetails, or the result of cls(response)

Return type

TagDetails

Raises

~azure.core.exceptions.HttpResponseError

async create_or_update_at_scope(scope: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.TagsResource, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.TagsResource

Creates or updates the entire set of tags on a resource or subscription.

This operation allows adding or replacing the entire set of tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags.

Parameters

• scope (str) – The resource scope.

• parameters (TagsResource) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TagsResource, or the result of cls(response)

Return type

TagsResource

Raises

~azure.core.exceptions.HttpResponseError

async create_or_update_value(tag_name: str, tag_value: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.TagValue

Creates a predefined value for a predefined tag name.

This operation allows adding a value to the list of predefined values for an existing predefined tag name. A tag value can have a maximum of 256 characters.

Parameters

• tag_name (str) – The name of the tag.

• tag_value (str) – The value of the tag to create.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TagValue, or the result of cls(response)

Return type

TagValue

Raises

~azure.core.exceptions.HttpResponseError

async delete(tag_name: str, **kwargs) → None

Deletes a predefined tag name.

This operation allows deleting a name from the list of predefined tag names for the given subscription. The name being deleted must not be in use as a tag name for any resource. All predefined values for the given name must have already been deleted.

Parameters

tag_name (str) – The name of the tag.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

async delete_at_scope(scope: str, **kwargs) → None

Deletes the entire set of tags on a resource or subscription.

Deletes the entire set of tags on a resource or subscription.

Parameters

scope (str) – The resource scope.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

async delete_value(tag_name: str, tag_value: str, **kwargs) → None

Deletes a predefined tag value for a predefined tag name.

This operation allows deleting a value from the list of predefined values for an existing predefined tag name. The value being deleted must not be in use as a tag value for the given tag name for any resource.

Parameters

• tag_name (str) – The name of the tag.

• tag_value (str) – The value of the tag to delete.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

async get_at_scope(scope: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.TagsResource

Gets the entire set of tags on a resource or subscription.

Gets the entire set of tags on a resource or subscription.

Parameters

scope (str) – The resource scope.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TagsResource, or the result of cls(response)

Return type

TagsResource

Raises

~azure.core.exceptions.HttpResponseError

list(**kwargs) → AsyncIterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.TagsListResult]

Gets a summary of tag usage under the subscription.

This operation performs a union of predefined tags, resource tags, resource group tags and subscription tags, and returns a summary of usage for each tag name and value under the given subscription. In case of a large number of tags, this operation may return a previously cached result.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

AsyncItemPaged[TagsListResult]

Raises

~azure.core.exceptions.HttpResponseError

async update_at_scope(scope: str, parameters: azure.mgmt.resource.resources.v2020_06_01.models._models_py3.TagsPatchResource, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.TagsResource

Selectively updates the set of tags on a resource or subscription.

This operation allows replacing, merging or selectively deleting tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags at the end of the operation. The ‘replace’ option replaces the entire set of existing tags with a new set. The ‘merge’ option allows adding tags with new names and updating the values of tags with existing names. The ‘delete’ option allows selectively deleting tags based on given names or name/value pairs.

Parameters

• scope (str) – The resource scope.

• parameters (TagsPatchResource) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TagsResource, or the result of cls(response)

Return type

TagsResource

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.resource.resources.v2020_06_01.models' from 'c:\\repo\\azure-sdk-for-python\\sdk\\resources\\azure-mgmt-resource\\.tox\\sphinx\\lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2020_06_01\\models\\__init__.py'>

class azure.mgmt.resource.resources.v2020_06_01.aio.operations.DeploymentOperationsOperations(client, config, serializer, deserializer)

DeploymentOperationsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

async get(resource_group_name: str, deployment_name: str, operation_id: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.DeploymentOperation

Gets a deployments operation.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive.

• deployment_name (str) – The name of the deployment.

• operation_id (str) – The ID of the operation to get.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeploymentOperation, or the result of cls(response)

Return type

DeploymentOperation

Raises

~azure.core.exceptions.HttpResponseError

async get_at_management_group_scope(group_id: str, deployment_name: str, operation_id: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.DeploymentOperation

Gets a deployments operation.

Parameters

• group_id (str) – The management group ID.

• deployment_name (str) – The name of the deployment.

• operation_id (str) – The ID of the operation to get.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeploymentOperation, or the result of cls(response)

Return type

DeploymentOperation

Raises

~azure.core.exceptions.HttpResponseError

async get_at_scope(scope: str, deployment_name: str, operation_id: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.DeploymentOperation

Gets a deployments operation.

Parameters

• scope (str) – The resource scope.

• deployment_name (str) – The name of the deployment.

• operation_id (str) – The ID of the operation to get.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeploymentOperation, or the result of cls(response)

Return type

DeploymentOperation

Raises

~azure.core.exceptions.HttpResponseError

async get_at_subscription_scope(deployment_name: str, operation_id: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.DeploymentOperation

Gets a deployments operation.

Parameters

• deployment_name (str) – The name of the deployment.

• operation_id (str) – The ID of the operation to get.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeploymentOperation, or the result of cls(response)

Return type

DeploymentOperation

Raises

~azure.core.exceptions.HttpResponseError

async get_at_tenant_scope(deployment_name: str, operation_id: str, **kwargs) → azure.mgmt.resource.resources.v2020_06_01.models._models_py3.DeploymentOperation

Gets a deployments operation.

Parameters

• deployment_name (str) – The name of the deployment.

• operation_id (str) – The ID of the operation to get.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeploymentOperation, or the result of cls(response)

Return type

DeploymentOperation

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, deployment_name: str, top: Optional[int] = None, **kwargs) → AsyncIterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentOperationsListResult]

Gets all deployments operations for a deployment.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive.

• deployment_name (str) – The name of the deployment.

• top (int) – The number of results to return.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

AsyncItemPaged[DeploymentOperationsListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_at_management_group_scope(group_id: str, deployment_name: str, top: Optional[int] = None, **kwargs) → AsyncIterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentOperationsListResult]

Gets all deployments operations for a deployment.

Parameters

• group_id (str) – The management group ID.

• deployment_name (str) – The name of the deployment.

• top (int) – The number of results to return.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

AsyncItemPaged[DeploymentOperationsListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_at_scope(scope: str, deployment_name: str, top: Optional[int] = None, **kwargs) → AsyncIterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentOperationsListResult]

Gets all deployments operations for a deployment.

Parameters

• scope (str) – The resource scope.

• deployment_name (str) – The name of the deployment.

• top (int) – The number of results to return.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

AsyncItemPaged[DeploymentOperationsListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_at_subscription_scope(deployment_name: str, top: Optional[int] = None, **kwargs) → AsyncIterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentOperationsListResult]

Gets all deployments operations for a deployment.

Parameters

• deployment_name (str) – The name of the deployment.

• top (int) – The number of results to return.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

AsyncItemPaged[DeploymentOperationsListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_at_tenant_scope(deployment_name: str, top: Optional[int] = None, **kwargs) → AsyncIterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentOperationsListResult]

Gets all deployments operations for a deployment.

Parameters

• deployment_name (str) – The name of the deployment.

• top (int) – The number of results to return.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

AsyncItemPaged[DeploymentOperationsListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.resource.resources.v2020_06_01.models' from 'c:\\repo\\azure-sdk-for-python\\sdk\\resources\\azure-mgmt-resource\\.tox\\sphinx\\lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2020_06_01\\models\\__init__.py'>