From ee7162d6f3002d56dec9ee29e23ef1dea9b89631 Mon Sep 17 00:00:00 2001 From: SDKAuto Date: Mon, 28 Apr 2025 13:15:37 +0000 Subject: [PATCH] CodeGen from PR 34190 in Azure/azure-rest-api-specs Merge e0921a93862786f1849e148050b399e18c0e4b25 into 17365a7eb28d3ee578e5307f6091ee172bdfbfa3 --- .../CHANGELOG.md | 7 + .../LICENSE | 21 + .../MANIFEST.in | 9 + .../README.md | 61 + .../_meta.json | 11 + .../azure/__init__.py | 1 + .../azure/mgmt/__init__.py | 1 + .../azure/mgmt/deployments/__init__.py | 1 + .../mgmt/deployments/deployments/__init__.py | 32 + .../deployments/deployments/_configuration.py | 64 + .../deployments/_deployments_client.py | 121 + .../mgmt/deployments/deployments/_patch.py | 21 + .../deployments/_utils/__init__.py | 6 + .../deployments/_utils/serialization.py | 2032 ++++++ .../mgmt/deployments/deployments/_version.py | 9 + .../deployments/deployments/aio/__init__.py | 29 + .../deployments/aio/_configuration.py | 64 + .../deployments/aio/_deployments_client.py | 125 + .../deployments/deployments/aio/_patch.py | 21 + .../deployments/aio/operations/__init__.py | 27 + .../_deployment_operations_operations.py | 775 +++ .../aio/operations/_deployments_operations.py | 4789 +++++++++++++ .../deployments/aio/operations/_patch.py | 21 + .../deployments/models/__init__.py | 172 + .../models/_deployments_client_enums.py | 244 + .../deployments/models/_models_py3.py | 2656 +++++++ .../deployments/deployments/models/_patch.py | 21 + .../deployments/operations/__init__.py | 27 + .../_deployment_operations_operations.py | 1093 +++ .../operations/_deployments_operations.py | 6164 +++++++++++++++++ .../deployments/operations/_patch.py | 21 + .../mgmt/deployments/deployments/py.typed | 1 + .../dev_requirements.txt | 2 + .../calculate_template_hash.py | 55 + ...deployment_validate_on_management_group.py | 51 + ...t_deployment_validate_on_resource_group.py | 53 + .../post_deployment_validate_on_scope.py | 53 + ...ost_deployment_validate_on_subscription.py | 50 + .../post_deployment_validate_on_tenant.py | 50 + ..._deployment_what_if_on_management_group.py | 51 + ...st_deployment_what_if_on_resource_group.py | 50 + ...post_deployment_what_if_on_subscription.py | 50 + .../post_deployment_what_if_on_tenant.py | 50 + .../put_deployment_at_management_group.py | 51 + .../put_deployment_at_scope.py | 52 + .../put_deployment_at_tenant.py | 51 + .../put_deployment_resource_group.py | 53 + ...t_resource_group_template_specs_with_id.py | 52 + ...ent_subscription_template_specs_with_id.py | 52 + .../put_deployment_with_external_inputs.py | 58 + ...ith_on_error_deployment_last_successful.py | 51 + ...on_error_deployment_specific_deployment.py | 51 + .../generated_tests/conftest.py | 35 + ...yments_deployment_operations_operations.py | 140 + ..._deployment_operations_operations_async.py | 141 + ...test_deployments_deployments_operations.py | 1148 +++ ...eployments_deployments_operations_async.py | 1187 ++++ .../pyproject.toml | 2 + .../sdk_packaging.toml | 12 + .../setup.py | 83 + sdk/deployments/ci.yml | 34 + 61 files changed, 22415 insertions(+) create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/CHANGELOG.md create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/LICENSE create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/MANIFEST.in create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/README.md create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/_meta.json create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/__init__.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/__init__.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/__init__.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/__init__.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_configuration.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_deployments_client.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_patch.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_utils/__init__.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_utils/serialization.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_version.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/__init__.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/_configuration.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/_deployments_client.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/_patch.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/operations/__init__.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/operations/_deployment_operations_operations.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/operations/_deployments_operations.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/operations/_patch.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/models/__init__.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/models/_deployments_client_enums.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/models/_models_py3.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/models/_patch.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/operations/__init__.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/operations/_deployment_operations_operations.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/operations/_deployments_operations.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/operations/_patch.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/py.typed create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/dev_requirements.txt create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/calculate_template_hash.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_validate_on_management_group.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_validate_on_resource_group.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_validate_on_scope.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_validate_on_subscription.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_validate_on_tenant.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_what_if_on_management_group.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_what_if_on_resource_group.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_what_if_on_subscription.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_what_if_on_tenant.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_at_management_group.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_at_scope.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_at_tenant.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_resource_group.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_resource_group_template_specs_with_id.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_subscription_template_specs_with_id.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_with_external_inputs.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_with_on_error_deployment_last_successful.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_with_on_error_deployment_specific_deployment.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_tests/conftest.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_tests/test_deployments_deployment_operations_operations.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_tests/test_deployments_deployment_operations_operations_async.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_tests/test_deployments_deployments_operations.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/generated_tests/test_deployments_deployments_operations_async.py create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/pyproject.toml create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/sdk_packaging.toml create mode 100644 sdk/deployments/azure-mgmt-deployments-deployments/setup.py create mode 100644 sdk/deployments/ci.yml diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/CHANGELOG.md b/sdk/deployments/azure-mgmt-deployments-deployments/CHANGELOG.md new file mode 100644 index 000000000000..ff6222ad5944 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/CHANGELOG.md @@ -0,0 +1,7 @@ +# Release History + +## 1.0.0b1 (2025-04-28) + +### Other Changes + + - Initial version diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/LICENSE b/sdk/deployments/azure-mgmt-deployments-deployments/LICENSE new file mode 100644 index 000000000000..b2f52a2bad4e --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/LICENSE @@ -0,0 +1,21 @@ +Copyright (c) Microsoft Corporation. + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/MANIFEST.in b/sdk/deployments/azure-mgmt-deployments-deployments/MANIFEST.in new file mode 100644 index 000000000000..dfecc59ca6a0 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/MANIFEST.in @@ -0,0 +1,9 @@ +include _meta.json +recursive-include tests *.py *.json +recursive-include samples *.py *.md +include *.md +include azure/__init__.py +include azure/mgmt/__init__.py +include azure/mgmt/deployments/__init__.py +include LICENSE +include azure/mgmt/deployments/deployments/py.typed diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/README.md b/sdk/deployments/azure-mgmt-deployments-deployments/README.md new file mode 100644 index 000000000000..171fbc5cd216 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/README.md @@ -0,0 +1,61 @@ +# Microsoft Azure SDK for Python + +This is the Microsoft Azure Deployments-deployments Management Client Library. +This package has been tested with Python 3.9+. +For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all). + +## _Disclaimer_ + +_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_ + +## Getting started + +### Prerequisites + +- Python 3.9+ is required to use this package. +- [Azure subscription](https://azure.microsoft.com/free/) + +### Install the package + +```bash +pip install azure-mgmt-deployments-deployments +pip install azure-identity +``` + +### Authentication + +By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configuration of the following environment variables. + +- `AZURE_CLIENT_ID` for Azure client ID. +- `AZURE_TENANT_ID` for Azure tenant ID. +- `AZURE_CLIENT_SECRET` for Azure client secret. + +In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`. + +With above configuration, client can be authenticated by following code: + +```python +from azure.identity import DefaultAzureCredential +from azure.mgmt.deployments.deployments import DeploymentsClient +import os + +sub_id = os.getenv("AZURE_SUBSCRIPTION_ID") +client = DeploymentsClient(credential=DefaultAzureCredential(), subscription_id=sub_id) +``` + +## Examples + +Code samples for this package can be found at: +- [Search Deployments-deployments Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com +- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples) + + +## Troubleshooting + +## Next steps + +## Provide Feedback + +If you encounter any bugs or have suggestions, please file an issue in the +[Issues](https://github.com/Azure/azure-sdk-for-python/issues) +section of the project. diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/_meta.json b/sdk/deployments/azure-mgmt-deployments-deployments/_meta.json new file mode 100644 index 000000000000..5d846c0ff4b3 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/_meta.json @@ -0,0 +1,11 @@ +{ + "commit": "fcbc290cc06b0d69207105d83bb7dac49c21675b", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "autorest": "3.10.2", + "use": [ + "@autorest/python@6.34.1", + "@autorest/modelerfour@4.27.0" + ], + "autorest_command": "autorest specification/resources/resource-manager/Microsoft.Resources/deployments/readme.md --generate-sample=True --generate-test=True --include-x-ms-examples-original-file=True --python --python-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-python/sdk --use=@autorest/python@6.34.1 --use=@autorest/modelerfour@4.27.0 --version=3.10.2 --version-tolerant=False", + "readme": "specification/resources/resource-manager/Microsoft.Resources/deployments/readme.md" +} \ No newline at end of file diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/__init__.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/__init__.py new file mode 100644 index 000000000000..8db66d3d0f0f --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/__init__.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/__init__.py new file mode 100644 index 000000000000..8db66d3d0f0f --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/__init__.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/__init__.py new file mode 100644 index 000000000000..8db66d3d0f0f --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/__init__.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/__init__.py new file mode 100644 index 000000000000..deba90a928ac --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/__init__.py @@ -0,0 +1,32 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._deployments_client import DeploymentsClient # type: ignore +from ._version import VERSION + +__version__ = VERSION + +try: + from ._patch import __all__ as _patch_all + from ._patch import * +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "DeploymentsClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore + +_patch_sdk() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_configuration.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_configuration.py new file mode 100644 index 000000000000..d7ca7e642081 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_configuration.py @@ -0,0 +1,64 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, TYPE_CHECKING + +from azure.core.pipeline import policies +from azure.mgmt.core.policies import ARMChallengeAuthenticationPolicy, ARMHttpLoggingPolicy + +from ._version import VERSION + +if TYPE_CHECKING: + from azure.core.credentials import TokenCredential + + +class DeploymentsClientConfiguration: # pylint: disable=too-many-instance-attributes + """Configuration for DeploymentsClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.TokenCredential + :param subscription_id: The Microsoft Azure subscription ID. Required. + :type subscription_id: str + :keyword api_version: Api Version. Default value is "2025-04-01". Note that overriding this + default value may result in unsupported behavior. + :paramtype api_version: str + """ + + def __init__(self, credential: "TokenCredential", subscription_id: str, **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2025-04-01") + + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + if subscription_id is None: + raise ValueError("Parameter 'subscription_id' must not be None.") + + self.credential = credential + self.subscription_id = subscription_id + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://management.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "mgmt-deployments-deployments/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or ARMHttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = ARMChallengeAuthenticationPolicy( + self.credential, *self.credential_scopes, **kwargs + ) diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_deployments_client.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_deployments_client.py new file mode 100644 index 000000000000..d5b91048d190 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_deployments_client.py @@ -0,0 +1,121 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, Optional, TYPE_CHECKING, cast +from typing_extensions import Self + +from azure.core.pipeline import policies +from azure.core.rest import HttpRequest, HttpResponse +from azure.core.settings import settings +from azure.mgmt.core import ARMPipelineClient +from azure.mgmt.core.policies import ARMAutoResourceProviderRegistrationPolicy +from azure.mgmt.core.tools import get_arm_endpoints + +from . import models as _models +from ._configuration import DeploymentsClientConfiguration +from ._utils.serialization import Deserializer, Serializer +from .operations import DeploymentOperationsOperations, DeploymentsOperations + +if TYPE_CHECKING: + from azure.core.credentials import TokenCredential + + +class DeploymentsClient: + """Deployments Client. + + :ivar deployments: DeploymentsOperations operations + :vartype deployments: azure.mgmt.deployments.deployments.operations.DeploymentsOperations + :ivar deployment_operations: DeploymentOperationsOperations operations + :vartype deployment_operations: + azure.mgmt.deployments.deployments.operations.DeploymentOperationsOperations + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.TokenCredential + :param subscription_id: The Microsoft Azure subscription ID. Required. + :type subscription_id: str + :param base_url: Service URL. Default value is None. + :type base_url: str + :keyword api_version: Api Version. Default value is "2025-04-01". Note that overriding this + default value may result in unsupported behavior. + :paramtype api_version: str + :keyword int polling_interval: Default waiting time between two polls for LRO operations if no + Retry-After header is present. + """ + + def __init__( + self, credential: "TokenCredential", subscription_id: str, base_url: Optional[str] = None, **kwargs: Any + ) -> None: + _cloud = kwargs.pop("cloud_setting", None) or settings.current.azure_cloud # type: ignore + _endpoints = get_arm_endpoints(_cloud) + if not base_url: + base_url = _endpoints["resource_manager"] + credential_scopes = kwargs.pop("credential_scopes", _endpoints["credential_scopes"]) + self._config = DeploymentsClientConfiguration( + credential=credential, subscription_id=subscription_id, credential_scopes=credential_scopes, **kwargs + ) + + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + ARMAutoResourceProviderRegistrationPolicy(), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: ARMPipelineClient = ARMPipelineClient(base_url=cast(str, base_url), policies=_policies, **kwargs) + + client_models = {k: v for k, v in _models.__dict__.items() if isinstance(v, type)} + self._serialize = Serializer(client_models) + self._deserialize = Deserializer(client_models) + self._serialize.client_side_validation = False + self.deployments = DeploymentsOperations(self._client, self._config, self._serialize, self._deserialize) + self.deployment_operations = DeploymentOperationsOperations( + self._client, self._config, self._serialize, self._deserialize + ) + + def _send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = client._send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.HttpResponse + """ + + request_copy = deepcopy(request) + request_copy.url = self._client.format_url(request_copy.url) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + def close(self) -> None: + self._client.close() + + def __enter__(self) -> Self: + self._client.__enter__() + return self + + def __exit__(self, *exc_details: Any) -> None: + self._client.__exit__(*exc_details) diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_patch.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_patch.py new file mode 100644 index 000000000000..8bcb627aa475 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_patch.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_utils/__init__.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_utils/__init__.py new file mode 100644 index 000000000000..0af9b28f6607 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_utils/__init__.py @@ -0,0 +1,6 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_utils/serialization.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_utils/serialization.py new file mode 100644 index 000000000000..f5187701d7be --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_utils/serialization.py @@ -0,0 +1,2032 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +# pyright: reportUnnecessaryTypeIgnoreComment=false + +from base64 import b64decode, b64encode +import calendar +import datetime +import decimal +import email +from enum import Enum +import json +import logging +import re +import sys +import codecs +from typing import ( + Dict, + Any, + cast, + Optional, + Union, + AnyStr, + IO, + Mapping, + Callable, + MutableMapping, + List, +) + +try: + from urllib import quote # type: ignore +except ImportError: + from urllib.parse import quote +import xml.etree.ElementTree as ET + +import isodate # type: ignore +from typing_extensions import Self + +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull + +_BOM = codecs.BOM_UTF8.decode(encoding="utf-8") + +JSON = MutableMapping[str, Any] + + +class RawDeserializer: + + # Accept "text" because we're open minded people... + JSON_REGEXP = re.compile(r"^(application|text)/([a-z+.]+\+)?json$") + + # Name used in context + CONTEXT_NAME = "deserialized_data" + + @classmethod + def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: Optional[str] = None) -> Any: + """Decode data according to content-type. + + Accept a stream of data as well, but will be load at once in memory for now. + + If no content-type, will return the string version (not bytes, not stream) + + :param data: Input, could be bytes or stream (will be decoded with UTF8) or text + :type data: str or bytes or IO + :param str content_type: The content type. + :return: The deserialized data. + :rtype: object + """ + if hasattr(data, "read"): + # Assume a stream + data = cast(IO, data).read() + + if isinstance(data, bytes): + data_as_str = data.decode(encoding="utf-8-sig") + else: + # Explain to mypy the correct type. + data_as_str = cast(str, data) + + # Remove Byte Order Mark if present in string + data_as_str = data_as_str.lstrip(_BOM) + + if content_type is None: + return data + + if cls.JSON_REGEXP.match(content_type): + try: + return json.loads(data_as_str) + except ValueError as err: + raise DeserializationError("JSON is invalid: {}".format(err), err) from err + elif "xml" in (content_type or []): + try: + + try: + if isinstance(data, unicode): # type: ignore + # If I'm Python 2.7 and unicode XML will scream if I try a "fromstring" on unicode string + data_as_str = data_as_str.encode(encoding="utf-8") # type: ignore + except NameError: + pass + + return ET.fromstring(data_as_str) # nosec + except ET.ParseError as err: + # It might be because the server has an issue, and returned JSON with + # content-type XML.... + # So let's try a JSON load, and if it's still broken + # let's flow the initial exception + def _json_attemp(data): + try: + return True, json.loads(data) + except ValueError: + return False, None # Don't care about this one + + success, json_result = _json_attemp(data) + if success: + return json_result + # If i'm here, it's not JSON, it's not XML, let's scream + # and raise the last context in this block (the XML exception) + # The function hack is because Py2.7 messes up with exception + # context otherwise. + _LOGGER.critical("Wasn't XML not JSON, failing") + raise DeserializationError("XML is invalid") from err + elif content_type.startswith("text/"): + return data_as_str + raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) + + @classmethod + def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], headers: Mapping) -> Any: + """Deserialize from HTTP response. + + Use bytes and headers to NOT use any requests/aiohttp or whatever + specific implementation. + Headers will tested for "content-type" + + :param bytes body_bytes: The body of the response. + :param dict headers: The headers of the response. + :returns: The deserialized data. + :rtype: object + """ + # Try to use content-type from headers if available + content_type = None + if "content-type" in headers: + content_type = headers["content-type"].split(";")[0].strip().lower() + # Ouch, this server did not declare what it sent... + # Let's guess it's JSON... + # Also, since Autorest was considering that an empty body was a valid JSON, + # need that test as well.... + else: + content_type = "application/json" + + if body_bytes: + return cls.deserialize_from_text(body_bytes, content_type) + return None + + +_LOGGER = logging.getLogger(__name__) + +try: + _long_type = long # type: ignore +except NameError: + _long_type = int + +TZ_UTC = datetime.timezone.utc + +_FLATTEN = re.compile(r"(? None: + self.additional_properties: Optional[Dict[str, Any]] = {} + for k in kwargs: # pylint: disable=consider-using-dict-items + if k not in self._attribute_map: + _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) + elif k in self._validation and self._validation[k].get("readonly", False): + _LOGGER.warning("Readonly attribute %s will be ignored in class %s", k, self.__class__) + else: + setattr(self, k, kwargs[k]) + + def __eq__(self, other: Any) -> bool: + """Compare objects by comparing all attributes. + + :param object other: The object to compare + :returns: True if objects are equal + :rtype: bool + """ + if isinstance(other, self.__class__): + return self.__dict__ == other.__dict__ + return False + + def __ne__(self, other: Any) -> bool: + """Compare objects by comparing all attributes. + + :param object other: The object to compare + :returns: True if objects are not equal + :rtype: bool + """ + return not self.__eq__(other) + + def __str__(self) -> str: + return str(self.__dict__) + + @classmethod + def enable_additional_properties_sending(cls) -> None: + cls._attribute_map["additional_properties"] = {"key": "", "type": "{object}"} + + @classmethod + def is_xml_model(cls) -> bool: + try: + cls._xml_map # type: ignore + except AttributeError: + return False + return True + + @classmethod + def _create_xml_node(cls): + """Create XML node. + + :returns: The XML node + :rtype: xml.etree.ElementTree.Element + """ + try: + xml_map = cls._xml_map # type: ignore + except AttributeError: + xml_map = {} + + return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) + + def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: + """Return the JSON that would be sent to server from this model. + + This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`. + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, keep_readonly=keep_readonly, **kwargs + ) + + def as_dict( + self, + keep_readonly: bool = True, + key_transformer: Callable[[str, Dict[str, Any], Any], Any] = attribute_transformer, + **kwargs: Any + ) -> JSON: + """Return a dict that can be serialized using json.dump. + + Advanced usage might optionally use a callback as parameter: + + .. code::python + + def my_key_transformer(key, attr_desc, value): + return key + + Key is the attribute name used in Python. Attr_desc + is a dict of metadata. Currently contains 'type' with the + msrest type and 'key' with the RestAPI encoded key. + Value is the current value in this object. + + The string returned will be used to serialize the key. + If the return type is a list, this is considered hierarchical + result dict. + + See the three examples in this file: + + - attribute_transformer + - full_restapi_key_transformer + - last_restapi_key_transformer + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :param function key_transformer: A key transformer function. + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs + ) + + @classmethod + def _infer_class_models(cls): + try: + str_models = cls.__module__.rsplit(".", 1)[0] + models = sys.modules[str_models] + client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} + if cls.__name__ not in client_models: + raise ValueError("Not Autorest generated code") + except Exception: # pylint: disable=broad-exception-caught + # Assume it's not Autorest generated (tests?). Add ourselves as dependencies. + client_models = {cls.__name__: cls} + return client_models + + @classmethod + def deserialize(cls, data: Any, content_type: Optional[str] = None) -> Self: + """Parse a str using the RestAPI syntax and return a model. + + :param str data: A str using RestAPI structure. JSON by default. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises DeserializationError: if something went wrong + :rtype: Self + """ + deserializer = Deserializer(cls._infer_class_models()) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def from_dict( + cls, + data: Any, + key_extractors: Optional[Callable[[str, Dict[str, Any], Any], Any]] = None, + content_type: Optional[str] = None, + ) -> Self: + """Parse a dict using given key extractor return a model. + + By default consider key + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + and last_rest_key_case_insensitive_extractor) + + :param dict data: A dict using RestAPI structure + :param function key_extractors: A key extractor function. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises DeserializationError: if something went wrong + :rtype: Self + """ + deserializer = Deserializer(cls._infer_class_models()) + deserializer.key_extractors = ( # type: ignore + [ # type: ignore + attribute_key_case_insensitive_extractor, + rest_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + if key_extractors is None + else key_extractors + ) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def _flatten_subtype(cls, key, objects): + if "_subtype_map" not in cls.__dict__: + return {} + result = dict(cls._subtype_map[key]) + for valuetype in cls._subtype_map[key].values(): + result.update(objects[valuetype]._flatten_subtype(key, objects)) # pylint: disable=protected-access + return result + + @classmethod + def _classify(cls, response, objects): + """Check the class _subtype_map for any child classes. + We want to ignore any inherited _subtype_maps. + + :param dict response: The initial data + :param dict objects: The class objects + :returns: The class to be used + :rtype: class + """ + for subtype_key in cls.__dict__.get("_subtype_map", {}).keys(): + subtype_value = None + + if not isinstance(response, ET.Element): + rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1] + subtype_value = response.get(rest_api_response_key, None) or response.get(subtype_key, None) + else: + subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response) + if subtype_value: + # Try to match base class. Can be class name only + # (bug to fix in Autorest to support x-ms-discriminator-name) + if cls.__name__ == subtype_value: + return cls + flatten_mapping_type = cls._flatten_subtype(subtype_key, objects) + try: + return objects[flatten_mapping_type[subtype_value]] # type: ignore + except KeyError: + _LOGGER.warning( + "Subtype value %s has no mapping, use base class %s.", + subtype_value, + cls.__name__, + ) + break + else: + _LOGGER.warning("Discriminator %s is absent or null, use base class %s.", subtype_key, cls.__name__) + break + return cls + + @classmethod + def _get_rest_key_parts(cls, attr_key): + """Get the RestAPI key of this attr, split it and decode part + :param str attr_key: Attribute key must be in attribute_map. + :returns: A list of RestAPI part + :rtype: list + """ + rest_split_key = _FLATTEN.split(cls._attribute_map[attr_key]["key"]) + return [_decode_attribute_map_key(key_part) for key_part in rest_split_key] + + +def _decode_attribute_map_key(key): + """This decode a key in an _attribute_map to the actual key we want to look at + inside the received data. + + :param str key: A key string from the generated code + :returns: The decoded key + :rtype: str + """ + return key.replace("\\.", ".") + + +class Serializer: # pylint: disable=too-many-public-methods + """Request object model serializer.""" + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + _xml_basic_types_serializers = {"bool": lambda x: str(x).lower()} + days = {0: "Mon", 1: "Tue", 2: "Wed", 3: "Thu", 4: "Fri", 5: "Sat", 6: "Sun"} + months = { + 1: "Jan", + 2: "Feb", + 3: "Mar", + 4: "Apr", + 5: "May", + 6: "Jun", + 7: "Jul", + 8: "Aug", + 9: "Sep", + 10: "Oct", + 11: "Nov", + 12: "Dec", + } + validation = { + "min_length": lambda x, y: len(x) < y, + "max_length": lambda x, y: len(x) > y, + "minimum": lambda x, y: x < y, + "maximum": lambda x, y: x > y, + "minimum_ex": lambda x, y: x <= y, + "maximum_ex": lambda x, y: x >= y, + "min_items": lambda x, y: len(x) < y, + "max_items": lambda x, y: len(x) > y, + "pattern": lambda x, y: not re.match(y, x, re.UNICODE), + "unique": lambda x, y: len(x) != len(set(x)), + "multiple": lambda x, y: x % y != 0, + } + + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: + self.serialize_type = { + "iso-8601": Serializer.serialize_iso, + "rfc-1123": Serializer.serialize_rfc, + "unix-time": Serializer.serialize_unix, + "duration": Serializer.serialize_duration, + "date": Serializer.serialize_date, + "time": Serializer.serialize_time, + "decimal": Serializer.serialize_decimal, + "long": Serializer.serialize_long, + "bytearray": Serializer.serialize_bytearray, + "base64": Serializer.serialize_base64, + "object": self.serialize_object, + "[]": self.serialize_iter, + "{}": self.serialize_dict, + } + self.dependencies: Dict[str, type] = dict(classes) if classes else {} + self.key_transformer = full_restapi_key_transformer + self.client_side_validation = True + + def _serialize( # pylint: disable=too-many-nested-blocks, too-many-branches, too-many-statements, too-many-locals + self, target_obj, data_type=None, **kwargs + ): + """Serialize data into a string according to type. + + :param object target_obj: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, dict + :raises SerializationError: if serialization fails. + :returns: The serialized data. + """ + key_transformer = kwargs.get("key_transformer", self.key_transformer) + keep_readonly = kwargs.get("keep_readonly", False) + if target_obj is None: + return None + + attr_name = None + class_name = target_obj.__class__.__name__ + + if data_type: + return self.serialize_data(target_obj, data_type, **kwargs) + + if not hasattr(target_obj, "_attribute_map"): + data_type = type(target_obj).__name__ + if data_type in self.basic_types.values(): + return self.serialize_data(target_obj, data_type, **kwargs) + + # Force "is_xml" kwargs if we detect a XML model + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + is_xml_model_serialization = kwargs.setdefault("is_xml", target_obj.is_xml_model()) + + serialized = {} + if is_xml_model_serialization: + serialized = target_obj._create_xml_node() # pylint: disable=protected-access + try: + attributes = target_obj._attribute_map # pylint: disable=protected-access + for attr, attr_desc in attributes.items(): + attr_name = attr + if not keep_readonly and target_obj._validation.get( # pylint: disable=protected-access + attr_name, {} + ).get("readonly", False): + continue + + if attr_name == "additional_properties" and attr_desc["key"] == "": + if target_obj.additional_properties is not None: + serialized.update(target_obj.additional_properties) + continue + try: + + orig_attr = getattr(target_obj, attr) + if is_xml_model_serialization: + pass # Don't provide "transformer" for XML for now. Keep "orig_attr" + else: # JSON + keys, orig_attr = key_transformer(attr, attr_desc.copy(), orig_attr) + keys = keys if isinstance(keys, list) else [keys] + + kwargs["serialization_ctxt"] = attr_desc + new_attr = self.serialize_data(orig_attr, attr_desc["type"], **kwargs) + + if is_xml_model_serialization: + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + xml_prefix = xml_desc.get("prefix", None) + xml_ns = xml_desc.get("ns", None) + if xml_desc.get("attr", False): + if xml_ns: + ET.register_namespace(xml_prefix, xml_ns) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + serialized.set(xml_name, new_attr) # type: ignore + continue + if xml_desc.get("text", False): + serialized.text = new_attr # type: ignore + continue + if isinstance(new_attr, list): + serialized.extend(new_attr) # type: ignore + elif isinstance(new_attr, ET.Element): + # If the down XML has no XML/Name, + # we MUST replace the tag with the local tag. But keeping the namespaces. + if "name" not in getattr(orig_attr, "_xml_map", {}): + splitted_tag = new_attr.tag.split("}") + if len(splitted_tag) == 2: # Namespace + new_attr.tag = "}".join([splitted_tag[0], xml_name]) + else: + new_attr.tag = xml_name + serialized.append(new_attr) # type: ignore + else: # That's a basic type + # Integrate namespace if necessary + local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) + local_node.text = str(new_attr) + serialized.append(local_node) # type: ignore + else: # JSON + for k in reversed(keys): # type: ignore + new_attr = {k: new_attr} + + _new_attr = new_attr + _serialized = serialized + for k in keys: # type: ignore + if k not in _serialized: + _serialized.update(_new_attr) # type: ignore + _new_attr = _new_attr[k] # type: ignore + _serialized = _serialized[k] + except ValueError as err: + if isinstance(err, SerializationError): + raise + + except (AttributeError, KeyError, TypeError) as err: + msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) + raise SerializationError(msg) from err + return serialized + + def body(self, data, data_type, **kwargs): + """Serialize data intended for a request body. + + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: dict + :raises SerializationError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized request body + """ + + # Just in case this is a dict + internal_data_type_str = data_type.strip("[]{}") + internal_data_type = self.dependencies.get(internal_data_type_str, None) + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + if internal_data_type and issubclass(internal_data_type, Model): + is_xml_model_serialization = kwargs.setdefault("is_xml", internal_data_type.is_xml_model()) + else: + is_xml_model_serialization = False + if internal_data_type and not isinstance(internal_data_type, Enum): + try: + deserializer = Deserializer(self.dependencies) + # Since it's on serialization, it's almost sure that format is not JSON REST + # We're not able to deal with additional properties for now. + deserializer.additional_properties_detection = False + if is_xml_model_serialization: + deserializer.key_extractors = [ # type: ignore + attribute_key_case_insensitive_extractor, + ] + else: + deserializer.key_extractors = [ + rest_key_case_insensitive_extractor, + attribute_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + data = deserializer._deserialize(data_type, data) # pylint: disable=protected-access + except DeserializationError as err: + raise SerializationError("Unable to build a model: " + str(err)) from err + + return self._serialize(data, data_type, **kwargs) + + def url(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL path. + + :param str name: The name of the URL path parameter. + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :returns: The serialized URL path + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + """ + try: + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + + if kwargs.get("skip_quote") is True: + output = str(output) + output = output.replace("{", quote("{")).replace("}", quote("}")) + else: + output = quote(str(output), safe="") + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return output + + def query(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL query. + + :param str name: The name of the query parameter. + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, list + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized query parameter + """ + try: + # Treat the list aside, since we don't want to encode the div separator + if data_type.startswith("["): + internal_data_type = data_type[1:-1] + do_quote = not kwargs.get("skip_quote", False) + return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs) + + # Not a list, regular serialization + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + if kwargs.get("skip_quote") is True: + output = str(output) + else: + output = quote(str(output), safe="") + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return str(output) + + def header(self, name, data, data_type, **kwargs): + """Serialize data intended for a request header. + + :param str name: The name of the header. + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized header + """ + try: + if data_type in ["[str]"]: + data = ["" if d is None else d for d in data] + + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return str(output) + + def serialize_data(self, data, data_type, **kwargs): + """Serialize generic data according to supplied data type. + + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :raises AttributeError: if required data is None. + :raises ValueError: if data is None + :raises SerializationError: if serialization fails. + :returns: The serialized data. + :rtype: str, int, float, bool, dict, list + """ + if data is None: + raise ValueError("No value for given attribute") + + try: + if data is CoreNull: + return None + if data_type in self.basic_types.values(): + return self.serialize_basic(data, data_type, **kwargs) + + if data_type in self.serialize_type: + return self.serialize_type[data_type](data, **kwargs) + + # If dependencies is empty, try with current data class + # It has to be a subclass of Enum anyway + enum_type = self.dependencies.get(data_type, data.__class__) + if issubclass(enum_type, Enum): + return Serializer.serialize_enum(data, enum_obj=enum_type) + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.serialize_type: + return self.serialize_type[iter_type](data, data_type[1:-1], **kwargs) + + except (ValueError, TypeError) as err: + msg = "Unable to serialize value: {!r} as type: {!r}." + raise SerializationError(msg.format(data, data_type)) from err + return self._serialize(data, **kwargs) + + @classmethod + def _get_custom_serializers(cls, data_type, **kwargs): # pylint: disable=inconsistent-return-statements + custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type) + if custom_serializer: + return custom_serializer + if kwargs.get("is_xml", False): + return cls._xml_basic_types_serializers.get(data_type) + + @classmethod + def serialize_basic(cls, data, data_type, **kwargs): + """Serialize basic builting data type. + Serializes objects to str, int, float or bool. + + Possible kwargs: + - basic_types_serializers dict[str, callable] : If set, use the callable as serializer + - is_xml bool : If set, use xml_basic_types_serializers + + :param obj data: Object to be serialized. + :param str data_type: Type of object in the iterable. + :rtype: str, int, float, bool + :return: serialized object + """ + custom_serializer = cls._get_custom_serializers(data_type, **kwargs) + if custom_serializer: + return custom_serializer(data) + if data_type == "str": + return cls.serialize_unicode(data) + return eval(data_type)(data) # nosec # pylint: disable=eval-used + + @classmethod + def serialize_unicode(cls, data): + """Special handling for serializing unicode strings in Py2. + Encode to UTF-8 if unicode, otherwise handle as a str. + + :param str data: Object to be serialized. + :rtype: str + :return: serialized object + """ + try: # If I received an enum, return its value + return data.value + except AttributeError: + pass + + try: + if isinstance(data, unicode): # type: ignore + # Don't change it, JSON and XML ElementTree are totally able + # to serialize correctly u'' strings + return data + except NameError: + return str(data) + return str(data) + + def serialize_iter(self, data, iter_type, div=None, **kwargs): + """Serialize iterable. + + Supported kwargs: + - serialization_ctxt dict : The current entry of _attribute_map, or same format. + serialization_ctxt['type'] should be same as data_type. + - is_xml bool : If set, serialize as XML + + :param list data: Object to be serialized. + :param str iter_type: Type of object in the iterable. + :param str div: If set, this str will be used to combine the elements + in the iterable into a combined string. Default is 'None'. + Defaults to False. + :rtype: list, str + :return: serialized iterable + """ + if isinstance(data, str): + raise SerializationError("Refuse str type as a valid iter type.") + + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + is_xml = kwargs.get("is_xml", False) + + serialized = [] + for d in data: + try: + serialized.append(self.serialize_data(d, iter_type, **kwargs)) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized.append(None) + + if kwargs.get("do_quote", False): + serialized = ["" if s is None else quote(str(s), safe="") for s in serialized] + + if div: + serialized = ["" if s is None else str(s) for s in serialized] + serialized = div.join(serialized) + + if "xml" in serialization_ctxt or is_xml: + # XML serialization is more complicated + xml_desc = serialization_ctxt.get("xml", {}) + xml_name = xml_desc.get("name") + if not xml_name: + xml_name = serialization_ctxt["key"] + + # Create a wrap node if necessary (use the fact that Element and list have "append") + is_wrapped = xml_desc.get("wrapped", False) + node_name = xml_desc.get("itemsName", xml_name) + if is_wrapped: + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + else: + final_result = [] + # All list elements to "local_node" + for el in serialized: + if isinstance(el, ET.Element): + el_node = el + else: + el_node = _create_xml_node(node_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + if el is not None: # Otherwise it writes "None" :-p + el_node.text = str(el) + final_result.append(el_node) + return final_result + return serialized + + def serialize_dict(self, attr, dict_type, **kwargs): + """Serialize a dictionary of objects. + + :param dict attr: Object to be serialized. + :param str dict_type: Type of object in the dictionary. + :rtype: dict + :return: serialized dictionary + """ + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized[self.serialize_unicode(key)] = None + + if "xml" in serialization_ctxt: + # XML serialization is more complicated + xml_desc = serialization_ctxt["xml"] + xml_name = xml_desc["name"] + + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + for key, value in serialized.items(): + ET.SubElement(final_result, key).text = value + return final_result + + return serialized + + def serialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements + """Serialize a generic object. + This will be handled as a dictionary. If object passed in is not + a basic type (str, int, float, dict, list) it will simply be + cast to str. + + :param dict attr: Object to be serialized. + :rtype: dict or str + :return: serialized object + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + return attr + obj_type = type(attr) + if obj_type in self.basic_types: + return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) + if obj_type is _long_type: + return self.serialize_long(attr) + if obj_type is str: + return self.serialize_unicode(attr) + if obj_type is datetime.datetime: + return self.serialize_iso(attr) + if obj_type is datetime.date: + return self.serialize_date(attr) + if obj_type is datetime.time: + return self.serialize_time(attr) + if obj_type is datetime.timedelta: + return self.serialize_duration(attr) + if obj_type is decimal.Decimal: + return self.serialize_decimal(attr) + + # If it's a model or I know this dependency, serialize as a Model + if obj_type in self.dependencies.values() or isinstance(attr, Model): + return self._serialize(attr) + + if obj_type == dict: + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_object(value, **kwargs) + except ValueError: + serialized[self.serialize_unicode(key)] = None + return serialized + + if obj_type == list: + serialized = [] + for obj in attr: + try: + serialized.append(self.serialize_object(obj, **kwargs)) + except ValueError: + pass + return serialized + return str(attr) + + @staticmethod + def serialize_enum(attr, enum_obj=None): + try: + result = attr.value + except AttributeError: + result = attr + try: + enum_obj(result) # type: ignore + return result + except ValueError as exc: + for enum_value in enum_obj: # type: ignore + if enum_value.value.lower() == str(attr).lower(): + return enum_value.value + error = "{!r} is not valid value for enum {!r}" + raise SerializationError(error.format(attr, enum_obj)) from exc + + @staticmethod + def serialize_bytearray(attr, **kwargs): # pylint: disable=unused-argument + """Serialize bytearray into base-64 string. + + :param str attr: Object to be serialized. + :rtype: str + :return: serialized base64 + """ + return b64encode(attr).decode() + + @staticmethod + def serialize_base64(attr, **kwargs): # pylint: disable=unused-argument + """Serialize str into base-64 string. + + :param str attr: Object to be serialized. + :rtype: str + :return: serialized base64 + """ + encoded = b64encode(attr).decode("ascii") + return encoded.strip("=").replace("+", "-").replace("/", "_") + + @staticmethod + def serialize_decimal(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Decimal object to float. + + :param decimal attr: Object to be serialized. + :rtype: float + :return: serialized decimal + """ + return float(attr) + + @staticmethod + def serialize_long(attr, **kwargs): # pylint: disable=unused-argument + """Serialize long (Py2) or int (Py3). + + :param int attr: Object to be serialized. + :rtype: int/long + :return: serialized long + """ + return _long_type(attr) + + @staticmethod + def serialize_date(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Date object into ISO-8601 formatted string. + + :param Date attr: Object to be serialized. + :rtype: str + :return: serialized date + """ + if isinstance(attr, str): + attr = isodate.parse_date(attr) + t = "{:04}-{:02}-{:02}".format(attr.year, attr.month, attr.day) + return t + + @staticmethod + def serialize_time(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Time object into ISO-8601 formatted string. + + :param datetime.time attr: Object to be serialized. + :rtype: str + :return: serialized time + """ + if isinstance(attr, str): + attr = isodate.parse_time(attr) + t = "{:02}:{:02}:{:02}".format(attr.hour, attr.minute, attr.second) + if attr.microsecond: + t += ".{:02}".format(attr.microsecond) + return t + + @staticmethod + def serialize_duration(attr, **kwargs): # pylint: disable=unused-argument + """Serialize TimeDelta object into ISO-8601 formatted string. + + :param TimeDelta attr: Object to be serialized. + :rtype: str + :return: serialized duration + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + return isodate.duration_isoformat(attr) + + @staticmethod + def serialize_rfc(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Datetime object into RFC-1123 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises TypeError: if format invalid. + :return: serialized rfc + """ + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + except AttributeError as exc: + raise TypeError("RFC1123 object must be valid Datetime object.") from exc + + return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format( + Serializer.days[utc.tm_wday], + utc.tm_mday, + Serializer.months[utc.tm_mon], + utc.tm_year, + utc.tm_hour, + utc.tm_min, + utc.tm_sec, + ) + + @staticmethod + def serialize_iso(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Datetime object into ISO-8601 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises SerializationError: if format invalid. + :return: serialized iso + """ + if isinstance(attr, str): + attr = isodate.parse_datetime(attr) + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + if utc.tm_year > 9999 or utc.tm_year < 1: + raise OverflowError("Hit max or min date") + + microseconds = str(attr.microsecond).rjust(6, "0").rstrip("0").ljust(3, "0") + if microseconds: + microseconds = "." + microseconds + date = "{:04}-{:02}-{:02}T{:02}:{:02}:{:02}".format( + utc.tm_year, utc.tm_mon, utc.tm_mday, utc.tm_hour, utc.tm_min, utc.tm_sec + ) + return date + microseconds + "Z" + except (ValueError, OverflowError) as err: + msg = "Unable to serialize datetime object." + raise SerializationError(msg) from err + except AttributeError as err: + msg = "ISO-8601 object must be valid Datetime object." + raise TypeError(msg) from err + + @staticmethod + def serialize_unix(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param Datetime attr: Object to be serialized. + :rtype: int + :raises SerializationError: if format invalid + :return: serialied unix + """ + if isinstance(attr, int): + return attr + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + return int(calendar.timegm(attr.utctimetuple())) + except AttributeError as exc: + raise TypeError("Unix time object must be valid Datetime object.") from exc + + +def rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + key = attr_desc["key"] + working_data = data + + while "." in key: + # Need the cast, as for some reasons "split" is typed as list[str | Any] + dict_keys = cast(List[str], _FLATTEN.split(key)) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = working_data.get(working_key, data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + return working_data.get(key) + + +def rest_key_case_insensitive_extractor( # pylint: disable=unused-argument, inconsistent-return-statements + attr, attr_desc, data +): + key = attr_desc["key"] + working_data = data + + while "." in key: + dict_keys = _FLATTEN.split(key) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = attribute_key_case_insensitive_extractor(working_key, None, working_data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + if working_data: + return attribute_key_case_insensitive_extractor(key, None, working_data) + + +def last_rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + """Extract the attribute in "data" based on the last part of the JSON path key. + + :param str attr: The attribute to extract + :param dict attr_desc: The attribute description + :param dict data: The data to extract from + :rtype: object + :returns: The extracted attribute + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_extractor(dict_keys[-1], None, data) + + +def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + """Extract the attribute in "data" based on the last part of the JSON path key. + + This is the case insensitive version of "last_rest_key_extractor" + :param str attr: The attribute to extract + :param dict attr_desc: The attribute description + :param dict data: The data to extract from + :rtype: object + :returns: The extracted attribute + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_case_insensitive_extractor(dict_keys[-1], None, data) + + +def attribute_key_extractor(attr, _, data): + return data.get(attr) + + +def attribute_key_case_insensitive_extractor(attr, _, data): + found_key = None + lower_attr = attr.lower() + for key in data: + if lower_attr == key.lower(): + found_key = key + break + + return data.get(found_key) + + +def _extract_name_from_internal_type(internal_type): + """Given an internal type XML description, extract correct XML name with namespace. + + :param dict internal_type: An model type + :rtype: tuple + :returns: A tuple XML name + namespace dict + """ + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + xml_name = internal_type_xml_map.get("name", internal_type.__name__) + xml_ns = internal_type_xml_map.get("ns", None) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + return xml_name + + +def xml_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument,too-many-return-statements + if isinstance(data, dict): + return None + + # Test if this model is XML ready first + if not isinstance(data, ET.Element): + return None + + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + + # Look for a children + is_iter_type = attr_desc["type"].startswith("[") + is_wrapped = xml_desc.get("wrapped", False) + internal_type = attr_desc.get("internalType", None) + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + + # Integrate namespace if necessary + xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None)) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + + # If it's an attribute, that's simple + if xml_desc.get("attr", False): + return data.get(xml_name) + + # If it's x-ms-text, that's simple too + if xml_desc.get("text", False): + return data.text + + # Scenario where I take the local name: + # - Wrapped node + # - Internal type is an enum (considered basic types) + # - Internal type has no XML/Name node + if is_wrapped or (internal_type and (issubclass(internal_type, Enum) or "name" not in internal_type_xml_map)): + children = data.findall(xml_name) + # If internal type has a local name and it's not a list, I use that name + elif not is_iter_type and internal_type and "name" in internal_type_xml_map: + xml_name = _extract_name_from_internal_type(internal_type) + children = data.findall(xml_name) + # That's an array + else: + if internal_type: # Complex type, ignore itemsName and use the complex type name + items_name = _extract_name_from_internal_type(internal_type) + else: + items_name = xml_desc.get("itemsName", xml_name) + children = data.findall(items_name) + + if len(children) == 0: + if is_iter_type: + if is_wrapped: + return None # is_wrapped no node, we want None + return [] # not wrapped, assume empty list + return None # Assume it's not there, maybe an optional node. + + # If is_iter_type and not wrapped, return all found children + if is_iter_type: + if not is_wrapped: + return children + # Iter and wrapped, should have found one node only (the wrap one) + if len(children) != 1: + raise DeserializationError( + "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( + xml_name + ) + ) + return list(children[0]) # Might be empty list and that's ok. + + # Here it's not a itertype, we should have found one element only or empty + if len(children) > 1: + raise DeserializationError("Find several XML '{}' where it was not expected".format(xml_name)) + return children[0] + + +class Deserializer: + """Response object model deserializer. + + :param dict classes: Class type dictionary for deserializing complex types. + :ivar list key_extractors: Ordered list of extractors to be used by this deserializer. + """ + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: + self.deserialize_type = { + "iso-8601": Deserializer.deserialize_iso, + "rfc-1123": Deserializer.deserialize_rfc, + "unix-time": Deserializer.deserialize_unix, + "duration": Deserializer.deserialize_duration, + "date": Deserializer.deserialize_date, + "time": Deserializer.deserialize_time, + "decimal": Deserializer.deserialize_decimal, + "long": Deserializer.deserialize_long, + "bytearray": Deserializer.deserialize_bytearray, + "base64": Deserializer.deserialize_base64, + "object": self.deserialize_object, + "[]": self.deserialize_iter, + "{}": self.deserialize_dict, + } + self.deserialize_expected_types = { + "duration": (isodate.Duration, datetime.timedelta), + "iso-8601": (datetime.datetime), + } + self.dependencies: Dict[str, type] = dict(classes) if classes else {} + self.key_extractors = [rest_key_extractor, xml_key_extractor] + # Additional properties only works if the "rest_key_extractor" is used to + # extract the keys. Making it to work whatever the key extractor is too much + # complicated, with no real scenario for now. + # So adding a flag to disable additional properties detection. This flag should be + # used if your expect the deserialization to NOT come from a JSON REST syntax. + # Otherwise, result are unexpected + self.additional_properties_detection = True + + def __call__(self, target_obj, response_data, content_type=None): + """Call the deserializer to process a REST response. + + :param str target_obj: Target data type to deserialize to. + :param requests.Response response_data: REST response object. + :param str content_type: Swagger "produces" if available. + :raises DeserializationError: if deserialization fails. + :return: Deserialized object. + :rtype: object + """ + data = self._unpack_content(response_data, content_type) + return self._deserialize(target_obj, data) + + def _deserialize(self, target_obj, data): # pylint: disable=inconsistent-return-statements + """Call the deserializer on a model. + + Data needs to be already deserialized as JSON or XML ElementTree + + :param str target_obj: Target data type to deserialize to. + :param object data: Object to deserialize. + :raises DeserializationError: if deserialization fails. + :return: Deserialized object. + :rtype: object + """ + # This is already a model, go recursive just in case + if hasattr(data, "_attribute_map"): + constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")] + try: + for attr, mapconfig in data._attribute_map.items(): # pylint: disable=protected-access + if attr in constants: + continue + value = getattr(data, attr) + if value is None: + continue + local_type = mapconfig["type"] + internal_data_type = local_type.strip("[]{}") + if internal_data_type not in self.dependencies or isinstance(internal_data_type, Enum): + continue + setattr(data, attr, self._deserialize(local_type, value)) + return data + except AttributeError: + return + + response, class_name = self._classify_target(target_obj, data) + + if isinstance(response, str): + return self.deserialize_data(data, response) + if isinstance(response, type) and issubclass(response, Enum): + return self.deserialize_enum(data, response) + + if data is None or data is CoreNull: + return data + try: + attributes = response._attribute_map # type: ignore # pylint: disable=protected-access + d_attrs = {} + for attr, attr_desc in attributes.items(): + # Check empty string. If it's not empty, someone has a real "additionalProperties"... + if attr == "additional_properties" and attr_desc["key"] == "": + continue + raw_value = None + # Enhance attr_desc with some dynamic data + attr_desc = attr_desc.copy() # Do a copy, do not change the real one + internal_data_type = attr_desc["type"].strip("[]{}") + if internal_data_type in self.dependencies: + attr_desc["internalType"] = self.dependencies[internal_data_type] + + for key_extractor in self.key_extractors: + found_value = key_extractor(attr, attr_desc, data) + if found_value is not None: + if raw_value is not None and raw_value != found_value: + msg = ( + "Ignoring extracted value '%s' from %s for key '%s'" + " (duplicate extraction, follow extractors order)" + ) + _LOGGER.warning(msg, found_value, key_extractor, attr) + continue + raw_value = found_value + + value = self.deserialize_data(raw_value, attr_desc["type"]) + d_attrs[attr] = value + except (AttributeError, TypeError, KeyError) as err: + msg = "Unable to deserialize to object: " + class_name # type: ignore + raise DeserializationError(msg) from err + additional_properties = self._build_additional_properties(attributes, data) + return self._instantiate_model(response, d_attrs, additional_properties) + + def _build_additional_properties(self, attribute_map, data): + if not self.additional_properties_detection: + return None + if "additional_properties" in attribute_map and attribute_map.get("additional_properties", {}).get("key") != "": + # Check empty string. If it's not empty, someone has a real "additionalProperties" + return None + if isinstance(data, ET.Element): + data = {el.tag: el.text for el in data} + + known_keys = { + _decode_attribute_map_key(_FLATTEN.split(desc["key"])[0]) + for desc in attribute_map.values() + if desc["key"] != "" + } + present_keys = set(data.keys()) + missing_keys = present_keys - known_keys + return {key: data[key] for key in missing_keys} + + def _classify_target(self, target, data): + """Check to see whether the deserialization target object can + be classified into a subclass. + Once classification has been determined, initialize object. + + :param str target: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :return: The classified target object and its class name. + :rtype: tuple + """ + if target is None: + return None, None + + if isinstance(target, str): + try: + target = self.dependencies[target] + except KeyError: + return target, target + + try: + target = target._classify(data, self.dependencies) # type: ignore # pylint: disable=protected-access + except AttributeError: + pass # Target is not a Model, no classify + return target, target.__class__.__name__ # type: ignore + + def failsafe_deserialize(self, target_obj, data, content_type=None): + """Ignores any errors encountered in deserialization, + and falls back to not deserializing the object. Recommended + for use in error deserialization, as we want to return the + HttpResponseError to users, and not have them deal with + a deserialization error. + + :param str target_obj: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :param str content_type: Swagger "produces" if available. + :return: Deserialized object. + :rtype: object + """ + try: + return self(target_obj, data, content_type=content_type) + except: # pylint: disable=bare-except + _LOGGER.debug( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + @staticmethod + def _unpack_content(raw_data, content_type=None): + """Extract the correct structure for deserialization. + + If raw_data is a PipelineResponse, try to extract the result of RawDeserializer. + if we can't, raise. Your Pipeline should have a RawDeserializer. + + If not a pipeline response and raw_data is bytes or string, use content-type + to decode it. If no content-type, try JSON. + + If raw_data is something else, bypass all logic and return it directly. + + :param obj raw_data: Data to be processed. + :param str content_type: How to parse if raw_data is a string/bytes. + :raises JSONDecodeError: If JSON is requested and parsing is impossible. + :raises UnicodeDecodeError: If bytes is not UTF8 + :rtype: object + :return: Unpacked content. + """ + # Assume this is enough to detect a Pipeline Response without importing it + context = getattr(raw_data, "context", {}) + if context: + if RawDeserializer.CONTEXT_NAME in context: + return context[RawDeserializer.CONTEXT_NAME] + raise ValueError("This pipeline didn't have the RawDeserializer policy; can't deserialize") + + # Assume this is enough to recognize universal_http.ClientResponse without importing it + if hasattr(raw_data, "body"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text(), raw_data.headers) + + # Assume this enough to recognize requests.Response without importing it. + if hasattr(raw_data, "_content_consumed"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) + + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): + return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore + return raw_data + + def _instantiate_model(self, response, attrs, additional_properties=None): + """Instantiate a response model passing in deserialized args. + + :param Response response: The response model class. + :param dict attrs: The deserialized response attributes. + :param dict additional_properties: Additional properties to be set. + :rtype: Response + :return: The instantiated response model. + """ + if callable(response): + subtype = getattr(response, "_subtype_map", {}) + try: + readonly = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("readonly") + ] + const = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("constant") + ] + kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const} + response_obj = response(**kwargs) + for attr in readonly: + setattr(response_obj, attr, attrs.get(attr)) + if additional_properties: + response_obj.additional_properties = additional_properties # type: ignore + return response_obj + except TypeError as err: + msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore + raise DeserializationError(msg + str(err)) from err + else: + try: + for attr, value in attrs.items(): + setattr(response, attr, value) + return response + except Exception as exp: + msg = "Unable to populate response model. " + msg += "Type: {}, Error: {}".format(type(response), exp) + raise DeserializationError(msg) from exp + + def deserialize_data(self, data, data_type): # pylint: disable=too-many-return-statements + """Process data for deserialization according to data type. + + :param str data: The response string to be deserialized. + :param str data_type: The type to deserialize to. + :raises DeserializationError: if deserialization fails. + :return: Deserialized object. + :rtype: object + """ + if data is None: + return data + + try: + if not data_type: + return data + if data_type in self.basic_types.values(): + return self.deserialize_basic(data, data_type) + if data_type in self.deserialize_type: + if isinstance(data, self.deserialize_expected_types.get(data_type, tuple())): + return data + + is_a_text_parsing_type = lambda x: x not in [ # pylint: disable=unnecessary-lambda-assignment + "object", + "[]", + r"{}", + ] + if isinstance(data, ET.Element) and is_a_text_parsing_type(data_type) and not data.text: + return None + data_val = self.deserialize_type[data_type](data) + return data_val + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.deserialize_type: + return self.deserialize_type[iter_type](data, data_type[1:-1]) + + obj_type = self.dependencies[data_type] + if issubclass(obj_type, Enum): + if isinstance(data, ET.Element): + data = data.text + return self.deserialize_enum(data, obj_type) + + except (ValueError, TypeError, AttributeError) as err: + msg = "Unable to deserialize response data." + msg += " Data: {}, {}".format(data, data_type) + raise DeserializationError(msg) from err + return self._deserialize(obj_type, data) + + def deserialize_iter(self, attr, iter_type): + """Deserialize an iterable. + + :param list attr: Iterable to be deserialized. + :param str iter_type: The type of object in the iterable. + :return: Deserialized iterable. + :rtype: list + """ + if attr is None: + return None + if isinstance(attr, ET.Element): # If I receive an element here, get the children + attr = list(attr) + if not isinstance(attr, (list, set)): + raise DeserializationError("Cannot deserialize as [{}] an object of type {}".format(iter_type, type(attr))) + return [self.deserialize_data(a, iter_type) for a in attr] + + def deserialize_dict(self, attr, dict_type): + """Deserialize a dictionary. + + :param dict/list attr: Dictionary to be deserialized. Also accepts + a list of key, value pairs. + :param str dict_type: The object type of the items in the dictionary. + :return: Deserialized dictionary. + :rtype: dict + """ + if isinstance(attr, list): + return {x["key"]: self.deserialize_data(x["value"], dict_type) for x in attr} + + if isinstance(attr, ET.Element): + # Transform value into {"Key": "value"} + attr = {el.tag: el.text for el in attr} + return {k: self.deserialize_data(v, dict_type) for k, v in attr.items()} + + def deserialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements + """Deserialize a generic object. + This will be handled as a dictionary. + + :param dict attr: Dictionary to be deserialized. + :return: Deserialized object. + :rtype: dict + :raises TypeError: if non-builtin datatype encountered. + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + # Do no recurse on XML, just return the tree as-is + return attr + if isinstance(attr, str): + return self.deserialize_basic(attr, "str") + obj_type = type(attr) + if obj_type in self.basic_types: + return self.deserialize_basic(attr, self.basic_types[obj_type]) + if obj_type is _long_type: + return self.deserialize_long(attr) + + if obj_type == dict: + deserialized = {} + for key, value in attr.items(): + try: + deserialized[key] = self.deserialize_object(value, **kwargs) + except ValueError: + deserialized[key] = None + return deserialized + + if obj_type == list: + deserialized = [] + for obj in attr: + try: + deserialized.append(self.deserialize_object(obj, **kwargs)) + except ValueError: + pass + return deserialized + + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) + + def deserialize_basic(self, attr, data_type): # pylint: disable=too-many-return-statements + """Deserialize basic builtin data type from string. + Will attempt to convert to str, int, float and bool. + This function will also accept '1', '0', 'true' and 'false' as + valid bool values. + + :param str attr: response string to be deserialized. + :param str data_type: deserialization data type. + :return: Deserialized basic type. + :rtype: str, int, float or bool + :raises TypeError: if string format is not valid. + """ + # If we're here, data is supposed to be a basic type. + # If it's still an XML node, take the text + if isinstance(attr, ET.Element): + attr = attr.text + if not attr: + if data_type == "str": + # None or '', node is empty string. + return "" + # None or '', node with a strong type is None. + # Don't try to model "empty bool" or "empty int" + return None + + if data_type == "bool": + if attr in [True, False, 1, 0]: + return bool(attr) + if isinstance(attr, str): + if attr.lower() in ["true", "1"]: + return True + if attr.lower() in ["false", "0"]: + return False + raise TypeError("Invalid boolean value: {}".format(attr)) + + if data_type == "str": + return self.deserialize_unicode(attr) + return eval(data_type)(attr) # nosec # pylint: disable=eval-used + + @staticmethod + def deserialize_unicode(data): + """Preserve unicode objects in Python 2, otherwise return data + as a string. + + :param str data: response string to be deserialized. + :return: Deserialized string. + :rtype: str or unicode + """ + # We might be here because we have an enum modeled as string, + # and we try to deserialize a partial dict with enum inside + if isinstance(data, Enum): + return data + + # Consider this is real string + try: + if isinstance(data, unicode): # type: ignore + return data + except NameError: + return str(data) + return str(data) + + @staticmethod + def deserialize_enum(data, enum_obj): + """Deserialize string into enum object. + + If the string is not a valid enum value it will be returned as-is + and a warning will be logged. + + :param str data: Response string to be deserialized. If this value is + None or invalid it will be returned as-is. + :param Enum enum_obj: Enum object to deserialize to. + :return: Deserialized enum object. + :rtype: Enum + """ + if isinstance(data, enum_obj) or data is None: + return data + if isinstance(data, Enum): + data = data.value + if isinstance(data, int): + # Workaround. We might consider remove it in the future. + try: + return list(enum_obj.__members__.values())[data] + except IndexError as exc: + error = "{!r} is not a valid index for enum {!r}" + raise DeserializationError(error.format(data, enum_obj)) from exc + try: + return enum_obj(str(data)) + except ValueError: + for enum_value in enum_obj: + if enum_value.value.lower() == str(data).lower(): + return enum_value + # We don't fail anymore for unknown value, we deserialize as a string + _LOGGER.warning("Deserializer is not able to find %s as valid enum in %s", data, enum_obj) + return Deserializer.deserialize_unicode(data) + + @staticmethod + def deserialize_bytearray(attr): + """Deserialize string into bytearray. + + :param str attr: response string to be deserialized. + :return: Deserialized bytearray + :rtype: bytearray + :raises TypeError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return bytearray(b64decode(attr)) # type: ignore + + @staticmethod + def deserialize_base64(attr): + """Deserialize base64 encoded string into string. + + :param str attr: response string to be deserialized. + :return: Deserialized base64 string + :rtype: bytearray + :raises TypeError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return b64decode(encoded) + + @staticmethod + def deserialize_decimal(attr): + """Deserialize string into Decimal object. + + :param str attr: response string to be deserialized. + :return: Deserialized decimal + :raises DeserializationError: if string format invalid. + :rtype: decimal + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + return decimal.Decimal(str(attr)) # type: ignore + except decimal.DecimalException as err: + msg = "Invalid decimal {}".format(attr) + raise DeserializationError(msg) from err + + @staticmethod + def deserialize_long(attr): + """Deserialize string into long (Py2) or int (Py3). + + :param str attr: response string to be deserialized. + :return: Deserialized int + :rtype: long or int + :raises ValueError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return _long_type(attr) # type: ignore + + @staticmethod + def deserialize_duration(attr): + """Deserialize ISO-8601 formatted string into TimeDelta object. + + :param str attr: response string to be deserialized. + :return: Deserialized duration + :rtype: TimeDelta + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + duration = isodate.parse_duration(attr) + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize duration object." + raise DeserializationError(msg) from err + return duration + + @staticmethod + def deserialize_date(attr): + """Deserialize ISO-8601 formatted string into Date object. + + :param str attr: response string to be deserialized. + :return: Deserialized date + :rtype: Date + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + return isodate.parse_date(attr, defaultmonth=0, defaultday=0) + + @staticmethod + def deserialize_time(attr): + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :return: Deserialized time + :rtype: datetime.time + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + return isodate.parse_time(attr) + + @staticmethod + def deserialize_rfc(attr): + """Deserialize RFC-1123 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :return: Deserialized RFC datetime + :rtype: Datetime + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + parsed_date = email.utils.parsedate_tz(attr) # type: ignore + date_obj = datetime.datetime( + *parsed_date[:6], tzinfo=datetime.timezone(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60)) + ) + if not date_obj.tzinfo: + date_obj = date_obj.astimezone(tz=TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to rfc datetime object." + raise DeserializationError(msg) from err + return date_obj + + @staticmethod + def deserialize_iso(attr): + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :return: Deserialized ISO datetime + :rtype: Datetime + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + attr = attr.upper() # type: ignore + match = Deserializer.valid_date.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize datetime object." + raise DeserializationError(msg) from err + return date_obj + + @staticmethod + def deserialize_unix(attr): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param int attr: Object to be serialized. + :return: Deserialized datetime + :rtype: Datetime + :raises DeserializationError: if format invalid + """ + if isinstance(attr, ET.Element): + attr = int(attr.text) # type: ignore + try: + attr = int(attr) + date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to unix datetime object." + raise DeserializationError(msg) from err + return date_obj diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_version.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_version.py new file mode 100644 index 000000000000..e5754a47ce68 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/_version.py @@ -0,0 +1,9 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +VERSION = "1.0.0b1" diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/__init__.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/__init__.py new file mode 100644 index 000000000000..cbb64fe5f3ea --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/__init__.py @@ -0,0 +1,29 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._deployments_client import DeploymentsClient # type: ignore + +try: + from ._patch import __all__ as _patch_all + from ._patch import * +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "DeploymentsClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore + +_patch_sdk() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/_configuration.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/_configuration.py new file mode 100644 index 000000000000..170079ee2b94 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/_configuration.py @@ -0,0 +1,64 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, TYPE_CHECKING + +from azure.core.pipeline import policies +from azure.mgmt.core.policies import ARMHttpLoggingPolicy, AsyncARMChallengeAuthenticationPolicy + +from .._version import VERSION + +if TYPE_CHECKING: + from azure.core.credentials_async import AsyncTokenCredential + + +class DeploymentsClientConfiguration: # pylint: disable=too-many-instance-attributes + """Configuration for DeploymentsClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + :param subscription_id: The Microsoft Azure subscription ID. Required. + :type subscription_id: str + :keyword api_version: Api Version. Default value is "2025-04-01". Note that overriding this + default value may result in unsupported behavior. + :paramtype api_version: str + """ + + def __init__(self, credential: "AsyncTokenCredential", subscription_id: str, **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2025-04-01") + + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + if subscription_id is None: + raise ValueError("Parameter 'subscription_id' must not be None.") + + self.credential = credential + self.subscription_id = subscription_id + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://management.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "mgmt-deployments-deployments/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or ARMHttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = AsyncARMChallengeAuthenticationPolicy( + self.credential, *self.credential_scopes, **kwargs + ) diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/_deployments_client.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/_deployments_client.py new file mode 100644 index 000000000000..5b2e85a59610 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/_deployments_client.py @@ -0,0 +1,125 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, Awaitable, Optional, TYPE_CHECKING, cast +from typing_extensions import Self + +from azure.core.pipeline import policies +from azure.core.rest import AsyncHttpResponse, HttpRequest +from azure.core.settings import settings +from azure.mgmt.core import AsyncARMPipelineClient +from azure.mgmt.core.policies import AsyncARMAutoResourceProviderRegistrationPolicy +from azure.mgmt.core.tools import get_arm_endpoints + +from .. import models as _models +from .._utils.serialization import Deserializer, Serializer +from ._configuration import DeploymentsClientConfiguration +from .operations import DeploymentOperationsOperations, DeploymentsOperations + +if TYPE_CHECKING: + from azure.core.credentials_async import AsyncTokenCredential + + +class DeploymentsClient: + """Deployments Client. + + :ivar deployments: DeploymentsOperations operations + :vartype deployments: azure.mgmt.deployments.deployments.aio.operations.DeploymentsOperations + :ivar deployment_operations: DeploymentOperationsOperations operations + :vartype deployment_operations: + azure.mgmt.deployments.deployments.aio.operations.DeploymentOperationsOperations + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + :param subscription_id: The Microsoft Azure subscription ID. Required. + :type subscription_id: str + :param base_url: Service URL. Default value is None. + :type base_url: str + :keyword api_version: Api Version. Default value is "2025-04-01". Note that overriding this + default value may result in unsupported behavior. + :paramtype api_version: str + :keyword int polling_interval: Default waiting time between two polls for LRO operations if no + Retry-After header is present. + """ + + def __init__( + self, credential: "AsyncTokenCredential", subscription_id: str, base_url: Optional[str] = None, **kwargs: Any + ) -> None: + _cloud = kwargs.pop("cloud_setting", None) or settings.current.azure_cloud # type: ignore + _endpoints = get_arm_endpoints(_cloud) + if not base_url: + base_url = _endpoints["resource_manager"] + credential_scopes = kwargs.pop("credential_scopes", _endpoints["credential_scopes"]) + self._config = DeploymentsClientConfiguration( + credential=credential, subscription_id=subscription_id, credential_scopes=credential_scopes, **kwargs + ) + + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + AsyncARMAutoResourceProviderRegistrationPolicy(), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: AsyncARMPipelineClient = AsyncARMPipelineClient( + base_url=cast(str, base_url), policies=_policies, **kwargs + ) + + client_models = {k: v for k, v in _models.__dict__.items() if isinstance(v, type)} + self._serialize = Serializer(client_models) + self._deserialize = Deserializer(client_models) + self._serialize.client_side_validation = False + self.deployments = DeploymentsOperations(self._client, self._config, self._serialize, self._deserialize) + self.deployment_operations = DeploymentOperationsOperations( + self._client, self._config, self._serialize, self._deserialize + ) + + def _send_request( + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = await client._send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.AsyncHttpResponse + """ + + request_copy = deepcopy(request) + request_copy.url = self._client.format_url(request_copy.url) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + async def close(self) -> None: + await self._client.close() + + async def __aenter__(self) -> Self: + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details: Any) -> None: + await self._client.__aexit__(*exc_details) diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/_patch.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/_patch.py new file mode 100644 index 000000000000..8bcb627aa475 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/_patch.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/operations/__init__.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/operations/__init__.py new file mode 100644 index 000000000000..f44d6b8a48a6 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/operations/__init__.py @@ -0,0 +1,27 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._deployments_operations import DeploymentsOperations # type: ignore +from ._deployment_operations_operations import DeploymentOperationsOperations # type: ignore + +from ._patch import __all__ as _patch_all +from ._patch import * +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "DeploymentsOperations", + "DeploymentOperationsOperations", +] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore +_patch_sdk() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/operations/_deployment_operations_operations.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/operations/_deployment_operations_operations.py new file mode 100644 index 000000000000..124ba8f098c2 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/operations/_deployment_operations_operations.py @@ -0,0 +1,775 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from collections.abc import MutableMapping +from typing import Any, AsyncIterable, Callable, Dict, Optional, TypeVar +import urllib.parse + +from azure.core import AsyncPipelineClient +from azure.core.async_paging import AsyncItemPaged, AsyncList +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.rest import AsyncHttpResponse, HttpRequest +from azure.core.tracing.decorator import distributed_trace +from azure.core.tracing.decorator_async import distributed_trace_async +from azure.core.utils import case_insensitive_dict +from azure.mgmt.core.exceptions import ARMErrorFormat + +from ... import models as _models +from ..._utils.serialization import Deserializer, Serializer +from ...operations._deployment_operations_operations import ( + build_get_at_management_group_scope_request, + build_get_at_scope_request, + build_get_at_subscription_scope_request, + build_get_at_tenant_scope_request, + build_get_request, + build_list_at_management_group_scope_request, + build_list_at_scope_request, + build_list_at_subscription_scope_request, + build_list_at_tenant_scope_request, + build_list_request, +) +from .._configuration import DeploymentsClientConfiguration + +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] + + +class DeploymentOperationsOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.mgmt.deployments.deployments.aio.DeploymentsClient`'s + :attr:`deployment_operations` attribute. + """ + + models = _models + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client: AsyncPipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: DeploymentsClientConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace_async + async def get_at_scope( + self, scope: str, deployment_name: str, operation_id: str, **kwargs: Any + ) -> _models.DeploymentOperation: + """Gets a deployments operation. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param operation_id: The ID of the operation to get. Required. + :type operation_id: str + :return: DeploymentOperation or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentOperation + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentOperation] = kwargs.pop("cls", None) + + _request = build_get_at_scope_request( + scope=scope, + deployment_name=deployment_name, + operation_id=operation_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentOperation", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_at_scope( + self, scope: str, deployment_name: str, top: Optional[int] = None, **kwargs: Any + ) -> AsyncIterable["_models.DeploymentOperation"]: + """Gets all deployments operations for a deployment. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param top: The number of results to return. Default value is None. + :type top: int + :return: An iterator like instance of either DeploymentOperation or the result of cls(response) + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.deployments.deployments.models.DeploymentOperation] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentOperationsListResult] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_list_at_scope_request( + scope=scope, + deployment_name=deployment_name, + top=top, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request + + async def extract_data(pipeline_response): + deserialized = self._deserialize("DeploymentOperationsListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + @distributed_trace_async + async def get_at_tenant_scope( + self, deployment_name: str, operation_id: str, **kwargs: Any + ) -> _models.DeploymentOperation: + """Gets a deployments operation. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param operation_id: The ID of the operation to get. Required. + :type operation_id: str + :return: DeploymentOperation or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentOperation + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentOperation] = kwargs.pop("cls", None) + + _request = build_get_at_tenant_scope_request( + deployment_name=deployment_name, + operation_id=operation_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentOperation", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_at_tenant_scope( + self, deployment_name: str, top: Optional[int] = None, **kwargs: Any + ) -> AsyncIterable["_models.DeploymentOperation"]: + """Gets all deployments operations for a deployment. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param top: The number of results to return. Default value is None. + :type top: int + :return: An iterator like instance of either DeploymentOperation or the result of cls(response) + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.deployments.deployments.models.DeploymentOperation] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentOperationsListResult] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_list_at_tenant_scope_request( + deployment_name=deployment_name, + top=top, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request + + async def extract_data(pipeline_response): + deserialized = self._deserialize("DeploymentOperationsListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + @distributed_trace_async + async def get_at_management_group_scope( + self, group_id: str, deployment_name: str, operation_id: str, **kwargs: Any + ) -> _models.DeploymentOperation: + """Gets a deployments operation. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param operation_id: The ID of the operation to get. Required. + :type operation_id: str + :return: DeploymentOperation or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentOperation + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentOperation] = kwargs.pop("cls", None) + + _request = build_get_at_management_group_scope_request( + group_id=group_id, + deployment_name=deployment_name, + operation_id=operation_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentOperation", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_at_management_group_scope( + self, group_id: str, deployment_name: str, top: Optional[int] = None, **kwargs: Any + ) -> AsyncIterable["_models.DeploymentOperation"]: + """Gets all deployments operations for a deployment. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param top: The number of results to return. Default value is None. + :type top: int + :return: An iterator like instance of either DeploymentOperation or the result of cls(response) + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.deployments.deployments.models.DeploymentOperation] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentOperationsListResult] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_list_at_management_group_scope_request( + group_id=group_id, + deployment_name=deployment_name, + top=top, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request + + async def extract_data(pipeline_response): + deserialized = self._deserialize("DeploymentOperationsListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + @distributed_trace_async + async def get_at_subscription_scope( + self, deployment_name: str, operation_id: str, **kwargs: Any + ) -> _models.DeploymentOperation: + """Gets a deployments operation. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param operation_id: The ID of the operation to get. Required. + :type operation_id: str + :return: DeploymentOperation or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentOperation + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentOperation] = kwargs.pop("cls", None) + + _request = build_get_at_subscription_scope_request( + deployment_name=deployment_name, + operation_id=operation_id, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentOperation", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_at_subscription_scope( + self, deployment_name: str, top: Optional[int] = None, **kwargs: Any + ) -> AsyncIterable["_models.DeploymentOperation"]: + """Gets all deployments operations for a deployment. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param top: The number of results to return. Default value is None. + :type top: int + :return: An iterator like instance of either DeploymentOperation or the result of cls(response) + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.deployments.deployments.models.DeploymentOperation] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentOperationsListResult] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_list_at_subscription_scope_request( + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + top=top, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request + + async def extract_data(pipeline_response): + deserialized = self._deserialize("DeploymentOperationsListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + @distributed_trace_async + async def get( + self, resource_group_name: str, deployment_name: str, operation_id: str, **kwargs: Any + ) -> _models.DeploymentOperation: + """Gets a deployments operation. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param operation_id: The ID of the operation to get. Required. + :type operation_id: str + :return: DeploymentOperation or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentOperation + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentOperation] = kwargs.pop("cls", None) + + _request = build_get_request( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + operation_id=operation_id, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentOperation", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list( + self, resource_group_name: str, deployment_name: str, top: Optional[int] = None, **kwargs: Any + ) -> AsyncIterable["_models.DeploymentOperation"]: + """Gets all deployments operations for a deployment. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param top: The number of results to return. Default value is None. + :type top: int + :return: An iterator like instance of either DeploymentOperation or the result of cls(response) + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.deployments.deployments.models.DeploymentOperation] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentOperationsListResult] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_list_request( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + top=top, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request + + async def extract_data(pipeline_response): + deserialized = self._deserialize("DeploymentOperationsListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/operations/_deployments_operations.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/operations/_deployments_operations.py new file mode 100644 index 000000000000..7025b6a61126 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/operations/_deployments_operations.py @@ -0,0 +1,4789 @@ +# pylint: disable=too-many-lines +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from collections.abc import MutableMapping +from io import IOBase +from typing import Any, AsyncIterable, AsyncIterator, Callable, Dict, IO, Optional, TypeVar, Union, cast, overload +import urllib.parse + +from azure.core import AsyncPipelineClient +from azure.core.async_paging import AsyncItemPaged, AsyncList +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + StreamClosedError, + StreamConsumedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.polling import AsyncLROPoller, AsyncNoPolling, AsyncPollingMethod +from azure.core.rest import AsyncHttpResponse, HttpRequest +from azure.core.tracing.decorator import distributed_trace +from azure.core.tracing.decorator_async import distributed_trace_async +from azure.core.utils import case_insensitive_dict +from azure.mgmt.core.exceptions import ARMErrorFormat +from azure.mgmt.core.polling.async_arm_polling import AsyncARMPolling + +from ... import models as _models +from ..._utils.serialization import Deserializer, Serializer +from ...operations._deployments_operations import ( + build_calculate_template_hash_request, + build_cancel_at_management_group_scope_request, + build_cancel_at_scope_request, + build_cancel_at_subscription_scope_request, + build_cancel_at_tenant_scope_request, + build_cancel_request, + build_check_existence_at_management_group_scope_request, + build_check_existence_at_scope_request, + build_check_existence_at_subscription_scope_request, + build_check_existence_at_tenant_scope_request, + build_check_existence_request, + build_create_or_update_at_management_group_scope_request, + build_create_or_update_at_scope_request, + build_create_or_update_at_subscription_scope_request, + build_create_or_update_at_tenant_scope_request, + build_create_or_update_request, + build_delete_at_management_group_scope_request, + build_delete_at_scope_request, + build_delete_at_subscription_scope_request, + build_delete_at_tenant_scope_request, + build_delete_request, + build_export_template_at_management_group_scope_request, + build_export_template_at_scope_request, + build_export_template_at_subscription_scope_request, + build_export_template_at_tenant_scope_request, + build_export_template_request, + build_get_at_management_group_scope_request, + build_get_at_scope_request, + build_get_at_subscription_scope_request, + build_get_at_tenant_scope_request, + build_get_request, + build_list_at_management_group_scope_request, + build_list_at_scope_request, + build_list_at_subscription_scope_request, + build_list_at_tenant_scope_request, + build_list_by_resource_group_request, + build_validate_at_management_group_scope_request, + build_validate_at_scope_request, + build_validate_at_subscription_scope_request, + build_validate_at_tenant_scope_request, + build_validate_request, + build_what_if_at_management_group_scope_request, + build_what_if_at_subscription_scope_request, + build_what_if_at_tenant_scope_request, + build_what_if_request, +) +from .._configuration import DeploymentsClientConfiguration + +JSON = MutableMapping[str, Any] +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] + + +class DeploymentsOperations: # pylint: disable=too-many-public-methods + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.mgmt.deployments.deployments.aio.DeploymentsClient`'s + :attr:`deployments` attribute. + """ + + models = _models + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client: AsyncPipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: DeploymentsClientConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + async def _delete_at_scope_initial(self, scope: str, deployment_name: str, **kwargs: Any) -> AsyncIterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + _request = build_delete_at_scope_request( + scope=scope, + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202, 204]: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def begin_delete_at_scope(self, scope: str, deployment_name: str, **kwargs: Any) -> 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. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: An instance of AsyncLROPoller that returns either None or the result of cls(response) + :rtype: ~azure.core.polling.AsyncLROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._delete_at_scope_initial( + scope=scope, + deployment_name=deployment_name, + api_version=api_version, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + if polling is True: + polling_method: AsyncPollingMethod = cast(AsyncPollingMethod, AsyncARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[None].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore + + @distributed_trace_async + async def check_existence_at_scope(self, scope: str, deployment_name: str, **kwargs: Any) -> bool: + """Checks whether the deployment exists. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: bool or the result of cls(response) + :rtype: bool + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_check_existence_at_scope_request( + scope=scope, + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204, 404]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + return 200 <= response.status_code <= 299 + + async def _create_or_update_at_scope_initial( + self, scope: str, deployment_name: str, parameters: Union[_models.Deployment, IO[bytes]], **kwargs: Any + ) -> AsyncIterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "Deployment") + + _request = build_create_or_update_at_scope_request( + scope=scope, + deployment_name=deployment_name, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def begin_create_or_update_at_scope( + self, + scope: str, + deployment_name: str, + parameters: _models.Deployment, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentExtended]: + """Deploys resources at a given scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def begin_create_or_update_at_scope( + self, + scope: str, + deployment_name: str, + parameters: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentExtended]: + """Deploys resources at a given scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def begin_create_or_update_at_scope( + self, scope: str, deployment_name: str, parameters: Union[_models.Deployment, IO[bytes]], **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentExtended]: + """Deploys resources at a given scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Is either a Deployment type + or a IO[bytes] type. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment or IO[bytes] + :return: An instance of AsyncLROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DeploymentExtended] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._create_or_update_at_scope_initial( + scope=scope, + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("DeploymentExtended", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: AsyncPollingMethod = cast(AsyncPollingMethod, AsyncARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[_models.DeploymentExtended].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.DeploymentExtended]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @distributed_trace_async + async def get_at_scope(self, scope: str, deployment_name: str, **kwargs: Any) -> _models.DeploymentExtended: + """Gets a deployment. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: DeploymentExtended or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentExtended + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentExtended] = kwargs.pop("cls", None) + + _request = build_get_at_scope_request( + scope=scope, + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentExtended", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def cancel_at_scope(self, scope: str, deployment_name: str, **kwargs: Any) -> 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. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: None or the result of cls(response) + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_cancel_at_scope_request( + scope=scope, + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + async def _validate_at_scope_initial( + self, scope: str, deployment_name: str, parameters: Union[_models.Deployment, IO[bytes]], **kwargs: Any + ) -> AsyncIterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "Deployment") + + _request = build_validate_at_scope_request( + scope=scope, + deployment_name=deployment_name, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 202, 400]: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def begin_validate_at_scope( + self, + scope: str, + deployment_name: str, + parameters: _models.Deployment, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either DeploymentValidateResult or the + result of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def begin_validate_at_scope( + self, + scope: str, + deployment_name: str, + parameters: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either DeploymentValidateResult or the + result of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def begin_validate_at_scope( + self, scope: str, deployment_name: str, parameters: Union[_models.Deployment, IO[bytes]], **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Is either a Deployment type or a IO[bytes] type. + Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment or IO[bytes] + :return: An instance of AsyncLROPoller that returns either DeploymentValidateResult or the + result of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DeploymentValidateResult] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._validate_at_scope_initial( + scope=scope, + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("DeploymentValidateResult", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: AsyncPollingMethod = cast(AsyncPollingMethod, AsyncARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[_models.DeploymentValidateResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.DeploymentValidateResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @distributed_trace_async + async def export_template_at_scope( + self, scope: str, deployment_name: str, **kwargs: Any + ) -> _models.DeploymentExportResult: + """Exports the template used for specified deployment. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: DeploymentExportResult or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentExportResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentExportResult] = kwargs.pop("cls", None) + + _request = build_export_template_at_scope_request( + scope=scope, + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentExportResult", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_at_scope( + self, scope: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any + ) -> AsyncIterable["_models.DeploymentExtended"]: + """Get all the deployments at the given scope. + + :param scope: The resource scope. Required. + :type scope: str + :param filter: The filter to apply on the operation. For example, you can use + $filter=provisioningState eq '{state}'. Default value is None. + :type filter: str + :param top: The number of results to get. If null is passed, returns all deployments. Default + value is None. + :type top: int + :return: An iterator like instance of either DeploymentExtended or the result of cls(response) + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentListResult] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_list_at_scope_request( + scope=scope, + filter=filter, + top=top, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request + + async def extract_data(pipeline_response): + deserialized = self._deserialize("DeploymentListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + async def _delete_at_tenant_scope_initial(self, deployment_name: str, **kwargs: Any) -> AsyncIterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + _request = build_delete_at_tenant_scope_request( + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202, 204]: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def begin_delete_at_tenant_scope(self, deployment_name: str, **kwargs: Any) -> 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. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: An instance of AsyncLROPoller that returns either None or the result of cls(response) + :rtype: ~azure.core.polling.AsyncLROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._delete_at_tenant_scope_initial( + deployment_name=deployment_name, + api_version=api_version, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + if polling is True: + polling_method: AsyncPollingMethod = cast(AsyncPollingMethod, AsyncARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[None].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore + + @distributed_trace_async + async def check_existence_at_tenant_scope(self, deployment_name: str, **kwargs: Any) -> bool: + """Checks whether the deployment exists. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: bool or the result of cls(response) + :rtype: bool + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_check_existence_at_tenant_scope_request( + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204, 404]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + return 200 <= response.status_code <= 299 + + async def _create_or_update_at_tenant_scope_initial( # pylint: disable=name-too-long + self, deployment_name: str, parameters: Union[_models.ScopedDeployment, IO[bytes]], **kwargs: Any + ) -> AsyncIterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "ScopedDeployment") + + _request = build_create_or_update_at_tenant_scope_request( + deployment_name=deployment_name, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def begin_create_or_update_at_tenant_scope( + self, + deployment_name: str, + parameters: _models.ScopedDeployment, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentExtended]: + """Deploys resources at tenant scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeployment + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def begin_create_or_update_at_tenant_scope( + self, deployment_name: str, parameters: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentExtended]: + """Deploys resources at tenant scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def begin_create_or_update_at_tenant_scope( + self, deployment_name: str, parameters: Union[_models.ScopedDeployment, IO[bytes]], **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentExtended]: + """Deploys resources at tenant scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Is either a + ScopedDeployment type or a IO[bytes] type. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeployment or IO[bytes] + :return: An instance of AsyncLROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DeploymentExtended] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._create_or_update_at_tenant_scope_initial( + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("DeploymentExtended", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: AsyncPollingMethod = cast(AsyncPollingMethod, AsyncARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[_models.DeploymentExtended].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.DeploymentExtended]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @distributed_trace_async + async def get_at_tenant_scope(self, deployment_name: str, **kwargs: Any) -> _models.DeploymentExtended: + """Gets a deployment. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: DeploymentExtended or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentExtended + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentExtended] = kwargs.pop("cls", None) + + _request = build_get_at_tenant_scope_request( + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentExtended", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def cancel_at_tenant_scope(self, deployment_name: str, **kwargs: Any) -> 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. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: None or the result of cls(response) + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_cancel_at_tenant_scope_request( + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + async def _validate_at_tenant_scope_initial( + self, deployment_name: str, parameters: Union[_models.ScopedDeployment, IO[bytes]], **kwargs: Any + ) -> AsyncIterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "ScopedDeployment") + + _request = build_validate_at_tenant_scope_request( + deployment_name=deployment_name, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 202, 400]: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def begin_validate_at_tenant_scope( + self, + deployment_name: str, + parameters: _models.ScopedDeployment, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeployment + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either DeploymentValidateResult or the + result of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def begin_validate_at_tenant_scope( + self, deployment_name: str, parameters: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either DeploymentValidateResult or the + result of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def begin_validate_at_tenant_scope( + self, deployment_name: str, parameters: Union[_models.ScopedDeployment, IO[bytes]], **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Is either a ScopedDeployment type or a IO[bytes] + type. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeployment or IO[bytes] + :return: An instance of AsyncLROPoller that returns either DeploymentValidateResult or the + result of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DeploymentValidateResult] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._validate_at_tenant_scope_initial( + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("DeploymentValidateResult", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: AsyncPollingMethod = cast(AsyncPollingMethod, AsyncARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[_models.DeploymentValidateResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.DeploymentValidateResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + async def _what_if_at_tenant_scope_initial( + self, deployment_name: str, parameters: Union[_models.ScopedDeploymentWhatIf, IO[bytes]], **kwargs: Any + ) -> AsyncIterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "ScopedDeploymentWhatIf") + + _request = build_what_if_at_tenant_scope_request( + deployment_name=deployment_name, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 202]: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + response_headers = {} + if response.status_code == 202: + response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) + response_headers["Retry-After"] = self._deserialize("str", response.headers.get("Retry-After")) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + async def begin_what_if_at_tenant_scope( + self, + deployment_name: str, + parameters: _models.ScopedDeploymentWhatIf, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the tenant + group. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeploymentWhatIf + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either WhatIfOperationResult or the result + of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def begin_what_if_at_tenant_scope( + self, deployment_name: str, parameters: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the tenant + group. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either WhatIfOperationResult or the result + of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def begin_what_if_at_tenant_scope( + self, deployment_name: str, parameters: Union[_models.ScopedDeploymentWhatIf, IO[bytes]], **kwargs: Any + ) -> AsyncLROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the tenant + group. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Is either a ScopedDeploymentWhatIf type or a + IO[bytes] type. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeploymentWhatIf or + IO[bytes] + :return: An instance of AsyncLROPoller that returns either WhatIfOperationResult or the result + of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.WhatIfOperationResult] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._what_if_at_tenant_scope_initial( + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("WhatIfOperationResult", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: AsyncPollingMethod = cast( + AsyncPollingMethod, AsyncARMPolling(lro_delay, lro_options={"final-state-via": "location"}, **kwargs) + ) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[_models.WhatIfOperationResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.WhatIfOperationResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @distributed_trace_async + async def export_template_at_tenant_scope( + self, deployment_name: str, **kwargs: Any + ) -> _models.DeploymentExportResult: + """Exports the template used for specified deployment. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: DeploymentExportResult or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentExportResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentExportResult] = kwargs.pop("cls", None) + + _request = build_export_template_at_tenant_scope_request( + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentExportResult", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_at_tenant_scope( + self, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any + ) -> AsyncIterable["_models.DeploymentExtended"]: + """Get all the deployments at the tenant scope. + + :param filter: The filter to apply on the operation. For example, you can use + $filter=provisioningState eq '{state}'. Default value is None. + :type filter: str + :param top: The number of results to get. If null is passed, returns all deployments. Default + value is None. + :type top: int + :return: An iterator like instance of either DeploymentExtended or the result of cls(response) + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentListResult] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_list_at_tenant_scope_request( + filter=filter, + top=top, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request + + async def extract_data(pipeline_response): + deserialized = self._deserialize("DeploymentListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + async def _delete_at_management_group_scope_initial( # pylint: disable=name-too-long + self, group_id: str, deployment_name: str, **kwargs: Any + ) -> AsyncIterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + _request = build_delete_at_management_group_scope_request( + group_id=group_id, + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202, 204]: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def begin_delete_at_management_group_scope( + self, group_id: str, deployment_name: str, **kwargs: Any + ) -> 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. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: An instance of AsyncLROPoller that returns either None or the result of cls(response) + :rtype: ~azure.core.polling.AsyncLROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._delete_at_management_group_scope_initial( + group_id=group_id, + deployment_name=deployment_name, + api_version=api_version, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + if polling is True: + polling_method: AsyncPollingMethod = cast(AsyncPollingMethod, AsyncARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[None].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore + + @distributed_trace_async + async def check_existence_at_management_group_scope( # pylint: disable=name-too-long + self, group_id: str, deployment_name: str, **kwargs: Any + ) -> bool: + """Checks whether the deployment exists. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: bool or the result of cls(response) + :rtype: bool + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_check_existence_at_management_group_scope_request( + group_id=group_id, + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204, 404]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + return 200 <= response.status_code <= 299 + + async def _create_or_update_at_management_group_scope_initial( # pylint: disable=name-too-long + self, group_id: str, deployment_name: str, parameters: Union[_models.ScopedDeployment, IO[bytes]], **kwargs: Any + ) -> AsyncIterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "ScopedDeployment") + + _request = build_create_or_update_at_management_group_scope_request( + group_id=group_id, + deployment_name=deployment_name, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def begin_create_or_update_at_management_group_scope( # pylint: disable=name-too-long + self, + group_id: str, + deployment_name: str, + parameters: _models.ScopedDeployment, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentExtended]: + """Deploys resources at management group scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeployment + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def begin_create_or_update_at_management_group_scope( # pylint: disable=name-too-long + self, + group_id: str, + deployment_name: str, + parameters: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentExtended]: + """Deploys resources at management group scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def begin_create_or_update_at_management_group_scope( # pylint: disable=name-too-long + self, group_id: str, deployment_name: str, parameters: Union[_models.ScopedDeployment, IO[bytes]], **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentExtended]: + """Deploys resources at management group scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Is either a + ScopedDeployment type or a IO[bytes] type. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeployment or IO[bytes] + :return: An instance of AsyncLROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DeploymentExtended] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._create_or_update_at_management_group_scope_initial( + group_id=group_id, + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("DeploymentExtended", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: AsyncPollingMethod = cast(AsyncPollingMethod, AsyncARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[_models.DeploymentExtended].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.DeploymentExtended]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @distributed_trace_async + async def get_at_management_group_scope( + self, group_id: str, deployment_name: str, **kwargs: Any + ) -> _models.DeploymentExtended: + """Gets a deployment. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: DeploymentExtended or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentExtended + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentExtended] = kwargs.pop("cls", None) + + _request = build_get_at_management_group_scope_request( + group_id=group_id, + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentExtended", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def cancel_at_management_group_scope(self, group_id: str, deployment_name: str, **kwargs: Any) -> 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. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: None or the result of cls(response) + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_cancel_at_management_group_scope_request( + group_id=group_id, + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + async def _validate_at_management_group_scope_initial( # pylint: disable=name-too-long + self, group_id: str, deployment_name: str, parameters: Union[_models.ScopedDeployment, IO[bytes]], **kwargs: Any + ) -> AsyncIterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "ScopedDeployment") + + _request = build_validate_at_management_group_scope_request( + group_id=group_id, + deployment_name=deployment_name, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 202, 400]: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def begin_validate_at_management_group_scope( + self, + group_id: str, + deployment_name: str, + parameters: _models.ScopedDeployment, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeployment + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either DeploymentValidateResult or the + result of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def begin_validate_at_management_group_scope( + self, + group_id: str, + deployment_name: str, + parameters: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either DeploymentValidateResult or the + result of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def begin_validate_at_management_group_scope( + self, group_id: str, deployment_name: str, parameters: Union[_models.ScopedDeployment, IO[bytes]], **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Is either a ScopedDeployment type or a IO[bytes] + type. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeployment or IO[bytes] + :return: An instance of AsyncLROPoller that returns either DeploymentValidateResult or the + result of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DeploymentValidateResult] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._validate_at_management_group_scope_initial( + group_id=group_id, + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("DeploymentValidateResult", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: AsyncPollingMethod = cast(AsyncPollingMethod, AsyncARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[_models.DeploymentValidateResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.DeploymentValidateResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + async def _what_if_at_management_group_scope_initial( # pylint: disable=name-too-long + self, + group_id: str, + deployment_name: str, + parameters: Union[_models.ScopedDeploymentWhatIf, IO[bytes]], + **kwargs: Any + ) -> AsyncIterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "ScopedDeploymentWhatIf") + + _request = build_what_if_at_management_group_scope_request( + group_id=group_id, + deployment_name=deployment_name, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 202]: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + response_headers = {} + if response.status_code == 202: + response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) + response_headers["Retry-After"] = self._deserialize("str", response.headers.get("Retry-After")) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + async def begin_what_if_at_management_group_scope( + self, + group_id: str, + deployment_name: str, + parameters: _models.ScopedDeploymentWhatIf, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the management + group. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeploymentWhatIf + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either WhatIfOperationResult or the result + of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def begin_what_if_at_management_group_scope( + self, + group_id: str, + deployment_name: str, + parameters: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the management + group. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either WhatIfOperationResult or the result + of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def begin_what_if_at_management_group_scope( + self, + group_id: str, + deployment_name: str, + parameters: Union[_models.ScopedDeploymentWhatIf, IO[bytes]], + **kwargs: Any + ) -> AsyncLROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the management + group. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Is either a ScopedDeploymentWhatIf type or a + IO[bytes] type. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeploymentWhatIf or + IO[bytes] + :return: An instance of AsyncLROPoller that returns either WhatIfOperationResult or the result + of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.WhatIfOperationResult] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._what_if_at_management_group_scope_initial( + group_id=group_id, + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("WhatIfOperationResult", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: AsyncPollingMethod = cast( + AsyncPollingMethod, AsyncARMPolling(lro_delay, lro_options={"final-state-via": "location"}, **kwargs) + ) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[_models.WhatIfOperationResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.WhatIfOperationResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @distributed_trace_async + async def export_template_at_management_group_scope( # pylint: disable=name-too-long + self, group_id: str, deployment_name: str, **kwargs: Any + ) -> _models.DeploymentExportResult: + """Exports the template used for specified deployment. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: DeploymentExportResult or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentExportResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentExportResult] = kwargs.pop("cls", None) + + _request = build_export_template_at_management_group_scope_request( + group_id=group_id, + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentExportResult", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_at_management_group_scope( + self, group_id: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any + ) -> AsyncIterable["_models.DeploymentExtended"]: + """Get all the deployments for a management group. + + :param group_id: The management group ID. Required. + :type group_id: str + :param filter: The filter to apply on the operation. For example, you can use + $filter=provisioningState eq '{state}'. Default value is None. + :type filter: str + :param top: The number of results to get. If null is passed, returns all deployments. Default + value is None. + :type top: int + :return: An iterator like instance of either DeploymentExtended or the result of cls(response) + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentListResult] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_list_at_management_group_scope_request( + group_id=group_id, + filter=filter, + top=top, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request + + async def extract_data(pipeline_response): + deserialized = self._deserialize("DeploymentListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + async def _delete_at_subscription_scope_initial(self, deployment_name: str, **kwargs: Any) -> AsyncIterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + _request = build_delete_at_subscription_scope_request( + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202, 204]: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def begin_delete_at_subscription_scope(self, deployment_name: str, **kwargs: Any) -> 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. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: An instance of AsyncLROPoller that returns either None or the result of cls(response) + :rtype: ~azure.core.polling.AsyncLROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._delete_at_subscription_scope_initial( + deployment_name=deployment_name, + api_version=api_version, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + if polling is True: + polling_method: AsyncPollingMethod = cast(AsyncPollingMethod, AsyncARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[None].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore + + @distributed_trace_async + async def check_existence_at_subscription_scope(self, deployment_name: str, **kwargs: Any) -> bool: + """Checks whether the deployment exists. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: bool or the result of cls(response) + :rtype: bool + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_check_existence_at_subscription_scope_request( + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204, 404]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + return 200 <= response.status_code <= 299 + + async def _create_or_update_at_subscription_scope_initial( # pylint: disable=name-too-long + self, deployment_name: str, parameters: Union[_models.Deployment, IO[bytes]], **kwargs: Any + ) -> AsyncIterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "Deployment") + + _request = build_create_or_update_at_subscription_scope_request( + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def begin_create_or_update_at_subscription_scope( # pylint: disable=name-too-long + self, + deployment_name: str, + parameters: _models.Deployment, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentExtended]: + """Deploys resources at subscription scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def begin_create_or_update_at_subscription_scope( # pylint: disable=name-too-long + self, deployment_name: str, parameters: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentExtended]: + """Deploys resources at subscription scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def begin_create_or_update_at_subscription_scope( # pylint: disable=name-too-long + self, deployment_name: str, parameters: Union[_models.Deployment, IO[bytes]], **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentExtended]: + """Deploys resources at subscription scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Is either a Deployment type + or a IO[bytes] type. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment or IO[bytes] + :return: An instance of AsyncLROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DeploymentExtended] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._create_or_update_at_subscription_scope_initial( + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("DeploymentExtended", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: AsyncPollingMethod = cast(AsyncPollingMethod, AsyncARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[_models.DeploymentExtended].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.DeploymentExtended]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @distributed_trace_async + async def get_at_subscription_scope(self, deployment_name: str, **kwargs: Any) -> _models.DeploymentExtended: + """Gets a deployment. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: DeploymentExtended or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentExtended + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentExtended] = kwargs.pop("cls", None) + + _request = build_get_at_subscription_scope_request( + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentExtended", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def cancel_at_subscription_scope(self, deployment_name: str, **kwargs: Any) -> 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. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: None or the result of cls(response) + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_cancel_at_subscription_scope_request( + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + async def _validate_at_subscription_scope_initial( + self, deployment_name: str, parameters: Union[_models.Deployment, IO[bytes]], **kwargs: Any + ) -> AsyncIterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "Deployment") + + _request = build_validate_at_subscription_scope_request( + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 202, 400]: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def begin_validate_at_subscription_scope( + self, + deployment_name: str, + parameters: _models.Deployment, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either DeploymentValidateResult or the + result of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def begin_validate_at_subscription_scope( + self, deployment_name: str, parameters: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either DeploymentValidateResult or the + result of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def begin_validate_at_subscription_scope( + self, deployment_name: str, parameters: Union[_models.Deployment, IO[bytes]], **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Is either a Deployment type or a IO[bytes] type. + Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment or IO[bytes] + :return: An instance of AsyncLROPoller that returns either DeploymentValidateResult or the + result of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DeploymentValidateResult] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._validate_at_subscription_scope_initial( + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("DeploymentValidateResult", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: AsyncPollingMethod = cast(AsyncPollingMethod, AsyncARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[_models.DeploymentValidateResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.DeploymentValidateResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + async def _what_if_at_subscription_scope_initial( + self, deployment_name: str, parameters: Union[_models.DeploymentWhatIf, IO[bytes]], **kwargs: Any + ) -> AsyncIterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "DeploymentWhatIf") + + _request = build_what_if_at_subscription_scope_request( + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 202]: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + response_headers = {} + if response.status_code == 202: + response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) + response_headers["Retry-After"] = self._deserialize("str", response.headers.get("Retry-After")) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + async def begin_what_if_at_subscription_scope( + self, + deployment_name: str, + parameters: _models.DeploymentWhatIf, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the + subscription. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to What If. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.DeploymentWhatIf + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either WhatIfOperationResult or the result + of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def begin_what_if_at_subscription_scope( + self, deployment_name: str, parameters: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the + subscription. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to What If. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either WhatIfOperationResult or the result + of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def begin_what_if_at_subscription_scope( + self, deployment_name: str, parameters: Union[_models.DeploymentWhatIf, IO[bytes]], **kwargs: Any + ) -> AsyncLROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the + subscription. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to What If. Is either a DeploymentWhatIf type or a IO[bytes] + type. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.DeploymentWhatIf or IO[bytes] + :return: An instance of AsyncLROPoller that returns either WhatIfOperationResult or the result + of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.WhatIfOperationResult] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._what_if_at_subscription_scope_initial( + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("WhatIfOperationResult", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: AsyncPollingMethod = cast( + AsyncPollingMethod, AsyncARMPolling(lro_delay, lro_options={"final-state-via": "location"}, **kwargs) + ) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[_models.WhatIfOperationResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.WhatIfOperationResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @distributed_trace_async + async def export_template_at_subscription_scope( + self, deployment_name: str, **kwargs: Any + ) -> _models.DeploymentExportResult: + """Exports the template used for specified deployment. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: DeploymentExportResult or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentExportResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentExportResult] = kwargs.pop("cls", None) + + _request = build_export_template_at_subscription_scope_request( + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentExportResult", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_at_subscription_scope( + self, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any + ) -> AsyncIterable["_models.DeploymentExtended"]: + """Get all the deployments for a subscription. + + :param filter: The filter to apply on the operation. For example, you can use + $filter=provisioningState eq '{state}'. Default value is None. + :type filter: str + :param top: The number of results to get. If null is passed, returns all deployments. Default + value is None. + :type top: int + :return: An iterator like instance of either DeploymentExtended or the result of cls(response) + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentListResult] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_list_at_subscription_scope_request( + subscription_id=self._config.subscription_id, + filter=filter, + top=top, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request + + async def extract_data(pipeline_response): + deserialized = self._deserialize("DeploymentListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + async def _delete_initial( + self, resource_group_name: str, deployment_name: str, **kwargs: Any + ) -> AsyncIterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + _request = build_delete_request( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202, 204]: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def begin_delete(self, resource_group_name: str, deployment_name: str, **kwargs: Any) -> 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. + + :param resource_group_name: The name of the resource group with the deployment to delete. The + name is case insensitive. Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: An instance of AsyncLROPoller that returns either None or the result of cls(response) + :rtype: ~azure.core.polling.AsyncLROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._delete_initial( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + api_version=api_version, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + if polling is True: + polling_method: AsyncPollingMethod = cast(AsyncPollingMethod, AsyncARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[None].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore + + @distributed_trace_async + async def check_existence(self, resource_group_name: str, deployment_name: str, **kwargs: Any) -> bool: + """Checks whether the deployment exists. + + :param resource_group_name: The name of the resource group with the deployment to check. The + name is case insensitive. Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: bool or the result of cls(response) + :rtype: bool + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_check_existence_request( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204, 404]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + return 200 <= response.status_code <= 299 + + async def _create_or_update_initial( + self, + resource_group_name: str, + deployment_name: str, + parameters: Union[_models.Deployment, IO[bytes]], + **kwargs: Any + ) -> AsyncIterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "Deployment") + + _request = build_create_or_update_request( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def begin_create_or_update( + self, + resource_group_name: str, + deployment_name: str, + parameters: _models.Deployment, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentExtended]: + """Deploys resources to a resource group. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param resource_group_name: The name of the resource group to deploy the resources to. The name + is case insensitive. The resource group must already exist. Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def begin_create_or_update( + self, + resource_group_name: str, + deployment_name: str, + parameters: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentExtended]: + """Deploys resources to a resource group. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param resource_group_name: The name of the resource group to deploy the resources to. The name + is case insensitive. The resource group must already exist. Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def begin_create_or_update( + self, + resource_group_name: str, + deployment_name: str, + parameters: Union[_models.Deployment, IO[bytes]], + **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentExtended]: + """Deploys resources to a resource group. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param resource_group_name: The name of the resource group to deploy the resources to. The name + is case insensitive. The resource group must already exist. Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Is either a Deployment type + or a IO[bytes] type. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment or IO[bytes] + :return: An instance of AsyncLROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DeploymentExtended] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._create_or_update_initial( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("DeploymentExtended", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: AsyncPollingMethod = cast(AsyncPollingMethod, AsyncARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[_models.DeploymentExtended].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.DeploymentExtended]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @distributed_trace_async + async def get(self, resource_group_name: str, deployment_name: str, **kwargs: Any) -> _models.DeploymentExtended: + """Gets a deployment. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: DeploymentExtended or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentExtended + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentExtended] = kwargs.pop("cls", None) + + _request = build_get_request( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentExtended", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def cancel(self, resource_group_name: str, deployment_name: str, **kwargs: Any) -> 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. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: None or the result of cls(response) + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_cancel_request( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + async def _validate_initial( + self, + resource_group_name: str, + deployment_name: str, + parameters: Union[_models.Deployment, IO[bytes]], + **kwargs: Any + ) -> AsyncIterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "Deployment") + + _request = build_validate_request( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 202, 400]: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def begin_validate( + self, + resource_group_name: str, + deployment_name: str, + parameters: _models.Deployment, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param resource_group_name: The name of the resource group the template will be deployed to. + The name is case insensitive. Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either DeploymentValidateResult or the + result of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def begin_validate( + self, + resource_group_name: str, + deployment_name: str, + parameters: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param resource_group_name: The name of the resource group the template will be deployed to. + The name is case insensitive. Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either DeploymentValidateResult or the + result of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def begin_validate( + self, + resource_group_name: str, + deployment_name: str, + parameters: Union[_models.Deployment, IO[bytes]], + **kwargs: Any + ) -> AsyncLROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param resource_group_name: The name of the resource group the template will be deployed to. + The name is case insensitive. Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Is either a Deployment type or a IO[bytes] type. + Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment or IO[bytes] + :return: An instance of AsyncLROPoller that returns either DeploymentValidateResult or the + result of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DeploymentValidateResult] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._validate_initial( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("DeploymentValidateResult", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: AsyncPollingMethod = cast(AsyncPollingMethod, AsyncARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[_models.DeploymentValidateResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.DeploymentValidateResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + async def _what_if_initial( + self, + resource_group_name: str, + deployment_name: str, + parameters: Union[_models.DeploymentWhatIf, IO[bytes]], + **kwargs: Any + ) -> AsyncIterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "DeploymentWhatIf") + + _request = build_what_if_request( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 202]: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + response_headers = {} + if response.status_code == 202: + response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) + response_headers["Retry-After"] = self._deserialize("str", response.headers.get("Retry-After")) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + async def begin_what_if( + self, + resource_group_name: str, + deployment_name: str, + parameters: _models.DeploymentWhatIf, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the resource + group. + + :param resource_group_name: The name of the resource group the template will be deployed to. + The name is case insensitive. Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.DeploymentWhatIf + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either WhatIfOperationResult or the result + of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def begin_what_if( + self, + resource_group_name: str, + deployment_name: str, + parameters: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the resource + group. + + :param resource_group_name: The name of the resource group the template will be deployed to. + The name is case insensitive. Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns either WhatIfOperationResult or the result + of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def begin_what_if( + self, + resource_group_name: str, + deployment_name: str, + parameters: Union[_models.DeploymentWhatIf, IO[bytes]], + **kwargs: Any + ) -> AsyncLROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the resource + group. + + :param resource_group_name: The name of the resource group the template will be deployed to. + The name is case insensitive. Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Is either a DeploymentWhatIf type or a IO[bytes] + type. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.DeploymentWhatIf or IO[bytes] + :return: An instance of AsyncLROPoller that returns either WhatIfOperationResult or the result + of cls(response) + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.WhatIfOperationResult] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._what_if_initial( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("WhatIfOperationResult", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: AsyncPollingMethod = cast( + AsyncPollingMethod, AsyncARMPolling(lro_delay, lro_options={"final-state-via": "location"}, **kwargs) + ) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[_models.WhatIfOperationResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.WhatIfOperationResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @distributed_trace_async + async def export_template( + self, resource_group_name: str, deployment_name: str, **kwargs: Any + ) -> _models.DeploymentExportResult: + """Exports the template used for specified deployment. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: DeploymentExportResult or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentExportResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentExportResult] = kwargs.pop("cls", None) + + _request = build_export_template_request( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentExportResult", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_by_resource_group( + self, resource_group_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any + ) -> AsyncIterable["_models.DeploymentExtended"]: + """Get all the deployments for a resource group. + + :param resource_group_name: The name of the resource group with the deployments to get. The + name is case insensitive. Required. + :type resource_group_name: str + :param filter: The filter to apply on the operation. For example, you can use + $filter=provisioningState eq '{state}'. Default value is None. + :type filter: str + :param top: The number of results to get. If null is passed, returns all deployments. Default + value is None. + :type top: int + :return: An iterator like instance of either DeploymentExtended or the result of cls(response) + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentListResult] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_list_by_resource_group_request( + resource_group_name=resource_group_name, + subscription_id=self._config.subscription_id, + filter=filter, + top=top, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request + + async def extract_data(pipeline_response): + deserialized = self._deserialize("DeploymentListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + @distributed_trace_async + async def calculate_template_hash(self, template: JSON, **kwargs: Any) -> _models.TemplateHashResult: + """Calculate the hash of the given template. + + :param template: The template provided to calculate hash. Required. + :type template: JSON + :return: TemplateHashResult or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.TemplateHashResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: str = kwargs.pop("content_type", _headers.pop("Content-Type", "application/json")) + cls: ClsType[_models.TemplateHashResult] = kwargs.pop("cls", None) + + _json = self._serialize.body(template, "object") + + _request = build_calculate_template_hash_request( + api_version=api_version, + content_type=content_type, + json=_json, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("TemplateHashResult", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/operations/_patch.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/operations/_patch.py new file mode 100644 index 000000000000..8bcb627aa475 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/aio/operations/_patch.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/models/__init__.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/models/__init__.py new file mode 100644 index 000000000000..cbf7043fff1c --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/models/__init__.py @@ -0,0 +1,172 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + + +from ._models_py3 import ( # type: ignore + Alias, + AliasPath, + AliasPathMetadata, + AliasPattern, + ApiProfile, + BasicDependency, + DebugSetting, + Dependency, + Deployment, + DeploymentDiagnosticsDefinition, + DeploymentExportResult, + DeploymentExtended, + DeploymentExtendedFilter, + DeploymentExtensionConfigItem, + DeploymentExtensionDefinition, + DeploymentExternalInput, + DeploymentExternalInputDefinition, + DeploymentIdentity, + DeploymentListResult, + DeploymentOperation, + DeploymentOperationProperties, + DeploymentOperationsListResult, + DeploymentParameter, + DeploymentProperties, + DeploymentPropertiesExtended, + DeploymentValidateResult, + DeploymentWhatIf, + DeploymentWhatIfProperties, + DeploymentWhatIfSettings, + ErrorAdditionalInfo, + ErrorResponse, + ExpressionEvaluationOptions, + HttpMessage, + KeyVaultParameterReference, + KeyVaultReference, + OnErrorDeployment, + OnErrorDeploymentExtended, + ParametersLink, + Provider, + ProviderExtendedLocation, + ProviderResourceType, + ResourceProviderOperationDisplayProperties, + ResourceReference, + ScopedDeployment, + ScopedDeploymentWhatIf, + StatusMessage, + SubResource, + TargetResource, + TemplateHashResult, + TemplateLink, + UserAssignedIdentity, + WhatIfChange, + WhatIfOperationResult, + WhatIfPropertyChange, + ZoneMapping, +) + +from ._deployments_client_enums import ( # type: ignore + AliasPathAttributes, + AliasPathTokenType, + AliasPatternType, + AliasType, + ChangeType, + DeploymentIdentityType, + DeploymentMode, + ExpressionEvaluationOptionsScopeType, + ExtensionConfigPropertyType, + Level, + OnErrorDeploymentType, + PropertyChangeType, + ProviderAuthorizationConsentState, + ProvisioningOperation, + ProvisioningState, + ValidationLevel, + WhatIfResultFormat, +) +from ._patch import __all__ as _patch_all +from ._patch import * +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "Alias", + "AliasPath", + "AliasPathMetadata", + "AliasPattern", + "ApiProfile", + "BasicDependency", + "DebugSetting", + "Dependency", + "Deployment", + "DeploymentDiagnosticsDefinition", + "DeploymentExportResult", + "DeploymentExtended", + "DeploymentExtendedFilter", + "DeploymentExtensionConfigItem", + "DeploymentExtensionDefinition", + "DeploymentExternalInput", + "DeploymentExternalInputDefinition", + "DeploymentIdentity", + "DeploymentListResult", + "DeploymentOperation", + "DeploymentOperationProperties", + "DeploymentOperationsListResult", + "DeploymentParameter", + "DeploymentProperties", + "DeploymentPropertiesExtended", + "DeploymentValidateResult", + "DeploymentWhatIf", + "DeploymentWhatIfProperties", + "DeploymentWhatIfSettings", + "ErrorAdditionalInfo", + "ErrorResponse", + "ExpressionEvaluationOptions", + "HttpMessage", + "KeyVaultParameterReference", + "KeyVaultReference", + "OnErrorDeployment", + "OnErrorDeploymentExtended", + "ParametersLink", + "Provider", + "ProviderExtendedLocation", + "ProviderResourceType", + "ResourceProviderOperationDisplayProperties", + "ResourceReference", + "ScopedDeployment", + "ScopedDeploymentWhatIf", + "StatusMessage", + "SubResource", + "TargetResource", + "TemplateHashResult", + "TemplateLink", + "UserAssignedIdentity", + "WhatIfChange", + "WhatIfOperationResult", + "WhatIfPropertyChange", + "ZoneMapping", + "AliasPathAttributes", + "AliasPathTokenType", + "AliasPatternType", + "AliasType", + "ChangeType", + "DeploymentIdentityType", + "DeploymentMode", + "ExpressionEvaluationOptionsScopeType", + "ExtensionConfigPropertyType", + "Level", + "OnErrorDeploymentType", + "PropertyChangeType", + "ProviderAuthorizationConsentState", + "ProvisioningOperation", + "ProvisioningState", + "ValidationLevel", + "WhatIfResultFormat", +] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore +_patch_sdk() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/models/_deployments_client_enums.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/models/_deployments_client_enums.py new file mode 100644 index 000000000000..db72911b5324 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/models/_deployments_client_enums.py @@ -0,0 +1,244 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from enum import Enum +from azure.core import CaseInsensitiveEnumMeta + + +class AliasPathAttributes(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The attributes of the token that the alias path is referring to.""" + + NONE = "None" + """The token that the alias path is referring to has no attributes.""" + MODIFIABLE = "Modifiable" + """The token that the alias path is referring to is modifiable by policies with 'modify' effect.""" + + +class AliasPathTokenType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of the token that the alias path is referring to.""" + + NOT_SPECIFIED = "NotSpecified" + """The token type is not specified.""" + ANY = "Any" + """The token type can be anything.""" + STRING = "String" + """The token type is string.""" + OBJECT = "Object" + """The token type is object.""" + ARRAY = "Array" + """The token type is array.""" + INTEGER = "Integer" + """The token type is integer.""" + NUMBER = "Number" + """The token type is number.""" + BOOLEAN = "Boolean" + """The token type is boolean.""" + + +class AliasPatternType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of alias pattern.""" + + NOT_SPECIFIED = "NotSpecified" + """NotSpecified is not allowed.""" + EXTRACT = "Extract" + """Extract is the only allowed value.""" + + +class AliasType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of the alias.""" + + NOT_SPECIFIED = "NotSpecified" + """Alias type is unknown (same as not providing alias type).""" + PLAIN_TEXT = "PlainText" + """Alias value is not secret.""" + MASK = "Mask" + """Alias value is secret.""" + + +class ChangeType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Type of change that will be made to the resource when the deployment is executed.""" + + CREATE = "Create" + """The resource does not exist in the current state but is present in the desired state. The + resource will be created when the deployment is executed.""" + DELETE = "Delete" + """The resource exists in the current state and is missing from the desired state. The resource + will be deleted when the deployment is executed.""" + IGNORE = "Ignore" + """The resource exists in the current state and is missing from the desired state. The resource + will not be deployed or modified when the deployment is executed.""" + DEPLOY = "Deploy" + """The resource exists in the current state and the desired state and will be redeployed when the + deployment is executed. The properties of the resource may or may not change.""" + NO_CHANGE = "NoChange" + """The resource exists in the current state and the desired state and will be redeployed when the + deployment is executed. The properties of the resource will not change.""" + MODIFY = "Modify" + """The resource exists in the current state and the desired state and will be redeployed when the + deployment is executed. The properties of the resource will change.""" + UNSUPPORTED = "Unsupported" + """The resource is not supported by What-If.""" + + +class DeploymentIdentityType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The identity type.""" + + NONE = "None" + USER_ASSIGNED = "UserAssigned" + + +class DeploymentMode(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The mode that is used to deploy resources. This value can be either Incremental or Complete. In + Incremental mode, resources are deployed without deleting existing resources that are not + included in the template. In Complete mode, resources are deployed and existing resources in + the resource group that are not included in the template are deleted. Be careful when using + Complete mode as you may unintentionally delete resources. + """ + + INCREMENTAL = "Incremental" + COMPLETE = "Complete" + + +class ExpressionEvaluationOptionsScopeType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The scope to be used for evaluation of parameters, variables and functions in a nested + template. + """ + + NOT_SPECIFIED = "NotSpecified" + OUTER = "Outer" + INNER = "Inner" + + +class ExtensionConfigPropertyType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """ExtensionConfigPropertyType.""" + + STRING = "String" + """Property type representing a string value.""" + INT = "Int" + """Property type representing an integer value.""" + BOOL = "Bool" + """Property type representing a boolean value.""" + ARRAY = "Array" + """Property type representing an array value.""" + OBJECT = "Object" + """Property type representing an object value.""" + SECURE_STRING = "SecureString" + """Property type representing a secure string value.""" + SECURE_OBJECT = "SecureObject" + """Property type representing a secure object value.""" + INT_ENUM = "Int" + """Property type representing an integer value.""" + + +class Level(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Denotes the additional response level.""" + + WARNING = "Warning" + INFO = "Info" + ERROR = "Error" + + +class OnErrorDeploymentType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The deployment on error behavior type. Possible values are LastSuccessful and + SpecificDeployment. + """ + + LAST_SUCCESSFUL = "LastSuccessful" + SPECIFIC_DEPLOYMENT = "SpecificDeployment" + + +class PropertyChangeType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of property change.""" + + CREATE = "Create" + """The property does not exist in the current state but is present in the desired state. The + property will be created when the deployment is executed.""" + DELETE = "Delete" + """The property exists in the current state and is missing from the desired state. It will be + deleted when the deployment is executed.""" + MODIFY = "Modify" + """The property exists in both current and desired state and is different. The value of the + property will change when the deployment is executed.""" + ARRAY = "Array" + """The property is an array and contains nested changes.""" + NO_EFFECT = "NoEffect" + """The property will not be set or updated.""" + + +class ProviderAuthorizationConsentState(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The provider authorization consent state.""" + + NOT_SPECIFIED = "NotSpecified" + REQUIRED = "Required" + NOT_REQUIRED = "NotRequired" + CONSENTED = "Consented" + + +class ProvisioningOperation(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The name of the current provisioning operation.""" + + NOT_SPECIFIED = "NotSpecified" + """The provisioning operation is not specified.""" + CREATE = "Create" + """The provisioning operation is create.""" + DELETE = "Delete" + """The provisioning operation is delete.""" + WAITING = "Waiting" + """The provisioning operation is waiting.""" + AZURE_ASYNC_OPERATION_WAITING = "AzureAsyncOperationWaiting" + """The provisioning operation is waiting Azure async operation.""" + RESOURCE_CACHE_WAITING = "ResourceCacheWaiting" + """The provisioning operation is waiting for resource cache.""" + ACTION = "Action" + """The provisioning operation is action.""" + READ = "Read" + """The provisioning operation is read.""" + EVALUATE_DEPLOYMENT_OUTPUT = "EvaluateDeploymentOutput" + """The provisioning operation is evaluate output.""" + DEPLOYMENT_CLEANUP = "DeploymentCleanup" + """The provisioning operation is cleanup. This operation is part of the 'complete' mode + deployment.""" + + +class ProvisioningState(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Denotes the state of provisioning.""" + + NOT_SPECIFIED = "NotSpecified" + ACCEPTED = "Accepted" + RUNNING = "Running" + READY = "Ready" + CREATING = "Creating" + CREATED = "Created" + DELETING = "Deleting" + DELETED = "Deleted" + CANCELED = "Canceled" + FAILED = "Failed" + SUCCEEDED = "Succeeded" + UPDATING = "Updating" + + +class ValidationLevel(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The level of validation performed on the deployment.""" + + TEMPLATE = "Template" + """Static analysis of the template is performed.""" + PROVIDER = "Provider" + """Static analysis of the template is performed and resource declarations are sent to resource + providers for semantic validation. Validates that the caller has RBAC write permissions on each + resource.""" + PROVIDER_NO_RBAC = "ProviderNoRbac" + """Static analysis of the template is performed and resource declarations are sent to resource + providers for semantic validation. Skips validating that the caller has RBAC write permissions + on each resource.""" + + +class WhatIfResultFormat(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The format of the What-If results.""" + + RESOURCE_ID_ONLY = "ResourceIdOnly" + FULL_RESOURCE_PAYLOADS = "FullResourcePayloads" diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/models/_models_py3.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/models/_models_py3.py new file mode 100644 index 000000000000..228757495807 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/models/_models_py3.py @@ -0,0 +1,2656 @@ +# pylint: disable=too-many-lines +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from collections.abc import MutableMapping +from typing import Any, Dict, List, Optional, TYPE_CHECKING, Union + +from .._utils import serialization as _serialization + +if TYPE_CHECKING: + from .. import models as _models +JSON = MutableMapping[str, Any] + + +class Alias(_serialization.Model): + """The alias type. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar name: The alias name. + :vartype name: str + :ivar paths: The paths for an alias. + :vartype paths: list[~azure.mgmt.deployments.deployments.models.AliasPath] + :ivar type: The type of the alias. Known values are: "NotSpecified", "PlainText", and "Mask". + :vartype type: str or ~azure.mgmt.deployments.deployments.models.AliasType + :ivar default_path: The default path for an alias. + :vartype default_path: str + :ivar default_pattern: The default pattern for an alias. + :vartype default_pattern: ~azure.mgmt.deployments.deployments.models.AliasPattern + :ivar default_metadata: The default alias path metadata. Applies to the default path and to any + alias path that doesn't have metadata. + :vartype default_metadata: ~azure.mgmt.deployments.deployments.models.AliasPathMetadata + """ + + _validation = { + "default_metadata": {"readonly": True}, + } + + _attribute_map = { + "name": {"key": "name", "type": "str"}, + "paths": {"key": "paths", "type": "[AliasPath]"}, + "type": {"key": "type", "type": "str"}, + "default_path": {"key": "defaultPath", "type": "str"}, + "default_pattern": {"key": "defaultPattern", "type": "AliasPattern"}, + "default_metadata": {"key": "defaultMetadata", "type": "AliasPathMetadata"}, + } + + def __init__( + self, + *, + name: Optional[str] = None, + paths: Optional[List["_models.AliasPath"]] = None, + type: Optional[Union[str, "_models.AliasType"]] = None, + default_path: Optional[str] = None, + default_pattern: Optional["_models.AliasPattern"] = None, + **kwargs: Any + ) -> None: + """ + :keyword name: The alias name. + :paramtype name: str + :keyword paths: The paths for an alias. + :paramtype paths: list[~azure.mgmt.deployments.deployments.models.AliasPath] + :keyword type: The type of the alias. Known values are: "NotSpecified", "PlainText", and + "Mask". + :paramtype type: str or ~azure.mgmt.deployments.deployments.models.AliasType + :keyword default_path: The default path for an alias. + :paramtype default_path: str + :keyword default_pattern: The default pattern for an alias. + :paramtype default_pattern: ~azure.mgmt.deployments.deployments.models.AliasPattern + """ + super().__init__(**kwargs) + self.name = name + self.paths = paths + self.type = type + self.default_path = default_path + self.default_pattern = default_pattern + self.default_metadata: Optional["_models.AliasPathMetadata"] = None + + +class AliasPath(_serialization.Model): + """The type of the paths for alias. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar path: The path of an alias. + :vartype path: str + :ivar api_versions: The API versions. + :vartype api_versions: list[str] + :ivar pattern: The pattern for an alias path. + :vartype pattern: ~azure.mgmt.deployments.deployments.models.AliasPattern + :ivar metadata: The metadata of the alias path. If missing, fall back to the default metadata + of the alias. + :vartype metadata: ~azure.mgmt.deployments.deployments.models.AliasPathMetadata + """ + + _validation = { + "metadata": {"readonly": True}, + } + + _attribute_map = { + "path": {"key": "path", "type": "str"}, + "api_versions": {"key": "apiVersions", "type": "[str]"}, + "pattern": {"key": "pattern", "type": "AliasPattern"}, + "metadata": {"key": "metadata", "type": "AliasPathMetadata"}, + } + + def __init__( + self, + *, + path: Optional[str] = None, + api_versions: Optional[List[str]] = None, + pattern: Optional["_models.AliasPattern"] = None, + **kwargs: Any + ) -> None: + """ + :keyword path: The path of an alias. + :paramtype path: str + :keyword api_versions: The API versions. + :paramtype api_versions: list[str] + :keyword pattern: The pattern for an alias path. + :paramtype pattern: ~azure.mgmt.deployments.deployments.models.AliasPattern + """ + super().__init__(**kwargs) + self.path = path + self.api_versions = api_versions + self.pattern = pattern + self.metadata: Optional["_models.AliasPathMetadata"] = None + + +class AliasPathMetadata(_serialization.Model): + """AliasPathMetadata. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar type: The type of the token that the alias path is referring to. Known values are: + "NotSpecified", "Any", "String", "Object", "Array", "Integer", "Number", and "Boolean". + :vartype type: str or ~azure.mgmt.deployments.deployments.models.AliasPathTokenType + :ivar attributes: The attributes of the token that the alias path is referring to. Known values + are: "None" and "Modifiable". + :vartype attributes: str or ~azure.mgmt.deployments.deployments.models.AliasPathAttributes + """ + + _validation = { + "type": {"readonly": True}, + "attributes": {"readonly": True}, + } + + _attribute_map = { + "type": {"key": "type", "type": "str"}, + "attributes": {"key": "attributes", "type": "str"}, + } + + def __init__(self, **kwargs: Any) -> None: + """ """ + super().__init__(**kwargs) + self.type: Optional[Union[str, "_models.AliasPathTokenType"]] = None + self.attributes: Optional[Union[str, "_models.AliasPathAttributes"]] = None + + +class AliasPattern(_serialization.Model): + """The type of the pattern for an alias path. + + :ivar phrase: The alias pattern phrase. + :vartype phrase: str + :ivar variable: The alias pattern variable. + :vartype variable: str + :ivar type: The type of alias pattern. Known values are: "NotSpecified" and "Extract". + :vartype type: str or ~azure.mgmt.deployments.deployments.models.AliasPatternType + """ + + _attribute_map = { + "phrase": {"key": "phrase", "type": "str"}, + "variable": {"key": "variable", "type": "str"}, + "type": {"key": "type", "type": "str"}, + } + + def __init__( + self, + *, + phrase: Optional[str] = None, + variable: Optional[str] = None, + type: Optional[Union[str, "_models.AliasPatternType"]] = None, + **kwargs: Any + ) -> None: + """ + :keyword phrase: The alias pattern phrase. + :paramtype phrase: str + :keyword variable: The alias pattern variable. + :paramtype variable: str + :keyword type: The type of alias pattern. Known values are: "NotSpecified" and "Extract". + :paramtype type: str or ~azure.mgmt.deployments.deployments.models.AliasPatternType + """ + super().__init__(**kwargs) + self.phrase = phrase + self.variable = variable + self.type = type + + +class ApiProfile(_serialization.Model): + """ApiProfile. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar profile_version: The profile version. + :vartype profile_version: str + :ivar api_version: The API version. + :vartype api_version: str + """ + + _validation = { + "profile_version": {"readonly": True}, + "api_version": {"readonly": True}, + } + + _attribute_map = { + "profile_version": {"key": "profileVersion", "type": "str"}, + "api_version": {"key": "apiVersion", "type": "str"}, + } + + def __init__(self, **kwargs: Any) -> None: + """ """ + super().__init__(**kwargs) + self.profile_version: Optional[str] = None + self.api_version: Optional[str] = None + + +class BasicDependency(_serialization.Model): + """Deployment dependency information. + + :ivar id: The ID of the dependency. + :vartype id: str + :ivar resource_type: The dependency resource type. + :vartype resource_type: str + :ivar resource_name: The dependency resource name. + :vartype resource_name: str + """ + + _attribute_map = { + "id": {"key": "id", "type": "str"}, + "resource_type": {"key": "resourceType", "type": "str"}, + "resource_name": {"key": "resourceName", "type": "str"}, + } + + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + resource_type: Optional[str] = None, + resource_name: Optional[str] = None, + **kwargs: Any + ) -> None: + """ + :keyword id: The ID of the dependency. + :paramtype id: str + :keyword resource_type: The dependency resource type. + :paramtype resource_type: str + :keyword resource_name: The dependency resource name. + :paramtype resource_name: str + """ + super().__init__(**kwargs) + self.id = id + self.resource_type = resource_type + self.resource_name = resource_name + + +class DebugSetting(_serialization.Model): + """The debug setting. + + :ivar detail_level: Specifies the type of information to log for debugging. The permitted + values are none, requestContent, responseContent, or both requestContent and responseContent + separated by a comma. The default is none. When setting this value, carefully consider the type + of information you are passing in during deployment. By logging information about the request + or response, you could potentially expose sensitive data that is retrieved through the + deployment operations. + :vartype detail_level: str + """ + + _attribute_map = { + "detail_level": {"key": "detailLevel", "type": "str"}, + } + + def __init__(self, *, detail_level: Optional[str] = None, **kwargs: Any) -> None: + """ + :keyword detail_level: Specifies the type of information to log for debugging. The permitted + values are none, requestContent, responseContent, or both requestContent and responseContent + separated by a comma. The default is none. When setting this value, carefully consider the type + of information you are passing in during deployment. By logging information about the request + or response, you could potentially expose sensitive data that is retrieved through the + deployment operations. + :paramtype detail_level: str + """ + super().__init__(**kwargs) + self.detail_level = detail_level + + +class Dependency(_serialization.Model): + """Deployment dependency information. + + :ivar depends_on: The list of dependencies. + :vartype depends_on: list[~azure.mgmt.deployments.deployments.models.BasicDependency] + :ivar id: The ID of the dependency. + :vartype id: str + :ivar resource_type: The dependency resource type. + :vartype resource_type: str + :ivar resource_name: The dependency resource name. + :vartype resource_name: str + """ + + _attribute_map = { + "depends_on": {"key": "dependsOn", "type": "[BasicDependency]"}, + "id": {"key": "id", "type": "str"}, + "resource_type": {"key": "resourceType", "type": "str"}, + "resource_name": {"key": "resourceName", "type": "str"}, + } + + def __init__( + self, + *, + depends_on: Optional[List["_models.BasicDependency"]] = None, + id: Optional[str] = None, # pylint: disable=redefined-builtin + resource_type: Optional[str] = None, + resource_name: Optional[str] = None, + **kwargs: Any + ) -> None: + """ + :keyword depends_on: The list of dependencies. + :paramtype depends_on: list[~azure.mgmt.deployments.deployments.models.BasicDependency] + :keyword id: The ID of the dependency. + :paramtype id: str + :keyword resource_type: The dependency resource type. + :paramtype resource_type: str + :keyword resource_name: The dependency resource name. + :paramtype resource_name: str + """ + super().__init__(**kwargs) + self.depends_on = depends_on + self.id = id + self.resource_type = resource_type + self.resource_name = resource_name + + +class Deployment(_serialization.Model): + """Deployment operation parameters. + + All required parameters must be populated in order to send to server. + + :ivar location: The location to store the deployment data. + :vartype location: str + :ivar properties: The deployment properties. Required. + :vartype properties: ~azure.mgmt.deployments.deployments.models.DeploymentProperties + :ivar tags: Deployment tags. + :vartype tags: dict[str, str] + :ivar identity: The Managed Identity configuration for a deployment. + :vartype identity: ~azure.mgmt.deployments.deployments.models.DeploymentIdentity + """ + + _validation = { + "properties": {"required": True}, + } + + _attribute_map = { + "location": {"key": "location", "type": "str"}, + "properties": {"key": "properties", "type": "DeploymentProperties"}, + "tags": {"key": "tags", "type": "{str}"}, + "identity": {"key": "identity", "type": "DeploymentIdentity"}, + } + + def __init__( + self, + *, + properties: "_models.DeploymentProperties", + location: Optional[str] = None, + tags: Optional[Dict[str, str]] = None, + identity: Optional["_models.DeploymentIdentity"] = None, + **kwargs: Any + ) -> None: + """ + :keyword location: The location to store the deployment data. + :paramtype location: str + :keyword properties: The deployment properties. Required. + :paramtype properties: ~azure.mgmt.deployments.deployments.models.DeploymentProperties + :keyword tags: Deployment tags. + :paramtype tags: dict[str, str] + :keyword identity: The Managed Identity configuration for a deployment. + :paramtype identity: ~azure.mgmt.deployments.deployments.models.DeploymentIdentity + """ + super().__init__(**kwargs) + self.location = location + self.properties = properties + self.tags = tags + self.identity = identity + + +class DeploymentDiagnosticsDefinition(_serialization.Model): + """DeploymentDiagnosticsDefinition. + + Variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar level: Denotes the additional response level. Required. Known values are: "Warning", + "Info", and "Error". + :vartype level: str or ~azure.mgmt.deployments.deployments.models.Level + :ivar code: The error code. Required. + :vartype code: str + :ivar message: The error message. Required. + :vartype message: str + :ivar target: The error target. + :vartype target: str + :ivar additional_info: The error additional info. + :vartype additional_info: list[~azure.mgmt.deployments.deployments.models.ErrorAdditionalInfo] + """ + + _validation = { + "level": {"required": True, "readonly": True}, + "code": {"required": True, "readonly": True}, + "message": {"required": True, "readonly": True}, + "target": {"readonly": True}, + "additional_info": {"readonly": True}, + } + + _attribute_map = { + "level": {"key": "level", "type": "str"}, + "code": {"key": "code", "type": "str"}, + "message": {"key": "message", "type": "str"}, + "target": {"key": "target", "type": "str"}, + "additional_info": {"key": "additionalInfo", "type": "[ErrorAdditionalInfo]"}, + } + + def __init__(self, **kwargs: Any) -> None: + """ """ + super().__init__(**kwargs) + self.level: Optional[Union[str, "_models.Level"]] = None + self.code: Optional[str] = None + self.message: Optional[str] = None + self.target: Optional[str] = None + self.additional_info: Optional[List["_models.ErrorAdditionalInfo"]] = None + + +class DeploymentExportResult(_serialization.Model): + """The deployment export result. + + :ivar template: The template content. + :vartype template: JSON + """ + + _attribute_map = { + "template": {"key": "template", "type": "object"}, + } + + def __init__(self, *, template: Optional[JSON] = None, **kwargs: Any) -> None: + """ + :keyword template: The template content. + :paramtype template: JSON + """ + super().__init__(**kwargs) + self.template = template + + +class DeploymentExtended(_serialization.Model): + """Deployment information. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar id: The ID of the deployment. + :vartype id: str + :ivar name: The name of the deployment. + :vartype name: str + :ivar type: The type of the deployment. + :vartype type: str + :ivar location: the location of the deployment. + :vartype location: str + :ivar properties: Deployment properties. + :vartype properties: ~azure.mgmt.deployments.deployments.models.DeploymentPropertiesExtended + :ivar tags: Deployment tags. + :vartype tags: dict[str, str] + """ + + _validation = { + "id": {"readonly": True}, + "name": {"readonly": True}, + "type": {"readonly": True}, + } + + _attribute_map = { + "id": {"key": "id", "type": "str"}, + "name": {"key": "name", "type": "str"}, + "type": {"key": "type", "type": "str"}, + "location": {"key": "location", "type": "str"}, + "properties": {"key": "properties", "type": "DeploymentPropertiesExtended"}, + "tags": {"key": "tags", "type": "{str}"}, + } + + def __init__( + self, + *, + location: Optional[str] = None, + properties: Optional["_models.DeploymentPropertiesExtended"] = None, + tags: Optional[Dict[str, str]] = None, + **kwargs: Any + ) -> None: + """ + :keyword location: the location of the deployment. + :paramtype location: str + :keyword properties: Deployment properties. + :paramtype properties: ~azure.mgmt.deployments.deployments.models.DeploymentPropertiesExtended + :keyword tags: Deployment tags. + :paramtype tags: dict[str, str] + """ + super().__init__(**kwargs) + self.id: Optional[str] = None + self.name: Optional[str] = None + self.type: Optional[str] = None + self.location = location + self.properties = properties + self.tags = tags + + +class DeploymentExtendedFilter(_serialization.Model): + """Deployment filter. + + :ivar provisioning_state: The provisioning state. + :vartype provisioning_state: str + """ + + _attribute_map = { + "provisioning_state": {"key": "provisioningState", "type": "str"}, + } + + def __init__(self, *, provisioning_state: Optional[str] = None, **kwargs: Any) -> None: + """ + :keyword provisioning_state: The provisioning state. + :paramtype provisioning_state: str + """ + super().__init__(**kwargs) + self.provisioning_state = provisioning_state + + +class DeploymentExtensionConfigItem(_serialization.Model): + """DeploymentExtensionConfigItem. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar type: The value type of the extension config property. Known values are: "String", "Int", + "Bool", "Array", "Object", "SecureString", "SecureObject", and "Int". + :vartype type: str or ~azure.mgmt.deployments.deployments.models.ExtensionConfigPropertyType + :ivar value: The value of the extension config property. + :vartype value: any + :ivar key_vault_reference: The Azure Key Vault reference used to retrieve the secret value of + the extension config property. + :vartype key_vault_reference: + ~azure.mgmt.deployments.deployments.models.KeyVaultParameterReference + """ + + _validation = { + "type": {"readonly": True}, + } + + _attribute_map = { + "type": {"key": "type", "type": "str"}, + "value": {"key": "value", "type": "object"}, + "key_vault_reference": {"key": "keyVaultReference", "type": "KeyVaultParameterReference"}, + } + + def __init__( + self, + *, + value: Optional[Any] = None, + key_vault_reference: Optional["_models.KeyVaultParameterReference"] = None, + **kwargs: Any + ) -> None: + """ + :keyword value: The value of the extension config property. + :paramtype value: any + :keyword key_vault_reference: The Azure Key Vault reference used to retrieve the secret value + of the extension config property. + :paramtype key_vault_reference: + ~azure.mgmt.deployments.deployments.models.KeyVaultParameterReference + """ + super().__init__(**kwargs) + self.type: Optional[Union[str, "_models.ExtensionConfigPropertyType"]] = None + self.value = value + self.key_vault_reference = key_vault_reference + + +class DeploymentExtensionDefinition(_serialization.Model): + """DeploymentExtensionDefinition. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar alias: The alias of the extension as defined in the deployment template. + :vartype alias: str + :ivar name: The extension name. + :vartype name: str + :ivar version: The extension version. + :vartype version: str + :ivar config_id: The extension configuration ID. It uniquely identifies a deployment control + plane within an extension. + :vartype config_id: str + :ivar config: The extension configuration. + :vartype config: dict[str, + ~azure.mgmt.deployments.deployments.models.DeploymentExtensionConfigItem] + """ + + _validation = { + "alias": {"readonly": True}, + "name": {"readonly": True}, + "version": {"readonly": True}, + "config_id": {"readonly": True}, + "config": {"readonly": True}, + } + + _attribute_map = { + "alias": {"key": "alias", "type": "str"}, + "name": {"key": "name", "type": "str"}, + "version": {"key": "version", "type": "str"}, + "config_id": {"key": "configId", "type": "str"}, + "config": {"key": "config", "type": "{DeploymentExtensionConfigItem}"}, + } + + def __init__(self, **kwargs: Any) -> None: + """ """ + super().__init__(**kwargs) + self.alias: Optional[str] = None + self.name: Optional[str] = None + self.version: Optional[str] = None + self.config_id: Optional[str] = None + self.config: Optional[Dict[str, "_models.DeploymentExtensionConfigItem"]] = None + + +class DeploymentExternalInput(_serialization.Model): + """Deployment external input for parameterization. + + All required parameters must be populated in order to send to server. + + :ivar value: External input value. Required. + :vartype value: any + """ + + _validation = { + "value": {"required": True}, + } + + _attribute_map = { + "value": {"key": "value", "type": "object"}, + } + + def __init__(self, *, value: Any, **kwargs: Any) -> None: + """ + :keyword value: External input value. Required. + :paramtype value: any + """ + super().__init__(**kwargs) + self.value = value + + +class DeploymentExternalInputDefinition(_serialization.Model): + """Deployment external input definition for parameterization. + + All required parameters must be populated in order to send to server. + + :ivar kind: The kind of external input. Required. + :vartype kind: str + :ivar config: Configuration for the external input. + :vartype config: any + """ + + _validation = { + "kind": {"required": True}, + } + + _attribute_map = { + "kind": {"key": "kind", "type": "str"}, + "config": {"key": "config", "type": "object"}, + } + + def __init__(self, *, kind: str, config: Optional[Any] = None, **kwargs: Any) -> None: + """ + :keyword kind: The kind of external input. Required. + :paramtype kind: str + :keyword config: Configuration for the external input. + :paramtype config: any + """ + super().__init__(**kwargs) + self.kind = kind + self.config = config + + +class DeploymentIdentity(_serialization.Model): + """The Managed Identity configuration for a deployment. + + All required parameters must be populated in order to send to server. + + :ivar type: The identity type. Required. Known values are: "None" and "UserAssigned". + :vartype type: str or ~azure.mgmt.deployments.deployments.models.DeploymentIdentityType + :ivar user_assigned_identities: The set of user assigned identities associated with the + resource. + :vartype user_assigned_identities: dict[str, + ~azure.mgmt.deployments.deployments.models.UserAssignedIdentity] + """ + + _validation = { + "type": {"required": True}, + } + + _attribute_map = { + "type": {"key": "type", "type": "str"}, + "user_assigned_identities": {"key": "userAssignedIdentities", "type": "{UserAssignedIdentity}"}, + } + + def __init__( + self, + *, + type: Union[str, "_models.DeploymentIdentityType"], + user_assigned_identities: Optional[Dict[str, "_models.UserAssignedIdentity"]] = None, + **kwargs: Any + ) -> None: + """ + :keyword type: The identity type. Required. Known values are: "None" and "UserAssigned". + :paramtype type: str or ~azure.mgmt.deployments.deployments.models.DeploymentIdentityType + :keyword user_assigned_identities: The set of user assigned identities associated with the + resource. + :paramtype user_assigned_identities: dict[str, + ~azure.mgmt.deployments.deployments.models.UserAssignedIdentity] + """ + super().__init__(**kwargs) + self.type = type + self.user_assigned_identities = user_assigned_identities + + +class DeploymentListResult(_serialization.Model): + """List of deployments. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar value: An array of deployments. + :vartype value: list[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :ivar next_link: The URL to use for getting the next set of results. + :vartype next_link: str + """ + + _validation = { + "next_link": {"readonly": True}, + } + + _attribute_map = { + "value": {"key": "value", "type": "[DeploymentExtended]"}, + "next_link": {"key": "nextLink", "type": "str"}, + } + + def __init__(self, *, value: Optional[List["_models.DeploymentExtended"]] = None, **kwargs: Any) -> None: + """ + :keyword value: An array of deployments. + :paramtype value: list[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + """ + super().__init__(**kwargs) + self.value = value + self.next_link: Optional[str] = None + + +class DeploymentOperation(_serialization.Model): + """Deployment operation information. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar id: Full deployment operation ID. + :vartype id: str + :ivar operation_id: Deployment operation ID. + :vartype operation_id: str + :ivar properties: Deployment properties. + :vartype properties: ~azure.mgmt.deployments.deployments.models.DeploymentOperationProperties + """ + + _validation = { + "id": {"readonly": True}, + "operation_id": {"readonly": True}, + } + + _attribute_map = { + "id": {"key": "id", "type": "str"}, + "operation_id": {"key": "operationId", "type": "str"}, + "properties": {"key": "properties", "type": "DeploymentOperationProperties"}, + } + + def __init__(self, *, properties: Optional["_models.DeploymentOperationProperties"] = None, **kwargs: Any) -> None: + """ + :keyword properties: Deployment properties. + :paramtype properties: ~azure.mgmt.deployments.deployments.models.DeploymentOperationProperties + """ + super().__init__(**kwargs) + self.id: Optional[str] = None + self.operation_id: Optional[str] = None + self.properties = properties + + +class DeploymentOperationProperties(_serialization.Model): + """Deployment operation properties. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar provisioning_operation: The name of the current provisioning operation. Known values are: + "NotSpecified", "Create", "Delete", "Waiting", "AzureAsyncOperationWaiting", + "ResourceCacheWaiting", "Action", "Read", "EvaluateDeploymentOutput", and "DeploymentCleanup". + :vartype provisioning_operation: str or + ~azure.mgmt.deployments.deployments.models.ProvisioningOperation + :ivar provisioning_state: The state of the provisioning. + :vartype provisioning_state: str + :ivar timestamp: The date and time of the operation. + :vartype timestamp: ~datetime.datetime + :ivar duration: The duration of the operation. + :vartype duration: str + :ivar service_request_id: Deployment operation service request id. + :vartype service_request_id: str + :ivar status_code: Operation status code from the resource provider. This property may not be + set if a response has not yet been received. + :vartype status_code: str + :ivar status_message: Operation status message from the resource provider. This property is + optional. It will only be provided if an error was received from the resource provider. + :vartype status_message: ~azure.mgmt.deployments.deployments.models.StatusMessage + :ivar target_resource: The target resource. + :vartype target_resource: ~azure.mgmt.deployments.deployments.models.TargetResource + :ivar request: The HTTP request message. + :vartype request: ~azure.mgmt.deployments.deployments.models.HttpMessage + :ivar response: The HTTP response message. + :vartype response: ~azure.mgmt.deployments.deployments.models.HttpMessage + """ + + _validation = { + "provisioning_operation": {"readonly": True}, + "provisioning_state": {"readonly": True}, + "timestamp": {"readonly": True}, + "duration": {"readonly": True}, + "service_request_id": {"readonly": True}, + "status_code": {"readonly": True}, + "status_message": {"readonly": True}, + "target_resource": {"readonly": True}, + "request": {"readonly": True}, + "response": {"readonly": True}, + } + + _attribute_map = { + "provisioning_operation": {"key": "provisioningOperation", "type": "str"}, + "provisioning_state": {"key": "provisioningState", "type": "str"}, + "timestamp": {"key": "timestamp", "type": "iso-8601"}, + "duration": {"key": "duration", "type": "str"}, + "service_request_id": {"key": "serviceRequestId", "type": "str"}, + "status_code": {"key": "statusCode", "type": "str"}, + "status_message": {"key": "statusMessage", "type": "StatusMessage"}, + "target_resource": {"key": "targetResource", "type": "TargetResource"}, + "request": {"key": "request", "type": "HttpMessage"}, + "response": {"key": "response", "type": "HttpMessage"}, + } + + def __init__(self, **kwargs: Any) -> None: + """ """ + super().__init__(**kwargs) + self.provisioning_operation: Optional[Union[str, "_models.ProvisioningOperation"]] = None + self.provisioning_state: Optional[str] = None + self.timestamp: Optional[datetime.datetime] = None + self.duration: Optional[str] = None + self.service_request_id: Optional[str] = None + self.status_code: Optional[str] = None + self.status_message: Optional["_models.StatusMessage"] = None + self.target_resource: Optional["_models.TargetResource"] = None + self.request: Optional["_models.HttpMessage"] = None + self.response: Optional["_models.HttpMessage"] = None + + +class DeploymentOperationsListResult(_serialization.Model): + """List of deployment operations. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar value: An array of deployment operations. + :vartype value: list[~azure.mgmt.deployments.deployments.models.DeploymentOperation] + :ivar next_link: The URL to use for getting the next set of results. + :vartype next_link: str + """ + + _validation = { + "next_link": {"readonly": True}, + } + + _attribute_map = { + "value": {"key": "value", "type": "[DeploymentOperation]"}, + "next_link": {"key": "nextLink", "type": "str"}, + } + + def __init__(self, *, value: Optional[List["_models.DeploymentOperation"]] = None, **kwargs: Any) -> None: + """ + :keyword value: An array of deployment operations. + :paramtype value: list[~azure.mgmt.deployments.deployments.models.DeploymentOperation] + """ + super().__init__(**kwargs) + self.value = value + self.next_link: Optional[str] = None + + +class DeploymentParameter(_serialization.Model): + """Deployment parameter for the template. + + :ivar value: Input value to the parameter . + :vartype value: any + :ivar reference: Azure Key Vault parameter reference. + :vartype reference: ~azure.mgmt.deployments.deployments.models.KeyVaultParameterReference + :ivar expression: Input expression to the parameter. + :vartype expression: str + """ + + _attribute_map = { + "value": {"key": "value", "type": "object"}, + "reference": {"key": "reference", "type": "KeyVaultParameterReference"}, + "expression": {"key": "expression", "type": "str"}, + } + + def __init__( + self, + *, + value: Optional[Any] = None, + reference: Optional["_models.KeyVaultParameterReference"] = None, + expression: Optional[str] = None, + **kwargs: Any + ) -> None: + """ + :keyword value: Input value to the parameter . + :paramtype value: any + :keyword reference: Azure Key Vault parameter reference. + :paramtype reference: ~azure.mgmt.deployments.deployments.models.KeyVaultParameterReference + :keyword expression: Input expression to the parameter. + :paramtype expression: str + """ + super().__init__(**kwargs) + self.value = value + self.reference = reference + self.expression = expression + + +class DeploymentProperties(_serialization.Model): + """Deployment properties. + + All required parameters must be populated in order to send to server. + + :ivar template: The template content. You use this element when you want to pass the template + syntax directly in the request rather than link to an existing template. It can be a JObject or + well-formed JSON string. Use either the templateLink property or the template property, but not + both. + :vartype template: JSON + :ivar template_link: The URI of the template. Use either the templateLink property or the + template property, but not both. + :vartype template_link: ~azure.mgmt.deployments.deployments.models.TemplateLink + :ivar parameters: Name and value pairs that define the deployment parameters for the template. + You use this element when you want to provide the parameter values directly in the request + rather than link to an existing parameter file. Use either the parametersLink property or the + parameters property, but not both. It can be a JObject or a well formed JSON string. + :vartype parameters: dict[str, ~azure.mgmt.deployments.deployments.models.DeploymentParameter] + :ivar external_inputs: External input values, used by external tooling for parameter + evaluation. + :vartype external_inputs: dict[str, + ~azure.mgmt.deployments.deployments.models.DeploymentExternalInput] + :ivar external_input_definitions: External input definitions, used by external tooling to + define expected external input values. + :vartype external_input_definitions: dict[str, + ~azure.mgmt.deployments.deployments.models.DeploymentExternalInputDefinition] + :ivar parameters_link: The URI of parameters file. You use this element to link to an existing + parameters file. Use either the parametersLink property or the parameters property, but not + both. + :vartype parameters_link: ~azure.mgmt.deployments.deployments.models.ParametersLink + :ivar extension_configs: The configurations to use for deployment extensions. The keys of this + object are deployment extension aliases as defined in the deployment template. + :vartype extension_configs: dict[str, dict[str, + ~azure.mgmt.deployments.deployments.models.DeploymentExtensionConfigItem]] + :ivar mode: The mode that is used to deploy resources. This value can be either Incremental or + Complete. In Incremental mode, resources are deployed without deleting existing resources that + are not included in the template. In Complete mode, resources are deployed and existing + resources in the resource group that are not included in the template are deleted. Be careful + when using Complete mode as you may unintentionally delete resources. Required. Known values + are: "Incremental" and "Complete". + :vartype mode: str or ~azure.mgmt.deployments.deployments.models.DeploymentMode + :ivar debug_setting: The debug setting of the deployment. + :vartype debug_setting: ~azure.mgmt.deployments.deployments.models.DebugSetting + :ivar on_error_deployment: The deployment on error behavior. + :vartype on_error_deployment: ~azure.mgmt.deployments.deployments.models.OnErrorDeployment + :ivar expression_evaluation_options: Specifies whether template expressions are evaluated + within the scope of the parent template or nested template. Only applicable to nested + templates. If not specified, default value is outer. + :vartype expression_evaluation_options: + ~azure.mgmt.deployments.deployments.models.ExpressionEvaluationOptions + :ivar validation_level: The validation level of the deployment. Known values are: "Template", + "Provider", and "ProviderNoRbac". + :vartype validation_level: str or ~azure.mgmt.deployments.deployments.models.ValidationLevel + """ + + _validation = { + "mode": {"required": True}, + } + + _attribute_map = { + "template": {"key": "template", "type": "object"}, + "template_link": {"key": "templateLink", "type": "TemplateLink"}, + "parameters": {"key": "parameters", "type": "{DeploymentParameter}"}, + "external_inputs": {"key": "externalInputs", "type": "{DeploymentExternalInput}"}, + "external_input_definitions": { + "key": "externalInputDefinitions", + "type": "{DeploymentExternalInputDefinition}", + }, + "parameters_link": {"key": "parametersLink", "type": "ParametersLink"}, + "extension_configs": {"key": "extensionConfigs", "type": "{{DeploymentExtensionConfigItem}}"}, + "mode": {"key": "mode", "type": "str"}, + "debug_setting": {"key": "debugSetting", "type": "DebugSetting"}, + "on_error_deployment": {"key": "onErrorDeployment", "type": "OnErrorDeployment"}, + "expression_evaluation_options": {"key": "expressionEvaluationOptions", "type": "ExpressionEvaluationOptions"}, + "validation_level": {"key": "validationLevel", "type": "str"}, + } + + def __init__( + self, + *, + mode: Union[str, "_models.DeploymentMode"], + template: Optional[JSON] = None, + template_link: Optional["_models.TemplateLink"] = None, + parameters: Optional[Dict[str, "_models.DeploymentParameter"]] = None, + external_inputs: Optional[Dict[str, "_models.DeploymentExternalInput"]] = None, + external_input_definitions: Optional[Dict[str, "_models.DeploymentExternalInputDefinition"]] = None, + parameters_link: Optional["_models.ParametersLink"] = None, + extension_configs: Optional[Dict[str, Dict[str, "_models.DeploymentExtensionConfigItem"]]] = None, + debug_setting: Optional["_models.DebugSetting"] = None, + on_error_deployment: Optional["_models.OnErrorDeployment"] = None, + expression_evaluation_options: Optional["_models.ExpressionEvaluationOptions"] = None, + validation_level: Optional[Union[str, "_models.ValidationLevel"]] = None, + **kwargs: Any + ) -> None: + """ + :keyword template: The template content. You use this element when you want to pass the + template syntax directly in the request rather than link to an existing template. It can be a + JObject or well-formed JSON string. Use either the templateLink property or the template + property, but not both. + :paramtype template: JSON + :keyword template_link: The URI of the template. Use either the templateLink property or the + template property, but not both. + :paramtype template_link: ~azure.mgmt.deployments.deployments.models.TemplateLink + :keyword parameters: Name and value pairs that define the deployment parameters for the + template. You use this element when you want to provide the parameter values directly in the + request rather than link to an existing parameter file. Use either the parametersLink property + or the parameters property, but not both. It can be a JObject or a well formed JSON string. + :paramtype parameters: dict[str, + ~azure.mgmt.deployments.deployments.models.DeploymentParameter] + :keyword external_inputs: External input values, used by external tooling for parameter + evaluation. + :paramtype external_inputs: dict[str, + ~azure.mgmt.deployments.deployments.models.DeploymentExternalInput] + :keyword external_input_definitions: External input definitions, used by external tooling to + define expected external input values. + :paramtype external_input_definitions: dict[str, + ~azure.mgmt.deployments.deployments.models.DeploymentExternalInputDefinition] + :keyword parameters_link: The URI of parameters file. You use this element to link to an + existing parameters file. Use either the parametersLink property or the parameters property, + but not both. + :paramtype parameters_link: ~azure.mgmt.deployments.deployments.models.ParametersLink + :keyword extension_configs: The configurations to use for deployment extensions. The keys of + this object are deployment extension aliases as defined in the deployment template. + :paramtype extension_configs: dict[str, dict[str, + ~azure.mgmt.deployments.deployments.models.DeploymentExtensionConfigItem]] + :keyword mode: The mode that is used to deploy resources. This value can be either Incremental + or Complete. In Incremental mode, resources are deployed without deleting existing resources + that are not included in the template. In Complete mode, resources are deployed and existing + resources in the resource group that are not included in the template are deleted. Be careful + when using Complete mode as you may unintentionally delete resources. Required. Known values + are: "Incremental" and "Complete". + :paramtype mode: str or ~azure.mgmt.deployments.deployments.models.DeploymentMode + :keyword debug_setting: The debug setting of the deployment. + :paramtype debug_setting: ~azure.mgmt.deployments.deployments.models.DebugSetting + :keyword on_error_deployment: The deployment on error behavior. + :paramtype on_error_deployment: ~azure.mgmt.deployments.deployments.models.OnErrorDeployment + :keyword expression_evaluation_options: Specifies whether template expressions are evaluated + within the scope of the parent template or nested template. Only applicable to nested + templates. If not specified, default value is outer. + :paramtype expression_evaluation_options: + ~azure.mgmt.deployments.deployments.models.ExpressionEvaluationOptions + :keyword validation_level: The validation level of the deployment. Known values are: + "Template", "Provider", and "ProviderNoRbac". + :paramtype validation_level: str or ~azure.mgmt.deployments.deployments.models.ValidationLevel + """ + super().__init__(**kwargs) + self.template = template + self.template_link = template_link + self.parameters = parameters + self.external_inputs = external_inputs + self.external_input_definitions = external_input_definitions + self.parameters_link = parameters_link + self.extension_configs = extension_configs + self.mode = mode + self.debug_setting = debug_setting + self.on_error_deployment = on_error_deployment + self.expression_evaluation_options = expression_evaluation_options + self.validation_level = validation_level + + +class DeploymentPropertiesExtended(_serialization.Model): + """Deployment properties with additional details. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar provisioning_state: Denotes the state of provisioning. Known values are: "NotSpecified", + "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", + "Failed", "Succeeded", and "Updating". + :vartype provisioning_state: str or + ~azure.mgmt.deployments.deployments.models.ProvisioningState + :ivar correlation_id: The correlation ID of the deployment. + :vartype correlation_id: str + :ivar timestamp: The timestamp of the template deployment. + :vartype timestamp: ~datetime.datetime + :ivar duration: The duration of the template deployment. + :vartype duration: str + :ivar outputs: Key/value pairs that represent deployment output. + :vartype outputs: JSON + :ivar providers: The list of resource providers needed for the deployment. + :vartype providers: list[~azure.mgmt.deployments.deployments.models.Provider] + :ivar dependencies: The list of deployment dependencies. + :vartype dependencies: list[~azure.mgmt.deployments.deployments.models.Dependency] + :ivar template_link: The URI referencing the template. + :vartype template_link: ~azure.mgmt.deployments.deployments.models.TemplateLink + :ivar parameters: Deployment parameters. + :vartype parameters: JSON + :ivar parameters_link: The URI referencing the parameters. + :vartype parameters_link: ~azure.mgmt.deployments.deployments.models.ParametersLink + :ivar extensions: The extensions used in this deployment. + :vartype extensions: + list[~azure.mgmt.deployments.deployments.models.DeploymentExtensionDefinition] + :ivar mode: The deployment mode. Possible values are Incremental and Complete. Known values + are: "Incremental" and "Complete". + :vartype mode: str or ~azure.mgmt.deployments.deployments.models.DeploymentMode + :ivar debug_setting: The debug setting of the deployment. + :vartype debug_setting: ~azure.mgmt.deployments.deployments.models.DebugSetting + :ivar on_error_deployment: The deployment on error behavior. + :vartype on_error_deployment: + ~azure.mgmt.deployments.deployments.models.OnErrorDeploymentExtended + :ivar template_hash: The hash produced for the template. + :vartype template_hash: str + :ivar output_resources: Array of provisioned resources. + :vartype output_resources: list[~azure.mgmt.deployments.deployments.models.ResourceReference] + :ivar validated_resources: Array of validated resources. + :vartype validated_resources: + list[~azure.mgmt.deployments.deployments.models.ResourceReference] + :ivar error: The deployment error. + :vartype error: ~azure.mgmt.deployments.deployments.models.ErrorResponse + :ivar diagnostics: Contains diagnostic information collected during validation process. + :vartype diagnostics: + list[~azure.mgmt.deployments.deployments.models.DeploymentDiagnosticsDefinition] + :ivar validation_level: The validation level of the deployment. Known values are: "Template", + "Provider", and "ProviderNoRbac". + :vartype validation_level: str or ~azure.mgmt.deployments.deployments.models.ValidationLevel + """ + + _validation = { + "provisioning_state": {"readonly": True}, + "correlation_id": {"readonly": True}, + "timestamp": {"readonly": True}, + "duration": {"readonly": True}, + "outputs": {"readonly": True}, + "providers": {"readonly": True}, + "dependencies": {"readonly": True}, + "template_link": {"readonly": True}, + "parameters": {"readonly": True}, + "parameters_link": {"readonly": True}, + "extensions": {"readonly": True}, + "mode": {"readonly": True}, + "debug_setting": {"readonly": True}, + "on_error_deployment": {"readonly": True}, + "template_hash": {"readonly": True}, + "output_resources": {"readonly": True}, + "validated_resources": {"readonly": True}, + "error": {"readonly": True}, + "diagnostics": {"readonly": True}, + } + + _attribute_map = { + "provisioning_state": {"key": "provisioningState", "type": "str"}, + "correlation_id": {"key": "correlationId", "type": "str"}, + "timestamp": {"key": "timestamp", "type": "iso-8601"}, + "duration": {"key": "duration", "type": "str"}, + "outputs": {"key": "outputs", "type": "object"}, + "providers": {"key": "providers", "type": "[Provider]"}, + "dependencies": {"key": "dependencies", "type": "[Dependency]"}, + "template_link": {"key": "templateLink", "type": "TemplateLink"}, + "parameters": {"key": "parameters", "type": "object"}, + "parameters_link": {"key": "parametersLink", "type": "ParametersLink"}, + "extensions": {"key": "extensions", "type": "[DeploymentExtensionDefinition]"}, + "mode": {"key": "mode", "type": "str"}, + "debug_setting": {"key": "debugSetting", "type": "DebugSetting"}, + "on_error_deployment": {"key": "onErrorDeployment", "type": "OnErrorDeploymentExtended"}, + "template_hash": {"key": "templateHash", "type": "str"}, + "output_resources": {"key": "outputResources", "type": "[ResourceReference]"}, + "validated_resources": {"key": "validatedResources", "type": "[ResourceReference]"}, + "error": {"key": "error", "type": "ErrorResponse"}, + "diagnostics": {"key": "diagnostics", "type": "[DeploymentDiagnosticsDefinition]"}, + "validation_level": {"key": "validationLevel", "type": "str"}, + } + + def __init__( + self, *, validation_level: Optional[Union[str, "_models.ValidationLevel"]] = None, **kwargs: Any + ) -> None: + """ + :keyword validation_level: The validation level of the deployment. Known values are: + "Template", "Provider", and "ProviderNoRbac". + :paramtype validation_level: str or ~azure.mgmt.deployments.deployments.models.ValidationLevel + """ + super().__init__(**kwargs) + self.provisioning_state: Optional[Union[str, "_models.ProvisioningState"]] = None + self.correlation_id: Optional[str] = None + self.timestamp: Optional[datetime.datetime] = None + self.duration: Optional[str] = None + self.outputs: Optional[JSON] = None + self.providers: Optional[List["_models.Provider"]] = None + self.dependencies: Optional[List["_models.Dependency"]] = None + self.template_link: Optional["_models.TemplateLink"] = None + self.parameters: Optional[JSON] = None + self.parameters_link: Optional["_models.ParametersLink"] = None + self.extensions: Optional[List["_models.DeploymentExtensionDefinition"]] = None + self.mode: Optional[Union[str, "_models.DeploymentMode"]] = None + self.debug_setting: Optional["_models.DebugSetting"] = None + self.on_error_deployment: Optional["_models.OnErrorDeploymentExtended"] = None + self.template_hash: Optional[str] = None + self.output_resources: Optional[List["_models.ResourceReference"]] = None + self.validated_resources: Optional[List["_models.ResourceReference"]] = None + self.error: Optional["_models.ErrorResponse"] = None + self.diagnostics: Optional[List["_models.DeploymentDiagnosticsDefinition"]] = None + self.validation_level = validation_level + + +class DeploymentValidateResult(_serialization.Model): + """Information from validate template deployment response. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar error: The deployment validation error. + :vartype error: ~azure.mgmt.deployments.deployments.models.ErrorResponse + :ivar id: The ID of the deployment. + :vartype id: str + :ivar name: The name of the deployment. + :vartype name: str + :ivar type: The type of the deployment. + :vartype type: str + :ivar properties: The template deployment properties. + :vartype properties: ~azure.mgmt.deployments.deployments.models.DeploymentPropertiesExtended + """ + + _validation = { + "error": {"readonly": True}, + "id": {"readonly": True}, + "name": {"readonly": True}, + "type": {"readonly": True}, + } + + _attribute_map = { + "error": {"key": "error", "type": "ErrorResponse"}, + "id": {"key": "id", "type": "str"}, + "name": {"key": "name", "type": "str"}, + "type": {"key": "type", "type": "str"}, + "properties": {"key": "properties", "type": "DeploymentPropertiesExtended"}, + } + + def __init__(self, *, properties: Optional["_models.DeploymentPropertiesExtended"] = None, **kwargs: Any) -> None: + """ + :keyword properties: The template deployment properties. + :paramtype properties: ~azure.mgmt.deployments.deployments.models.DeploymentPropertiesExtended + """ + super().__init__(**kwargs) + self.error: Optional["_models.ErrorResponse"] = None + self.id: Optional[str] = None + self.name: Optional[str] = None + self.type: Optional[str] = None + self.properties = properties + + +class DeploymentWhatIf(_serialization.Model): + """Deployment What-if operation parameters. + + All required parameters must be populated in order to send to server. + + :ivar location: The location to store the deployment data. + :vartype location: str + :ivar properties: The deployment properties. Required. + :vartype properties: ~azure.mgmt.deployments.deployments.models.DeploymentWhatIfProperties + """ + + _validation = { + "properties": {"required": True}, + } + + _attribute_map = { + "location": {"key": "location", "type": "str"}, + "properties": {"key": "properties", "type": "DeploymentWhatIfProperties"}, + } + + def __init__( + self, *, properties: "_models.DeploymentWhatIfProperties", location: Optional[str] = None, **kwargs: Any + ) -> None: + """ + :keyword location: The location to store the deployment data. + :paramtype location: str + :keyword properties: The deployment properties. Required. + :paramtype properties: ~azure.mgmt.deployments.deployments.models.DeploymentWhatIfProperties + """ + super().__init__(**kwargs) + self.location = location + self.properties = properties + + +class DeploymentWhatIfProperties(DeploymentProperties): + """Deployment What-if properties. + + All required parameters must be populated in order to send to server. + + :ivar template: The template content. You use this element when you want to pass the template + syntax directly in the request rather than link to an existing template. It can be a JObject or + well-formed JSON string. Use either the templateLink property or the template property, but not + both. + :vartype template: JSON + :ivar template_link: The URI of the template. Use either the templateLink property or the + template property, but not both. + :vartype template_link: ~azure.mgmt.deployments.deployments.models.TemplateLink + :ivar parameters: Name and value pairs that define the deployment parameters for the template. + You use this element when you want to provide the parameter values directly in the request + rather than link to an existing parameter file. Use either the parametersLink property or the + parameters property, but not both. It can be a JObject or a well formed JSON string. + :vartype parameters: dict[str, ~azure.mgmt.deployments.deployments.models.DeploymentParameter] + :ivar external_inputs: External input values, used by external tooling for parameter + evaluation. + :vartype external_inputs: dict[str, + ~azure.mgmt.deployments.deployments.models.DeploymentExternalInput] + :ivar external_input_definitions: External input definitions, used by external tooling to + define expected external input values. + :vartype external_input_definitions: dict[str, + ~azure.mgmt.deployments.deployments.models.DeploymentExternalInputDefinition] + :ivar parameters_link: The URI of parameters file. You use this element to link to an existing + parameters file. Use either the parametersLink property or the parameters property, but not + both. + :vartype parameters_link: ~azure.mgmt.deployments.deployments.models.ParametersLink + :ivar extension_configs: The configurations to use for deployment extensions. The keys of this + object are deployment extension aliases as defined in the deployment template. + :vartype extension_configs: dict[str, dict[str, + ~azure.mgmt.deployments.deployments.models.DeploymentExtensionConfigItem]] + :ivar mode: The mode that is used to deploy resources. This value can be either Incremental or + Complete. In Incremental mode, resources are deployed without deleting existing resources that + are not included in the template. In Complete mode, resources are deployed and existing + resources in the resource group that are not included in the template are deleted. Be careful + when using Complete mode as you may unintentionally delete resources. Required. Known values + are: "Incremental" and "Complete". + :vartype mode: str or ~azure.mgmt.deployments.deployments.models.DeploymentMode + :ivar debug_setting: The debug setting of the deployment. + :vartype debug_setting: ~azure.mgmt.deployments.deployments.models.DebugSetting + :ivar on_error_deployment: The deployment on error behavior. + :vartype on_error_deployment: ~azure.mgmt.deployments.deployments.models.OnErrorDeployment + :ivar expression_evaluation_options: Specifies whether template expressions are evaluated + within the scope of the parent template or nested template. Only applicable to nested + templates. If not specified, default value is outer. + :vartype expression_evaluation_options: + ~azure.mgmt.deployments.deployments.models.ExpressionEvaluationOptions + :ivar validation_level: The validation level of the deployment. Known values are: "Template", + "Provider", and "ProviderNoRbac". + :vartype validation_level: str or ~azure.mgmt.deployments.deployments.models.ValidationLevel + :ivar what_if_settings: Optional What-If operation settings. + :vartype what_if_settings: ~azure.mgmt.deployments.deployments.models.DeploymentWhatIfSettings + """ + + _validation = { + "mode": {"required": True}, + } + + _attribute_map = { + "template": {"key": "template", "type": "object"}, + "template_link": {"key": "templateLink", "type": "TemplateLink"}, + "parameters": {"key": "parameters", "type": "{DeploymentParameter}"}, + "external_inputs": {"key": "externalInputs", "type": "{DeploymentExternalInput}"}, + "external_input_definitions": { + "key": "externalInputDefinitions", + "type": "{DeploymentExternalInputDefinition}", + }, + "parameters_link": {"key": "parametersLink", "type": "ParametersLink"}, + "extension_configs": {"key": "extensionConfigs", "type": "{{DeploymentExtensionConfigItem}}"}, + "mode": {"key": "mode", "type": "str"}, + "debug_setting": {"key": "debugSetting", "type": "DebugSetting"}, + "on_error_deployment": {"key": "onErrorDeployment", "type": "OnErrorDeployment"}, + "expression_evaluation_options": {"key": "expressionEvaluationOptions", "type": "ExpressionEvaluationOptions"}, + "validation_level": {"key": "validationLevel", "type": "str"}, + "what_if_settings": {"key": "whatIfSettings", "type": "DeploymentWhatIfSettings"}, + } + + def __init__( + self, + *, + mode: Union[str, "_models.DeploymentMode"], + template: Optional[JSON] = None, + template_link: Optional["_models.TemplateLink"] = None, + parameters: Optional[Dict[str, "_models.DeploymentParameter"]] = None, + external_inputs: Optional[Dict[str, "_models.DeploymentExternalInput"]] = None, + external_input_definitions: Optional[Dict[str, "_models.DeploymentExternalInputDefinition"]] = None, + parameters_link: Optional["_models.ParametersLink"] = None, + extension_configs: Optional[Dict[str, Dict[str, "_models.DeploymentExtensionConfigItem"]]] = None, + debug_setting: Optional["_models.DebugSetting"] = None, + on_error_deployment: Optional["_models.OnErrorDeployment"] = None, + expression_evaluation_options: Optional["_models.ExpressionEvaluationOptions"] = None, + validation_level: Optional[Union[str, "_models.ValidationLevel"]] = None, + what_if_settings: Optional["_models.DeploymentWhatIfSettings"] = None, + **kwargs: Any + ) -> None: + """ + :keyword template: The template content. You use this element when you want to pass the + template syntax directly in the request rather than link to an existing template. It can be a + JObject or well-formed JSON string. Use either the templateLink property or the template + property, but not both. + :paramtype template: JSON + :keyword template_link: The URI of the template. Use either the templateLink property or the + template property, but not both. + :paramtype template_link: ~azure.mgmt.deployments.deployments.models.TemplateLink + :keyword parameters: Name and value pairs that define the deployment parameters for the + template. You use this element when you want to provide the parameter values directly in the + request rather than link to an existing parameter file. Use either the parametersLink property + or the parameters property, but not both. It can be a JObject or a well formed JSON string. + :paramtype parameters: dict[str, + ~azure.mgmt.deployments.deployments.models.DeploymentParameter] + :keyword external_inputs: External input values, used by external tooling for parameter + evaluation. + :paramtype external_inputs: dict[str, + ~azure.mgmt.deployments.deployments.models.DeploymentExternalInput] + :keyword external_input_definitions: External input definitions, used by external tooling to + define expected external input values. + :paramtype external_input_definitions: dict[str, + ~azure.mgmt.deployments.deployments.models.DeploymentExternalInputDefinition] + :keyword parameters_link: The URI of parameters file. You use this element to link to an + existing parameters file. Use either the parametersLink property or the parameters property, + but not both. + :paramtype parameters_link: ~azure.mgmt.deployments.deployments.models.ParametersLink + :keyword extension_configs: The configurations to use for deployment extensions. The keys of + this object are deployment extension aliases as defined in the deployment template. + :paramtype extension_configs: dict[str, dict[str, + ~azure.mgmt.deployments.deployments.models.DeploymentExtensionConfigItem]] + :keyword mode: The mode that is used to deploy resources. This value can be either Incremental + or Complete. In Incremental mode, resources are deployed without deleting existing resources + that are not included in the template. In Complete mode, resources are deployed and existing + resources in the resource group that are not included in the template are deleted. Be careful + when using Complete mode as you may unintentionally delete resources. Required. Known values + are: "Incremental" and "Complete". + :paramtype mode: str or ~azure.mgmt.deployments.deployments.models.DeploymentMode + :keyword debug_setting: The debug setting of the deployment. + :paramtype debug_setting: ~azure.mgmt.deployments.deployments.models.DebugSetting + :keyword on_error_deployment: The deployment on error behavior. + :paramtype on_error_deployment: ~azure.mgmt.deployments.deployments.models.OnErrorDeployment + :keyword expression_evaluation_options: Specifies whether template expressions are evaluated + within the scope of the parent template or nested template. Only applicable to nested + templates. If not specified, default value is outer. + :paramtype expression_evaluation_options: + ~azure.mgmt.deployments.deployments.models.ExpressionEvaluationOptions + :keyword validation_level: The validation level of the deployment. Known values are: + "Template", "Provider", and "ProviderNoRbac". + :paramtype validation_level: str or ~azure.mgmt.deployments.deployments.models.ValidationLevel + :keyword what_if_settings: Optional What-If operation settings. + :paramtype what_if_settings: + ~azure.mgmt.deployments.deployments.models.DeploymentWhatIfSettings + """ + super().__init__( + template=template, + template_link=template_link, + parameters=parameters, + external_inputs=external_inputs, + external_input_definitions=external_input_definitions, + parameters_link=parameters_link, + extension_configs=extension_configs, + mode=mode, + debug_setting=debug_setting, + on_error_deployment=on_error_deployment, + expression_evaluation_options=expression_evaluation_options, + validation_level=validation_level, + **kwargs + ) + self.what_if_settings = what_if_settings + + +class DeploymentWhatIfSettings(_serialization.Model): + """Deployment What-If operation settings. + + :ivar result_format: The format of the What-If results. Known values are: "ResourceIdOnly" and + "FullResourcePayloads". + :vartype result_format: str or ~azure.mgmt.deployments.deployments.models.WhatIfResultFormat + """ + + _attribute_map = { + "result_format": {"key": "resultFormat", "type": "str"}, + } + + def __init__( + self, *, result_format: Optional[Union[str, "_models.WhatIfResultFormat"]] = None, **kwargs: Any + ) -> None: + """ + :keyword result_format: The format of the What-If results. Known values are: "ResourceIdOnly" + and "FullResourcePayloads". + :paramtype result_format: str or ~azure.mgmt.deployments.deployments.models.WhatIfResultFormat + """ + super().__init__(**kwargs) + self.result_format = result_format + + +class ErrorAdditionalInfo(_serialization.Model): + """The resource management error additional info. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar type: The additional info type. + :vartype type: str + :ivar info: The additional info. + :vartype info: JSON + """ + + _validation = { + "type": {"readonly": True}, + "info": {"readonly": True}, + } + + _attribute_map = { + "type": {"key": "type", "type": "str"}, + "info": {"key": "info", "type": "object"}, + } + + def __init__(self, **kwargs: Any) -> None: + """ """ + super().__init__(**kwargs) + self.type: Optional[str] = None + self.info: Optional[JSON] = None + + +class ErrorResponse(_serialization.Model): + """Common error response for all Azure Resource Manager APIs to return error details for failed + operations. (This also follows the OData error response format.). + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar code: The error code. + :vartype code: str + :ivar message: The error message. + :vartype message: str + :ivar target: The error target. + :vartype target: str + :ivar details: The error details. + :vartype details: list[~azure.mgmt.deployments.deployments.models.ErrorResponse] + :ivar additional_info: The error additional info. + :vartype additional_info: list[~azure.mgmt.deployments.deployments.models.ErrorAdditionalInfo] + """ + + _validation = { + "code": {"readonly": True}, + "message": {"readonly": True}, + "target": {"readonly": True}, + "details": {"readonly": True}, + "additional_info": {"readonly": True}, + } + + _attribute_map = { + "code": {"key": "code", "type": "str"}, + "message": {"key": "message", "type": "str"}, + "target": {"key": "target", "type": "str"}, + "details": {"key": "details", "type": "[ErrorResponse]"}, + "additional_info": {"key": "additionalInfo", "type": "[ErrorAdditionalInfo]"}, + } + + def __init__(self, **kwargs: Any) -> None: + """ """ + super().__init__(**kwargs) + self.code: Optional[str] = None + self.message: Optional[str] = None + self.target: Optional[str] = None + self.details: Optional[List["_models.ErrorResponse"]] = None + self.additional_info: Optional[List["_models.ErrorAdditionalInfo"]] = None + + +class ExpressionEvaluationOptions(_serialization.Model): + """Specifies whether template expressions are evaluated within the scope of the parent template or + nested template. + + :ivar scope: The scope to be used for evaluation of parameters, variables and functions in a + nested template. Known values are: "NotSpecified", "Outer", and "Inner". + :vartype scope: str or + ~azure.mgmt.deployments.deployments.models.ExpressionEvaluationOptionsScopeType + """ + + _attribute_map = { + "scope": {"key": "scope", "type": "str"}, + } + + def __init__( + self, *, scope: Optional[Union[str, "_models.ExpressionEvaluationOptionsScopeType"]] = None, **kwargs: Any + ) -> None: + """ + :keyword scope: The scope to be used for evaluation of parameters, variables and functions in a + nested template. Known values are: "NotSpecified", "Outer", and "Inner". + :paramtype scope: str or + ~azure.mgmt.deployments.deployments.models.ExpressionEvaluationOptionsScopeType + """ + super().__init__(**kwargs) + self.scope = scope + + +class HttpMessage(_serialization.Model): + """HTTP message. + + :ivar content: HTTP message content. + :vartype content: JSON + """ + + _attribute_map = { + "content": {"key": "content", "type": "object"}, + } + + def __init__(self, *, content: Optional[JSON] = None, **kwargs: Any) -> None: + """ + :keyword content: HTTP message content. + :paramtype content: JSON + """ + super().__init__(**kwargs) + self.content = content + + +class KeyVaultParameterReference(_serialization.Model): + """Azure Key Vault parameter reference. + + All required parameters must be populated in order to send to server. + + :ivar key_vault: Azure Key Vault reference. Required. + :vartype key_vault: ~azure.mgmt.deployments.deployments.models.KeyVaultReference + :ivar secret_name: Azure Key Vault secret name. Required. + :vartype secret_name: str + :ivar secret_version: Azure Key Vault secret version. + :vartype secret_version: str + """ + + _validation = { + "key_vault": {"required": True}, + "secret_name": {"required": True}, + } + + _attribute_map = { + "key_vault": {"key": "keyVault", "type": "KeyVaultReference"}, + "secret_name": {"key": "secretName", "type": "str"}, + "secret_version": {"key": "secretVersion", "type": "str"}, + } + + def __init__( + self, + *, + key_vault: "_models.KeyVaultReference", + secret_name: str, + secret_version: Optional[str] = None, + **kwargs: Any + ) -> None: + """ + :keyword key_vault: Azure Key Vault reference. Required. + :paramtype key_vault: ~azure.mgmt.deployments.deployments.models.KeyVaultReference + :keyword secret_name: Azure Key Vault secret name. Required. + :paramtype secret_name: str + :keyword secret_version: Azure Key Vault secret version. + :paramtype secret_version: str + """ + super().__init__(**kwargs) + self.key_vault = key_vault + self.secret_name = secret_name + self.secret_version = secret_version + + +class KeyVaultReference(_serialization.Model): + """Azure Key Vault reference. + + All required parameters must be populated in order to send to server. + + :ivar id: Azure Key Vault resource id. Required. + :vartype id: str + """ + + _validation = { + "id": {"required": True}, + } + + _attribute_map = { + "id": {"key": "id", "type": "str"}, + } + + def __init__(self, *, id: str, **kwargs: Any) -> None: # pylint: disable=redefined-builtin + """ + :keyword id: Azure Key Vault resource id. Required. + :paramtype id: str + """ + super().__init__(**kwargs) + self.id = id + + +class OnErrorDeployment(_serialization.Model): + """Deployment on error behavior. + + :ivar type: The deployment on error behavior type. Possible values are LastSuccessful and + SpecificDeployment. Known values are: "LastSuccessful" and "SpecificDeployment". + :vartype type: str or ~azure.mgmt.deployments.deployments.models.OnErrorDeploymentType + :ivar deployment_name: The deployment to be used on error case. + :vartype deployment_name: str + """ + + _attribute_map = { + "type": {"key": "type", "type": "str"}, + "deployment_name": {"key": "deploymentName", "type": "str"}, + } + + def __init__( + self, + *, + type: Optional[Union[str, "_models.OnErrorDeploymentType"]] = None, + deployment_name: Optional[str] = None, + **kwargs: Any + ) -> None: + """ + :keyword type: The deployment on error behavior type. Possible values are LastSuccessful and + SpecificDeployment. Known values are: "LastSuccessful" and "SpecificDeployment". + :paramtype type: str or ~azure.mgmt.deployments.deployments.models.OnErrorDeploymentType + :keyword deployment_name: The deployment to be used on error case. + :paramtype deployment_name: str + """ + super().__init__(**kwargs) + self.type = type + self.deployment_name = deployment_name + + +class OnErrorDeploymentExtended(_serialization.Model): + """Deployment on error behavior with additional details. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar provisioning_state: The state of the provisioning for the on error deployment. + :vartype provisioning_state: str + :ivar type: The deployment on error behavior type. Possible values are LastSuccessful and + SpecificDeployment. Known values are: "LastSuccessful" and "SpecificDeployment". + :vartype type: str or ~azure.mgmt.deployments.deployments.models.OnErrorDeploymentType + :ivar deployment_name: The deployment to be used on error case. + :vartype deployment_name: str + """ + + _validation = { + "provisioning_state": {"readonly": True}, + } + + _attribute_map = { + "provisioning_state": {"key": "provisioningState", "type": "str"}, + "type": {"key": "type", "type": "str"}, + "deployment_name": {"key": "deploymentName", "type": "str"}, + } + + def __init__( + self, + *, + type: Optional[Union[str, "_models.OnErrorDeploymentType"]] = None, + deployment_name: Optional[str] = None, + **kwargs: Any + ) -> None: + """ + :keyword type: The deployment on error behavior type. Possible values are LastSuccessful and + SpecificDeployment. Known values are: "LastSuccessful" and "SpecificDeployment". + :paramtype type: str or ~azure.mgmt.deployments.deployments.models.OnErrorDeploymentType + :keyword deployment_name: The deployment to be used on error case. + :paramtype deployment_name: str + """ + super().__init__(**kwargs) + self.provisioning_state: Optional[str] = None + self.type = type + self.deployment_name = deployment_name + + +class ParametersLink(_serialization.Model): + """Entity representing the reference to the deployment parameters. + + All required parameters must be populated in order to send to server. + + :ivar uri: The URI of the parameters file. Required. + :vartype uri: str + :ivar content_version: If included, must match the ContentVersion in the template. + :vartype content_version: str + """ + + _validation = { + "uri": {"required": True}, + } + + _attribute_map = { + "uri": {"key": "uri", "type": "str"}, + "content_version": {"key": "contentVersion", "type": "str"}, + } + + def __init__(self, *, uri: str, content_version: Optional[str] = None, **kwargs: Any) -> None: + """ + :keyword uri: The URI of the parameters file. Required. + :paramtype uri: str + :keyword content_version: If included, must match the ContentVersion in the template. + :paramtype content_version: str + """ + super().__init__(**kwargs) + self.uri = uri + self.content_version = content_version + + +class Provider(_serialization.Model): + """Resource provider information. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar id: The provider ID. + :vartype id: str + :ivar namespace: The namespace of the resource provider. + :vartype namespace: str + :ivar registration_state: The registration state of the resource provider. + :vartype registration_state: str + :ivar registration_policy: The registration policy of the resource provider. + :vartype registration_policy: str + :ivar resource_types: The collection of provider resource types. + :vartype resource_types: list[~azure.mgmt.deployments.deployments.models.ProviderResourceType] + :ivar provider_authorization_consent_state: The provider authorization consent state. Known + values are: "NotSpecified", "Required", "NotRequired", and "Consented". + :vartype provider_authorization_consent_state: str or + ~azure.mgmt.deployments.deployments.models.ProviderAuthorizationConsentState + """ + + _validation = { + "id": {"readonly": True}, + "registration_state": {"readonly": True}, + "registration_policy": {"readonly": True}, + "resource_types": {"readonly": True}, + } + + _attribute_map = { + "id": {"key": "id", "type": "str"}, + "namespace": {"key": "namespace", "type": "str"}, + "registration_state": {"key": "registrationState", "type": "str"}, + "registration_policy": {"key": "registrationPolicy", "type": "str"}, + "resource_types": {"key": "resourceTypes", "type": "[ProviderResourceType]"}, + "provider_authorization_consent_state": {"key": "providerAuthorizationConsentState", "type": "str"}, + } + + def __init__( + self, + *, + namespace: Optional[str] = None, + provider_authorization_consent_state: Optional[Union[str, "_models.ProviderAuthorizationConsentState"]] = None, + **kwargs: Any + ) -> None: + """ + :keyword namespace: The namespace of the resource provider. + :paramtype namespace: str + :keyword provider_authorization_consent_state: The provider authorization consent state. Known + values are: "NotSpecified", "Required", "NotRequired", and "Consented". + :paramtype provider_authorization_consent_state: str or + ~azure.mgmt.deployments.deployments.models.ProviderAuthorizationConsentState + """ + super().__init__(**kwargs) + self.id: Optional[str] = None + self.namespace = namespace + self.registration_state: Optional[str] = None + self.registration_policy: Optional[str] = None + self.resource_types: Optional[List["_models.ProviderResourceType"]] = None + self.provider_authorization_consent_state = provider_authorization_consent_state + + +class ProviderExtendedLocation(_serialization.Model): + """The provider extended location. + + :ivar location: The azure location. + :vartype location: str + :ivar type: The extended location type. + :vartype type: str + :ivar extended_locations: The extended locations for the azure location. + :vartype extended_locations: list[str] + """ + + _attribute_map = { + "location": {"key": "location", "type": "str"}, + "type": {"key": "type", "type": "str"}, + "extended_locations": {"key": "extendedLocations", "type": "[str]"}, + } + + def __init__( + self, + *, + location: Optional[str] = None, + type: Optional[str] = None, + extended_locations: Optional[List[str]] = None, + **kwargs: Any + ) -> None: + """ + :keyword location: The azure location. + :paramtype location: str + :keyword type: The extended location type. + :paramtype type: str + :keyword extended_locations: The extended locations for the azure location. + :paramtype extended_locations: list[str] + """ + super().__init__(**kwargs) + self.location = location + self.type = type + self.extended_locations = extended_locations + + +class ProviderResourceType(_serialization.Model): + """Resource type managed by the resource provider. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar resource_type: The resource type. + :vartype resource_type: str + :ivar locations: The collection of locations where this resource type can be created. + :vartype locations: list[str] + :ivar location_mappings: The location mappings that are supported by this resource type. + :vartype location_mappings: + list[~azure.mgmt.deployments.deployments.models.ProviderExtendedLocation] + :ivar aliases: The aliases that are supported by this resource type. + :vartype aliases: list[~azure.mgmt.deployments.deployments.models.Alias] + :ivar api_versions: The API version. + :vartype api_versions: list[str] + :ivar default_api_version: The default API version. + :vartype default_api_version: str + :ivar zone_mappings: + :vartype zone_mappings: list[~azure.mgmt.deployments.deployments.models.ZoneMapping] + :ivar api_profiles: The API profiles for the resource provider. + :vartype api_profiles: list[~azure.mgmt.deployments.deployments.models.ApiProfile] + :ivar capabilities: The additional capabilities offered by this resource type. + :vartype capabilities: str + :ivar properties: The properties. + :vartype properties: dict[str, str] + """ + + _validation = { + "default_api_version": {"readonly": True}, + "api_profiles": {"readonly": True}, + } + + _attribute_map = { + "resource_type": {"key": "resourceType", "type": "str"}, + "locations": {"key": "locations", "type": "[str]"}, + "location_mappings": {"key": "locationMappings", "type": "[ProviderExtendedLocation]"}, + "aliases": {"key": "aliases", "type": "[Alias]"}, + "api_versions": {"key": "apiVersions", "type": "[str]"}, + "default_api_version": {"key": "defaultApiVersion", "type": "str"}, + "zone_mappings": {"key": "zoneMappings", "type": "[ZoneMapping]"}, + "api_profiles": {"key": "apiProfiles", "type": "[ApiProfile]"}, + "capabilities": {"key": "capabilities", "type": "str"}, + "properties": {"key": "properties", "type": "{str}"}, + } + + def __init__( + self, + *, + resource_type: Optional[str] = None, + locations: Optional[List[str]] = None, + location_mappings: Optional[List["_models.ProviderExtendedLocation"]] = None, + aliases: Optional[List["_models.Alias"]] = None, + api_versions: Optional[List[str]] = None, + zone_mappings: Optional[List["_models.ZoneMapping"]] = None, + capabilities: Optional[str] = None, + properties: Optional[Dict[str, str]] = None, + **kwargs: Any + ) -> None: + """ + :keyword resource_type: The resource type. + :paramtype resource_type: str + :keyword locations: The collection of locations where this resource type can be created. + :paramtype locations: list[str] + :keyword location_mappings: The location mappings that are supported by this resource type. + :paramtype location_mappings: + list[~azure.mgmt.deployments.deployments.models.ProviderExtendedLocation] + :keyword aliases: The aliases that are supported by this resource type. + :paramtype aliases: list[~azure.mgmt.deployments.deployments.models.Alias] + :keyword api_versions: The API version. + :paramtype api_versions: list[str] + :keyword zone_mappings: + :paramtype zone_mappings: list[~azure.mgmt.deployments.deployments.models.ZoneMapping] + :keyword capabilities: The additional capabilities offered by this resource type. + :paramtype capabilities: str + :keyword properties: The properties. + :paramtype properties: dict[str, str] + """ + super().__init__(**kwargs) + self.resource_type = resource_type + self.locations = locations + self.location_mappings = location_mappings + self.aliases = aliases + self.api_versions = api_versions + self.default_api_version: Optional[str] = None + self.zone_mappings = zone_mappings + self.api_profiles: Optional[List["_models.ApiProfile"]] = None + self.capabilities = capabilities + self.properties = properties + + +class ResourceProviderOperationDisplayProperties(_serialization.Model): # pylint: disable=name-too-long + """Resource provider operation's display properties. + + :ivar publisher: Operation description. + :vartype publisher: str + :ivar provider: Operation provider. + :vartype provider: str + :ivar resource: Operation resource. + :vartype resource: str + :ivar operation: Resource provider operation. + :vartype operation: str + :ivar description: Operation description. + :vartype description: str + """ + + _attribute_map = { + "publisher": {"key": "publisher", "type": "str"}, + "provider": {"key": "provider", "type": "str"}, + "resource": {"key": "resource", "type": "str"}, + "operation": {"key": "operation", "type": "str"}, + "description": {"key": "description", "type": "str"}, + } + + def __init__( + self, + *, + publisher: Optional[str] = None, + provider: Optional[str] = None, + resource: Optional[str] = None, + operation: Optional[str] = None, + description: Optional[str] = None, + **kwargs: Any + ) -> None: + """ + :keyword publisher: Operation description. + :paramtype publisher: str + :keyword provider: Operation provider. + :paramtype provider: str + :keyword resource: Operation resource. + :paramtype resource: str + :keyword operation: Resource provider operation. + :paramtype operation: str + :keyword description: Operation description. + :paramtype description: str + """ + super().__init__(**kwargs) + self.publisher = publisher + self.provider = provider + self.resource = resource + self.operation = operation + self.description = description + + +class ResourceReference(_serialization.Model): + """The resource Id model. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar id: The fully qualified Azure resource ID. + :vartype id: str + :ivar extension: The extension the resource was deployed with. + :vartype extension: ~azure.mgmt.deployments.deployments.models.DeploymentExtensionDefinition + :ivar resource_type: The resource type. + :vartype resource_type: str + :ivar identifiers: The extensible resource identifiers. + :vartype identifiers: JSON + :ivar api_version: The API version the resource was deployed with. + :vartype api_version: str + """ + + _validation = { + "id": {"readonly": True}, + "extension": {"readonly": True}, + "resource_type": {"readonly": True}, + "identifiers": {"readonly": True}, + "api_version": {"readonly": True}, + } + + _attribute_map = { + "id": {"key": "id", "type": "str"}, + "extension": {"key": "extension", "type": "DeploymentExtensionDefinition"}, + "resource_type": {"key": "resourceType", "type": "str"}, + "identifiers": {"key": "identifiers", "type": "object"}, + "api_version": {"key": "apiVersion", "type": "str"}, + } + + def __init__(self, **kwargs: Any) -> None: + """ """ + super().__init__(**kwargs) + self.id: Optional[str] = None + self.extension: Optional["_models.DeploymentExtensionDefinition"] = None + self.resource_type: Optional[str] = None + self.identifiers: Optional[JSON] = None + self.api_version: Optional[str] = None + + +class ScopedDeployment(_serialization.Model): + """Deployment operation parameters. + + All required parameters must be populated in order to send to server. + + :ivar location: The location to store the deployment data. Required. + :vartype location: str + :ivar properties: The deployment properties. Required. + :vartype properties: ~azure.mgmt.deployments.deployments.models.DeploymentProperties + :ivar tags: Deployment tags. + :vartype tags: dict[str, str] + """ + + _validation = { + "location": {"required": True}, + "properties": {"required": True}, + } + + _attribute_map = { + "location": {"key": "location", "type": "str"}, + "properties": {"key": "properties", "type": "DeploymentProperties"}, + "tags": {"key": "tags", "type": "{str}"}, + } + + def __init__( + self, + *, + location: str, + properties: "_models.DeploymentProperties", + tags: Optional[Dict[str, str]] = None, + **kwargs: Any + ) -> None: + """ + :keyword location: The location to store the deployment data. Required. + :paramtype location: str + :keyword properties: The deployment properties. Required. + :paramtype properties: ~azure.mgmt.deployments.deployments.models.DeploymentProperties + :keyword tags: Deployment tags. + :paramtype tags: dict[str, str] + """ + super().__init__(**kwargs) + self.location = location + self.properties = properties + self.tags = tags + + +class ScopedDeploymentWhatIf(_serialization.Model): + """Deployment What-if operation parameters. + + All required parameters must be populated in order to send to server. + + :ivar location: The location to store the deployment data. Required. + :vartype location: str + :ivar properties: The deployment properties. Required. + :vartype properties: ~azure.mgmt.deployments.deployments.models.DeploymentWhatIfProperties + """ + + _validation = { + "location": {"required": True}, + "properties": {"required": True}, + } + + _attribute_map = { + "location": {"key": "location", "type": "str"}, + "properties": {"key": "properties", "type": "DeploymentWhatIfProperties"}, + } + + def __init__(self, *, location: str, properties: "_models.DeploymentWhatIfProperties", **kwargs: Any) -> None: + """ + :keyword location: The location to store the deployment data. Required. + :paramtype location: str + :keyword properties: The deployment properties. Required. + :paramtype properties: ~azure.mgmt.deployments.deployments.models.DeploymentWhatIfProperties + """ + super().__init__(**kwargs) + self.location = location + self.properties = properties + + +class StatusMessage(_serialization.Model): + """Operation status message object. + + :ivar status: Status of the deployment operation. + :vartype status: str + :ivar error: The error reported by the operation. + :vartype error: ~azure.mgmt.deployments.deployments.models.ErrorResponse + """ + + _attribute_map = { + "status": {"key": "status", "type": "str"}, + "error": {"key": "error", "type": "ErrorResponse"}, + } + + def __init__( + self, *, status: Optional[str] = None, error: Optional["_models.ErrorResponse"] = None, **kwargs: Any + ) -> None: + """ + :keyword status: Status of the deployment operation. + :paramtype status: str + :keyword error: The error reported by the operation. + :paramtype error: ~azure.mgmt.deployments.deployments.models.ErrorResponse + """ + super().__init__(**kwargs) + self.status = status + self.error = error + + +class SubResource(_serialization.Model): + """Sub-resource. + + :ivar id: Resource ID. + :vartype id: str + """ + + _attribute_map = { + "id": {"key": "id", "type": "str"}, + } + + def __init__(self, *, id: Optional[str] = None, **kwargs: Any) -> None: # pylint: disable=redefined-builtin + """ + :keyword id: Resource ID. + :paramtype id: str + """ + super().__init__(**kwargs) + self.id = id + + +class TargetResource(_serialization.Model): + """Target resource. + + :ivar id: The Azure resource ID of the resource. + :vartype id: str + :ivar resource_name: The name of the resource. + :vartype resource_name: str + :ivar resource_type: The type of the resource. + :vartype resource_type: str + :ivar extension: The extension the resource was deployed with. + :vartype extension: ~azure.mgmt.deployments.deployments.models.DeploymentExtensionDefinition + :ivar identifiers: The extensible resource identifiers. + :vartype identifiers: JSON + :ivar api_version: The API version the resource was deployed with. + :vartype api_version: str + :ivar symbolic_name: The symbolic name of the resource as defined in the deployment template. + :vartype symbolic_name: str + """ + + _attribute_map = { + "id": {"key": "id", "type": "str"}, + "resource_name": {"key": "resourceName", "type": "str"}, + "resource_type": {"key": "resourceType", "type": "str"}, + "extension": {"key": "extension", "type": "DeploymentExtensionDefinition"}, + "identifiers": {"key": "identifiers", "type": "object"}, + "api_version": {"key": "apiVersion", "type": "str"}, + "symbolic_name": {"key": "symbolicName", "type": "str"}, + } + + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + resource_name: Optional[str] = None, + resource_type: Optional[str] = None, + extension: Optional["_models.DeploymentExtensionDefinition"] = None, + identifiers: Optional[JSON] = None, + api_version: Optional[str] = None, + symbolic_name: Optional[str] = None, + **kwargs: Any + ) -> None: + """ + :keyword id: The Azure resource ID of the resource. + :paramtype id: str + :keyword resource_name: The name of the resource. + :paramtype resource_name: str + :keyword resource_type: The type of the resource. + :paramtype resource_type: str + :keyword extension: The extension the resource was deployed with. + :paramtype extension: ~azure.mgmt.deployments.deployments.models.DeploymentExtensionDefinition + :keyword identifiers: The extensible resource identifiers. + :paramtype identifiers: JSON + :keyword api_version: The API version the resource was deployed with. + :paramtype api_version: str + :keyword symbolic_name: The symbolic name of the resource as defined in the deployment + template. + :paramtype symbolic_name: str + """ + super().__init__(**kwargs) + self.id = id + self.resource_name = resource_name + self.resource_type = resource_type + self.extension = extension + self.identifiers = identifiers + self.api_version = api_version + self.symbolic_name = symbolic_name + + +class TemplateHashResult(_serialization.Model): + """Result of the request to calculate template hash. It contains a string of minified template and + its hash. + + :ivar minified_template: The minified template string. + :vartype minified_template: str + :ivar template_hash: The template hash. + :vartype template_hash: str + """ + + _attribute_map = { + "minified_template": {"key": "minifiedTemplate", "type": "str"}, + "template_hash": {"key": "templateHash", "type": "str"}, + } + + def __init__( + self, *, minified_template: Optional[str] = None, template_hash: Optional[str] = None, **kwargs: Any + ) -> None: + """ + :keyword minified_template: The minified template string. + :paramtype minified_template: str + :keyword template_hash: The template hash. + :paramtype template_hash: str + """ + super().__init__(**kwargs) + self.minified_template = minified_template + self.template_hash = template_hash + + +class TemplateLink(_serialization.Model): + """Entity representing the reference to the template. + + :ivar uri: The URI of the template to deploy. Use either the uri or id property, but not both. + :vartype uri: str + :ivar id: The resource id of a Template Spec. Use either the id or uri property, but not both. + :vartype id: str + :ivar relative_path: The relativePath property can be used to deploy a linked template at a + location relative to the parent. If the parent template was linked with a TemplateSpec, this + will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child + deployment will be a combination of the parent and relativePath URIs. + :vartype relative_path: str + :ivar content_version: If included, must match the ContentVersion in the template. + :vartype content_version: str + :ivar query_string: The query string (for example, a SAS token) to be used with the + templateLink URI. + :vartype query_string: str + """ + + _attribute_map = { + "uri": {"key": "uri", "type": "str"}, + "id": {"key": "id", "type": "str"}, + "relative_path": {"key": "relativePath", "type": "str"}, + "content_version": {"key": "contentVersion", "type": "str"}, + "query_string": {"key": "queryString", "type": "str"}, + } + + def __init__( + self, + *, + uri: Optional[str] = None, + id: Optional[str] = None, # pylint: disable=redefined-builtin + relative_path: Optional[str] = None, + content_version: Optional[str] = None, + query_string: Optional[str] = None, + **kwargs: Any + ) -> None: + """ + :keyword uri: The URI of the template to deploy. Use either the uri or id property, but not + both. + :paramtype uri: str + :keyword id: The resource id of a Template Spec. Use either the id or uri property, but not + both. + :paramtype id: str + :keyword relative_path: The relativePath property can be used to deploy a linked template at a + location relative to the parent. If the parent template was linked with a TemplateSpec, this + will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child + deployment will be a combination of the parent and relativePath URIs. + :paramtype relative_path: str + :keyword content_version: If included, must match the ContentVersion in the template. + :paramtype content_version: str + :keyword query_string: The query string (for example, a SAS token) to be used with the + templateLink URI. + :paramtype query_string: str + """ + super().__init__(**kwargs) + self.uri = uri + self.id = id + self.relative_path = relative_path + self.content_version = content_version + self.query_string = query_string + + +class UserAssignedIdentity(_serialization.Model): + """User assigned identity properties. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar principal_id: The principal ID of the assigned identity. + :vartype principal_id: str + :ivar client_id: The client ID of the assigned identity. + :vartype client_id: str + """ + + _validation = { + "principal_id": {"readonly": True}, + "client_id": {"readonly": True}, + } + + _attribute_map = { + "principal_id": {"key": "principalId", "type": "str"}, + "client_id": {"key": "clientId", "type": "str"}, + } + + def __init__(self, **kwargs: Any) -> None: + """ """ + super().__init__(**kwargs) + self.principal_id: Optional[str] = None + self.client_id: Optional[str] = None + + +class WhatIfChange(_serialization.Model): + """Information about a single resource change predicted by What-If operation. + + All required parameters must be populated in order to send to server. + + :ivar resource_id: Resource ID. + :vartype resource_id: str + :ivar deployment_id: The resource id of the Deployment responsible for this change. + :vartype deployment_id: str + :ivar symbolic_name: The symbolic name of the resource responsible for this change. + :vartype symbolic_name: str + :ivar identifiers: A subset of properties that uniquely identify a Bicep extensible resource + because it lacks a resource id like an Azure resource has. + :vartype identifiers: JSON + :ivar extension: The extension the resource was deployed with. + :vartype extension: ~azure.mgmt.deployments.deployments.models.DeploymentExtensionDefinition + :ivar change_type: Type of change that will be made to the resource when the deployment is + executed. Required. Known values are: "Create", "Delete", "Ignore", "Deploy", "NoChange", + "Modify", and "Unsupported". + :vartype change_type: str or ~azure.mgmt.deployments.deployments.models.ChangeType + :ivar unsupported_reason: The explanation about why the resource is unsupported by What-If. + :vartype unsupported_reason: str + :ivar before: The snapshot of the resource before the deployment is executed. + :vartype before: JSON + :ivar after: The predicted snapshot of the resource after the deployment is executed. + :vartype after: JSON + :ivar delta: The predicted changes to resource properties. + :vartype delta: list[~azure.mgmt.deployments.deployments.models.WhatIfPropertyChange] + """ + + _validation = { + "change_type": {"required": True}, + } + + _attribute_map = { + "resource_id": {"key": "resourceId", "type": "str"}, + "deployment_id": {"key": "deploymentId", "type": "str"}, + "symbolic_name": {"key": "symbolicName", "type": "str"}, + "identifiers": {"key": "identifiers", "type": "object"}, + "extension": {"key": "extension", "type": "DeploymentExtensionDefinition"}, + "change_type": {"key": "changeType", "type": "str"}, + "unsupported_reason": {"key": "unsupportedReason", "type": "str"}, + "before": {"key": "before", "type": "object"}, + "after": {"key": "after", "type": "object"}, + "delta": {"key": "delta", "type": "[WhatIfPropertyChange]"}, + } + + def __init__( + self, + *, + change_type: Union[str, "_models.ChangeType"], + resource_id: Optional[str] = None, + deployment_id: Optional[str] = None, + symbolic_name: Optional[str] = None, + identifiers: Optional[JSON] = None, + extension: Optional["_models.DeploymentExtensionDefinition"] = None, + unsupported_reason: Optional[str] = None, + before: Optional[JSON] = None, + after: Optional[JSON] = None, + delta: Optional[List["_models.WhatIfPropertyChange"]] = None, + **kwargs: Any + ) -> None: + """ + :keyword resource_id: Resource ID. + :paramtype resource_id: str + :keyword deployment_id: The resource id of the Deployment responsible for this change. + :paramtype deployment_id: str + :keyword symbolic_name: The symbolic name of the resource responsible for this change. + :paramtype symbolic_name: str + :keyword identifiers: A subset of properties that uniquely identify a Bicep extensible resource + because it lacks a resource id like an Azure resource has. + :paramtype identifiers: JSON + :keyword extension: The extension the resource was deployed with. + :paramtype extension: ~azure.mgmt.deployments.deployments.models.DeploymentExtensionDefinition + :keyword change_type: Type of change that will be made to the resource when the deployment is + executed. Required. Known values are: "Create", "Delete", "Ignore", "Deploy", "NoChange", + "Modify", and "Unsupported". + :paramtype change_type: str or ~azure.mgmt.deployments.deployments.models.ChangeType + :keyword unsupported_reason: The explanation about why the resource is unsupported by What-If. + :paramtype unsupported_reason: str + :keyword before: The snapshot of the resource before the deployment is executed. + :paramtype before: JSON + :keyword after: The predicted snapshot of the resource after the deployment is executed. + :paramtype after: JSON + :keyword delta: The predicted changes to resource properties. + :paramtype delta: list[~azure.mgmt.deployments.deployments.models.WhatIfPropertyChange] + """ + super().__init__(**kwargs) + self.resource_id = resource_id + self.deployment_id = deployment_id + self.symbolic_name = symbolic_name + self.identifiers = identifiers + self.extension = extension + self.change_type = change_type + self.unsupported_reason = unsupported_reason + self.before = before + self.after = after + self.delta = delta + + +class WhatIfOperationResult(_serialization.Model): + """Result of the What-If operation. Contains a list of predicted changes and a URL link to get to + the next set of results. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar status: Status of the What-If operation. + :vartype status: str + :ivar error: Error when What-If operation fails. + :vartype error: ~azure.mgmt.deployments.deployments.models.ErrorResponse + :ivar changes: List of resource changes predicted by What-If operation. + :vartype changes: list[~azure.mgmt.deployments.deployments.models.WhatIfChange] + :ivar potential_changes: List of resource changes predicted by What-If operation. + :vartype potential_changes: list[~azure.mgmt.deployments.deployments.models.WhatIfChange] + :ivar diagnostics: List of resource diagnostics detected by What-If operation. + :vartype diagnostics: + list[~azure.mgmt.deployments.deployments.models.DeploymentDiagnosticsDefinition] + """ + + _validation = { + "diagnostics": {"readonly": True}, + } + + _attribute_map = { + "status": {"key": "status", "type": "str"}, + "error": {"key": "error", "type": "ErrorResponse"}, + "changes": {"key": "properties.changes", "type": "[WhatIfChange]"}, + "potential_changes": {"key": "properties.potentialChanges", "type": "[WhatIfChange]"}, + "diagnostics": {"key": "properties.diagnostics", "type": "[DeploymentDiagnosticsDefinition]"}, + } + + def __init__( + self, + *, + status: Optional[str] = None, + error: Optional["_models.ErrorResponse"] = None, + changes: Optional[List["_models.WhatIfChange"]] = None, + potential_changes: Optional[List["_models.WhatIfChange"]] = None, + **kwargs: Any + ) -> None: + """ + :keyword status: Status of the What-If operation. + :paramtype status: str + :keyword error: Error when What-If operation fails. + :paramtype error: ~azure.mgmt.deployments.deployments.models.ErrorResponse + :keyword changes: List of resource changes predicted by What-If operation. + :paramtype changes: list[~azure.mgmt.deployments.deployments.models.WhatIfChange] + :keyword potential_changes: List of resource changes predicted by What-If operation. + :paramtype potential_changes: list[~azure.mgmt.deployments.deployments.models.WhatIfChange] + """ + super().__init__(**kwargs) + self.status = status + self.error = error + self.changes = changes + self.potential_changes = potential_changes + self.diagnostics: Optional[List["_models.DeploymentDiagnosticsDefinition"]] = None + + +class WhatIfPropertyChange(_serialization.Model): + """The predicted change to the resource property. + + All required parameters must be populated in order to send to server. + + :ivar path: The path of the property. Required. + :vartype path: str + :ivar property_change_type: The type of property change. Required. Known values are: "Create", + "Delete", "Modify", "Array", and "NoEffect". + :vartype property_change_type: str or + ~azure.mgmt.deployments.deployments.models.PropertyChangeType + :ivar before: The value of the property before the deployment is executed. + :vartype before: JSON + :ivar after: The value of the property after the deployment is executed. + :vartype after: JSON + :ivar children: Nested property changes. + :vartype children: list[~azure.mgmt.deployments.deployments.models.WhatIfPropertyChange] + """ + + _validation = { + "path": {"required": True}, + "property_change_type": {"required": True}, + } + + _attribute_map = { + "path": {"key": "path", "type": "str"}, + "property_change_type": {"key": "propertyChangeType", "type": "str"}, + "before": {"key": "before", "type": "object"}, + "after": {"key": "after", "type": "object"}, + "children": {"key": "children", "type": "[WhatIfPropertyChange]"}, + } + + def __init__( + self, + *, + path: str, + property_change_type: Union[str, "_models.PropertyChangeType"], + before: Optional[JSON] = None, + after: Optional[JSON] = None, + children: Optional[List["_models.WhatIfPropertyChange"]] = None, + **kwargs: Any + ) -> None: + """ + :keyword path: The path of the property. Required. + :paramtype path: str + :keyword property_change_type: The type of property change. Required. Known values are: + "Create", "Delete", "Modify", "Array", and "NoEffect". + :paramtype property_change_type: str or + ~azure.mgmt.deployments.deployments.models.PropertyChangeType + :keyword before: The value of the property before the deployment is executed. + :paramtype before: JSON + :keyword after: The value of the property after the deployment is executed. + :paramtype after: JSON + :keyword children: Nested property changes. + :paramtype children: list[~azure.mgmt.deployments.deployments.models.WhatIfPropertyChange] + """ + super().__init__(**kwargs) + self.path = path + self.property_change_type = property_change_type + self.before = before + self.after = after + self.children = children + + +class ZoneMapping(_serialization.Model): + """ZoneMapping. + + :ivar location: The location of the zone mapping. + :vartype location: str + :ivar zones: + :vartype zones: list[str] + """ + + _attribute_map = { + "location": {"key": "location", "type": "str"}, + "zones": {"key": "zones", "type": "[str]"}, + } + + def __init__(self, *, location: Optional[str] = None, zones: Optional[List[str]] = None, **kwargs: Any) -> None: + """ + :keyword location: The location of the zone mapping. + :paramtype location: str + :keyword zones: + :paramtype zones: list[str] + """ + super().__init__(**kwargs) + self.location = location + self.zones = zones diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/models/_patch.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/models/_patch.py new file mode 100644 index 000000000000..8bcb627aa475 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/models/_patch.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/operations/__init__.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/operations/__init__.py new file mode 100644 index 000000000000..f44d6b8a48a6 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/operations/__init__.py @@ -0,0 +1,27 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._deployments_operations import DeploymentsOperations # type: ignore +from ._deployment_operations_operations import DeploymentOperationsOperations # type: ignore + +from ._patch import __all__ as _patch_all +from ._patch import * +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "DeploymentsOperations", + "DeploymentOperationsOperations", +] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore +_patch_sdk() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/operations/_deployment_operations_operations.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/operations/_deployment_operations_operations.py new file mode 100644 index 000000000000..0a604038367a --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/operations/_deployment_operations_operations.py @@ -0,0 +1,1093 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from collections.abc import MutableMapping +from typing import Any, Callable, Dict, Iterable, Optional, TypeVar +import urllib.parse + +from azure.core import PipelineClient +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error, +) +from azure.core.paging import ItemPaged +from azure.core.pipeline import PipelineResponse +from azure.core.rest import HttpRequest, HttpResponse +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict +from azure.mgmt.core.exceptions import ARMErrorFormat + +from .. import models as _models +from .._configuration import DeploymentsClientConfiguration +from .._utils.serialization import Deserializer, Serializer + +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] + +_SERIALIZER = Serializer() +_SERIALIZER.client_side_validation = False + + +def build_get_at_scope_request(scope: str, deployment_name: str, operation_id: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}" + ) + path_format_arguments = { + "scope": _SERIALIZER.url("scope", scope, "str", skip_quote=True), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "operationId": _SERIALIZER.url("operation_id", operation_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_list_at_scope_request( + scope: str, deployment_name: str, *, top: Optional[int] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop("template_url", "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/operations") + path_format_arguments = { + "scope": _SERIALIZER.url("scope", scope, "str", skip_quote=True), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if top is not None: + _params["$top"] = _SERIALIZER.query("top", top, "int") + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_get_at_tenant_scope_request(deployment_name: str, operation_id: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", "/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}" + ) + path_format_arguments = { + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "operationId": _SERIALIZER.url("operation_id", operation_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_list_at_tenant_scope_request( + deployment_name: str, *, top: Optional[int] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop("template_url", "/providers/Microsoft.Resources/deployments/{deploymentName}/operations") + path_format_arguments = { + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if top is not None: + _params["$top"] = _SERIALIZER.query("top", top, "int") + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_get_at_management_group_scope_request( # pylint: disable=name-too-long + group_id: str, deployment_name: str, operation_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}", + ) + path_format_arguments = { + "groupId": _SERIALIZER.url("group_id", group_id, "str", max_length=90, min_length=1), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "operationId": _SERIALIZER.url("operation_id", operation_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_list_at_management_group_scope_request( # pylint: disable=name-too-long + group_id: str, deployment_name: str, *, top: Optional[int] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations", + ) + path_format_arguments = { + "groupId": _SERIALIZER.url("group_id", group_id, "str", max_length=90, min_length=1), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if top is not None: + _params["$top"] = _SERIALIZER.query("top", top, "int") + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_get_at_subscription_scope_request( + deployment_name: str, operation_id: str, subscription_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}", + ) + path_format_arguments = { + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "operationId": _SERIALIZER.url("operation_id", operation_id, "str"), + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_list_at_subscription_scope_request( + deployment_name: str, subscription_id: str, *, top: Optional[int] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations", + ) + path_format_arguments = { + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if top is not None: + _params["$top"] = _SERIALIZER.query("top", top, "int") + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_get_request( + resource_group_name: str, deployment_name: str, operation_id: str, subscription_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations/{operationId}", + ) + path_format_arguments = { + "resourceGroupName": _SERIALIZER.url( + "resource_group_name", resource_group_name, "str", max_length=90, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "operationId": _SERIALIZER.url("operation_id", operation_id, "str"), + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_list_request( + resource_group_name: str, deployment_name: str, subscription_id: str, *, top: Optional[int] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations", + ) + path_format_arguments = { + "resourceGroupName": _SERIALIZER.url( + "resource_group_name", resource_group_name, "str", max_length=90, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if top is not None: + _params["$top"] = _SERIALIZER.query("top", top, "int") + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +class DeploymentOperationsOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.mgmt.deployments.deployments.DeploymentsClient`'s + :attr:`deployment_operations` attribute. + """ + + models = _models + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client: PipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: DeploymentsClientConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace + def get_at_scope( + self, scope: str, deployment_name: str, operation_id: str, **kwargs: Any + ) -> _models.DeploymentOperation: + """Gets a deployments operation. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param operation_id: The ID of the operation to get. Required. + :type operation_id: str + :return: DeploymentOperation or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentOperation + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentOperation] = kwargs.pop("cls", None) + + _request = build_get_at_scope_request( + scope=scope, + deployment_name=deployment_name, + operation_id=operation_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentOperation", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_at_scope( + self, scope: str, deployment_name: str, top: Optional[int] = None, **kwargs: Any + ) -> Iterable["_models.DeploymentOperation"]: + """Gets all deployments operations for a deployment. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param top: The number of results to return. Default value is None. + :type top: int + :return: An iterator like instance of either DeploymentOperation or the result of cls(response) + :rtype: + ~azure.core.paging.ItemPaged[~azure.mgmt.deployments.deployments.models.DeploymentOperation] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentOperationsListResult] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_list_at_scope_request( + scope=scope, + deployment_name=deployment_name, + top=top, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request + + def extract_data(pipeline_response): + deserialized = self._deserialize("DeploymentOperationsListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + @distributed_trace + def get_at_tenant_scope( + self, deployment_name: str, operation_id: str, **kwargs: Any + ) -> _models.DeploymentOperation: + """Gets a deployments operation. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param operation_id: The ID of the operation to get. Required. + :type operation_id: str + :return: DeploymentOperation or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentOperation + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentOperation] = kwargs.pop("cls", None) + + _request = build_get_at_tenant_scope_request( + deployment_name=deployment_name, + operation_id=operation_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentOperation", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_at_tenant_scope( + self, deployment_name: str, top: Optional[int] = None, **kwargs: Any + ) -> Iterable["_models.DeploymentOperation"]: + """Gets all deployments operations for a deployment. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param top: The number of results to return. Default value is None. + :type top: int + :return: An iterator like instance of either DeploymentOperation or the result of cls(response) + :rtype: + ~azure.core.paging.ItemPaged[~azure.mgmt.deployments.deployments.models.DeploymentOperation] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentOperationsListResult] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_list_at_tenant_scope_request( + deployment_name=deployment_name, + top=top, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request + + def extract_data(pipeline_response): + deserialized = self._deserialize("DeploymentOperationsListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + @distributed_trace + def get_at_management_group_scope( + self, group_id: str, deployment_name: str, operation_id: str, **kwargs: Any + ) -> _models.DeploymentOperation: + """Gets a deployments operation. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param operation_id: The ID of the operation to get. Required. + :type operation_id: str + :return: DeploymentOperation or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentOperation + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentOperation] = kwargs.pop("cls", None) + + _request = build_get_at_management_group_scope_request( + group_id=group_id, + deployment_name=deployment_name, + operation_id=operation_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentOperation", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_at_management_group_scope( + self, group_id: str, deployment_name: str, top: Optional[int] = None, **kwargs: Any + ) -> Iterable["_models.DeploymentOperation"]: + """Gets all deployments operations for a deployment. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param top: The number of results to return. Default value is None. + :type top: int + :return: An iterator like instance of either DeploymentOperation or the result of cls(response) + :rtype: + ~azure.core.paging.ItemPaged[~azure.mgmt.deployments.deployments.models.DeploymentOperation] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentOperationsListResult] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_list_at_management_group_scope_request( + group_id=group_id, + deployment_name=deployment_name, + top=top, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request + + def extract_data(pipeline_response): + deserialized = self._deserialize("DeploymentOperationsListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + @distributed_trace + def get_at_subscription_scope( + self, deployment_name: str, operation_id: str, **kwargs: Any + ) -> _models.DeploymentOperation: + """Gets a deployments operation. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param operation_id: The ID of the operation to get. Required. + :type operation_id: str + :return: DeploymentOperation or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentOperation + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentOperation] = kwargs.pop("cls", None) + + _request = build_get_at_subscription_scope_request( + deployment_name=deployment_name, + operation_id=operation_id, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentOperation", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_at_subscription_scope( + self, deployment_name: str, top: Optional[int] = None, **kwargs: Any + ) -> Iterable["_models.DeploymentOperation"]: + """Gets all deployments operations for a deployment. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param top: The number of results to return. Default value is None. + :type top: int + :return: An iterator like instance of either DeploymentOperation or the result of cls(response) + :rtype: + ~azure.core.paging.ItemPaged[~azure.mgmt.deployments.deployments.models.DeploymentOperation] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentOperationsListResult] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_list_at_subscription_scope_request( + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + top=top, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request + + def extract_data(pipeline_response): + deserialized = self._deserialize("DeploymentOperationsListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + @distributed_trace + def get( + self, resource_group_name: str, deployment_name: str, operation_id: str, **kwargs: Any + ) -> _models.DeploymentOperation: + """Gets a deployments operation. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param operation_id: The ID of the operation to get. Required. + :type operation_id: str + :return: DeploymentOperation or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentOperation + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentOperation] = kwargs.pop("cls", None) + + _request = build_get_request( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + operation_id=operation_id, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentOperation", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list( + self, resource_group_name: str, deployment_name: str, top: Optional[int] = None, **kwargs: Any + ) -> Iterable["_models.DeploymentOperation"]: + """Gets all deployments operations for a deployment. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param top: The number of results to return. Default value is None. + :type top: int + :return: An iterator like instance of either DeploymentOperation or the result of cls(response) + :rtype: + ~azure.core.paging.ItemPaged[~azure.mgmt.deployments.deployments.models.DeploymentOperation] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentOperationsListResult] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_list_request( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + top=top, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request + + def extract_data(pipeline_response): + deserialized = self._deserialize("DeploymentOperationsListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + return pipeline_response + + return ItemPaged(get_next, extract_data) diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/operations/_deployments_operations.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/operations/_deployments_operations.py new file mode 100644 index 000000000000..8d67332855d5 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/operations/_deployments_operations.py @@ -0,0 +1,6164 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from collections.abc import MutableMapping +from io import IOBase +from typing import Any, Callable, Dict, IO, Iterable, Iterator, Optional, TypeVar, Union, cast, overload +import urllib.parse + +from azure.core import PipelineClient +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + StreamClosedError, + StreamConsumedError, + map_error, +) +from azure.core.paging import ItemPaged +from azure.core.pipeline import PipelineResponse +from azure.core.polling import LROPoller, NoPolling, PollingMethod +from azure.core.rest import HttpRequest, HttpResponse +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict +from azure.mgmt.core.exceptions import ARMErrorFormat +from azure.mgmt.core.polling.arm_polling import ARMPolling + +from .. import models as _models +from .._configuration import DeploymentsClientConfiguration +from .._utils.serialization import Deserializer, Serializer + +JSON = MutableMapping[str, Any] +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] + +_SERIALIZER = Serializer() +_SERIALIZER.client_side_validation = False + + +def build_delete_at_scope_request(scope: str, deployment_name: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop("template_url", "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}") + path_format_arguments = { + "scope": _SERIALIZER.url("scope", scope, "str", skip_quote=True), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_check_existence_at_scope_request(scope: str, deployment_name: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop("template_url", "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}") + path_format_arguments = { + "scope": _SERIALIZER.url("scope", scope, "str", skip_quote=True), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="HEAD", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_create_or_update_at_scope_request(scope: str, deployment_name: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop("template_url", "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}") + path_format_arguments = { + "scope": _SERIALIZER.url("scope", scope, "str", skip_quote=True), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_get_at_scope_request(scope: str, deployment_name: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop("template_url", "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}") + path_format_arguments = { + "scope": _SERIALIZER.url("scope", scope, "str", skip_quote=True), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_cancel_at_scope_request(scope: str, deployment_name: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop("template_url", "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel") + path_format_arguments = { + "scope": _SERIALIZER.url("scope", scope, "str", skip_quote=True), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_validate_at_scope_request(scope: str, deployment_name: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop("template_url", "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/validate") + path_format_arguments = { + "scope": _SERIALIZER.url("scope", scope, "str", skip_quote=True), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_export_template_at_scope_request(scope: str, deployment_name: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate" + ) + path_format_arguments = { + "scope": _SERIALIZER.url("scope", scope, "str", skip_quote=True), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_list_at_scope_request( + scope: str, *, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop("template_url", "/{scope}/providers/Microsoft.Resources/deployments/") + path_format_arguments = { + "scope": _SERIALIZER.url("scope", scope, "str", skip_quote=True), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if filter is not None: + _params["$filter"] = _SERIALIZER.query("filter", filter, "str") + if top is not None: + _params["$top"] = _SERIALIZER.query("top", top, "int") + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_delete_at_tenant_scope_request(deployment_name: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop("template_url", "/providers/Microsoft.Resources/deployments/{deploymentName}") + path_format_arguments = { + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_check_existence_at_tenant_scope_request( # pylint: disable=name-too-long + deployment_name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop("template_url", "/providers/Microsoft.Resources/deployments/{deploymentName}") + path_format_arguments = { + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="HEAD", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_create_or_update_at_tenant_scope_request( # pylint: disable=name-too-long + deployment_name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop("template_url", "/providers/Microsoft.Resources/deployments/{deploymentName}") + path_format_arguments = { + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_get_at_tenant_scope_request(deployment_name: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop("template_url", "/providers/Microsoft.Resources/deployments/{deploymentName}") + path_format_arguments = { + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_cancel_at_tenant_scope_request(deployment_name: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop("template_url", "/providers/Microsoft.Resources/deployments/{deploymentName}/cancel") + path_format_arguments = { + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_validate_at_tenant_scope_request(deployment_name: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop("template_url", "/providers/Microsoft.Resources/deployments/{deploymentName}/validate") + path_format_arguments = { + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_what_if_at_tenant_scope_request(deployment_name: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop("template_url", "/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf") + path_format_arguments = { + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_export_template_at_tenant_scope_request( # pylint: disable=name-too-long + deployment_name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop("template_url", "/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate") + path_format_arguments = { + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_list_at_tenant_scope_request( + *, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop("template_url", "/providers/Microsoft.Resources/deployments/") + + # Construct parameters + if filter is not None: + _params["$filter"] = _SERIALIZER.query("filter", filter, "str") + if top is not None: + _params["$top"] = _SERIALIZER.query("top", top, "int") + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_delete_at_management_group_scope_request( # pylint: disable=name-too-long + group_id: str, deployment_name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}", + ) + path_format_arguments = { + "groupId": _SERIALIZER.url("group_id", group_id, "str", max_length=90, min_length=1), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_check_existence_at_management_group_scope_request( # pylint: disable=name-too-long + group_id: str, deployment_name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}", + ) + path_format_arguments = { + "groupId": _SERIALIZER.url("group_id", group_id, "str", max_length=90, min_length=1), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="HEAD", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_create_or_update_at_management_group_scope_request( # pylint: disable=name-too-long + group_id: str, deployment_name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}", + ) + path_format_arguments = { + "groupId": _SERIALIZER.url("group_id", group_id, "str", max_length=90, min_length=1), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_get_at_management_group_scope_request( # pylint: disable=name-too-long + group_id: str, deployment_name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}", + ) + path_format_arguments = { + "groupId": _SERIALIZER.url("group_id", group_id, "str", max_length=90, min_length=1), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_cancel_at_management_group_scope_request( # pylint: disable=name-too-long + group_id: str, deployment_name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel", + ) + path_format_arguments = { + "groupId": _SERIALIZER.url("group_id", group_id, "str", max_length=90, min_length=1), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_validate_at_management_group_scope_request( # pylint: disable=name-too-long + group_id: str, deployment_name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate", + ) + path_format_arguments = { + "groupId": _SERIALIZER.url("group_id", group_id, "str", max_length=90, min_length=1), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_what_if_at_management_group_scope_request( # pylint: disable=name-too-long + group_id: str, deployment_name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf", + ) + path_format_arguments = { + "groupId": _SERIALIZER.url("group_id", group_id, "str", max_length=90, min_length=1), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_export_template_at_management_group_scope_request( # pylint: disable=name-too-long + group_id: str, deployment_name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate", + ) + path_format_arguments = { + "groupId": _SERIALIZER.url("group_id", group_id, "str", max_length=90, min_length=1), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_list_at_management_group_scope_request( # pylint: disable=name-too-long + group_id: str, *, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/", + ) + path_format_arguments = { + "groupId": _SERIALIZER.url("group_id", group_id, "str", max_length=90, min_length=1), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if filter is not None: + _params["$filter"] = _SERIALIZER.query("filter", filter, "str") + if top is not None: + _params["$top"] = _SERIALIZER.query("top", top, "int") + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_delete_at_subscription_scope_request( # pylint: disable=name-too-long + deployment_name: str, subscription_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}" + ) + path_format_arguments = { + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_check_existence_at_subscription_scope_request( # pylint: disable=name-too-long + deployment_name: str, subscription_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}" + ) + path_format_arguments = { + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="HEAD", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_create_or_update_at_subscription_scope_request( # pylint: disable=name-too-long + deployment_name: str, subscription_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}" + ) + path_format_arguments = { + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_get_at_subscription_scope_request(deployment_name: str, subscription_id: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}" + ) + path_format_arguments = { + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_cancel_at_subscription_scope_request( # pylint: disable=name-too-long + deployment_name: str, subscription_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel", + ) + path_format_arguments = { + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_validate_at_subscription_scope_request( # pylint: disable=name-too-long + deployment_name: str, subscription_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate", + ) + path_format_arguments = { + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_what_if_at_subscription_scope_request( # pylint: disable=name-too-long + deployment_name: str, subscription_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf", + ) + path_format_arguments = { + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_export_template_at_subscription_scope_request( # pylint: disable=name-too-long + deployment_name: str, subscription_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate", + ) + path_format_arguments = { + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_list_at_subscription_scope_request( + subscription_id: str, *, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop("template_url", "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/") + path_format_arguments = { + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if filter is not None: + _params["$filter"] = _SERIALIZER.query("filter", filter, "str") + if top is not None: + _params["$top"] = _SERIALIZER.query("top", top, "int") + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_delete_request( + resource_group_name: str, deployment_name: str, subscription_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}", + ) + path_format_arguments = { + "resourceGroupName": _SERIALIZER.url( + "resource_group_name", resource_group_name, "str", max_length=90, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_check_existence_request( + resource_group_name: str, deployment_name: str, subscription_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}", + ) + path_format_arguments = { + "resourceGroupName": _SERIALIZER.url( + "resource_group_name", resource_group_name, "str", max_length=90, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="HEAD", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_create_or_update_request( + resource_group_name: str, deployment_name: str, subscription_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}", + ) + path_format_arguments = { + "resourceGroupName": _SERIALIZER.url( + "resource_group_name", resource_group_name, "str", max_length=90, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_get_request( + resource_group_name: str, deployment_name: str, subscription_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}", + ) + path_format_arguments = { + "resourceGroupName": _SERIALIZER.url( + "resource_group_name", resource_group_name, "str", max_length=90, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_cancel_request( + resource_group_name: str, deployment_name: str, subscription_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel", + ) + path_format_arguments = { + "resourceGroupName": _SERIALIZER.url( + "resource_group_name", resource_group_name, "str", max_length=90, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_validate_request( + resource_group_name: str, deployment_name: str, subscription_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate", + ) + path_format_arguments = { + "resourceGroupName": _SERIALIZER.url( + "resource_group_name", resource_group_name, "str", max_length=90, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_what_if_request( + resource_group_name: str, deployment_name: str, subscription_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf", + ) + path_format_arguments = { + "resourceGroupName": _SERIALIZER.url( + "resource_group_name", resource_group_name, "str", max_length=90, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_export_template_request( + resource_group_name: str, deployment_name: str, subscription_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate", + ) + path_format_arguments = { + "resourceGroupName": _SERIALIZER.url( + "resource_group_name", resource_group_name, "str", max_length=90, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "deploymentName": _SERIALIZER.url( + "deployment_name", deployment_name, "str", max_length=64, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_list_by_resource_group_request( + resource_group_name: str, + subscription_id: str, + *, + filter: Optional[str] = None, + top: Optional[int] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop( + "template_url", + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/", + ) + path_format_arguments = { + "resourceGroupName": _SERIALIZER.url( + "resource_group_name", resource_group_name, "str", max_length=90, min_length=1, pattern=r"^[-\w\._\(\)]+$" + ), + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if filter is not None: + _params["$filter"] = _SERIALIZER.query("filter", filter, "str") + if top is not None: + _params["$top"] = _SERIALIZER.query("top", top, "int") + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_calculate_template_hash_request(*, json: JSON, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01")) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = kwargs.pop("template_url", "/providers/Microsoft.Resources/calculateTemplateHash") + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, json=json, **kwargs) + + +class DeploymentsOperations: # pylint: disable=too-many-public-methods + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.mgmt.deployments.deployments.DeploymentsClient`'s + :attr:`deployments` attribute. + """ + + models = _models + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client: PipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: DeploymentsClientConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + def _delete_at_scope_initial(self, scope: str, deployment_name: str, **kwargs: Any) -> Iterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + + _request = build_delete_at_scope_request( + scope=scope, + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202, 204]: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def begin_delete_at_scope(self, scope: str, deployment_name: str, **kwargs: Any) -> LROPoller[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. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: An instance of LROPoller that returns either None or the result of cls(response) + :rtype: ~azure.core.polling.LROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._delete_at_scope_initial( + scope=scope, + deployment_name=deployment_name, + api_version=api_version, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + if polling is True: + polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[None].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore + + @distributed_trace + def check_existence_at_scope(self, scope: str, deployment_name: str, **kwargs: Any) -> bool: + """Checks whether the deployment exists. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: bool or the result of cls(response) + :rtype: bool + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_check_existence_at_scope_request( + scope=scope, + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204, 404]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + return 200 <= response.status_code <= 299 + + def _create_or_update_at_scope_initial( + self, scope: str, deployment_name: str, parameters: Union[_models.Deployment, IO[bytes]], **kwargs: Any + ) -> Iterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "Deployment") + + _request = build_create_or_update_at_scope_request( + scope=scope, + deployment_name=deployment_name, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def begin_create_or_update_at_scope( + self, + scope: str, + deployment_name: str, + parameters: _models.Deployment, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.DeploymentExtended]: + """Deploys resources at a given scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def begin_create_or_update_at_scope( + self, + scope: str, + deployment_name: str, + parameters: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.DeploymentExtended]: + """Deploys resources at a given scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def begin_create_or_update_at_scope( + self, scope: str, deployment_name: str, parameters: Union[_models.Deployment, IO[bytes]], **kwargs: Any + ) -> LROPoller[_models.DeploymentExtended]: + """Deploys resources at a given scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Is either a Deployment type + or a IO[bytes] type. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment or IO[bytes] + :return: An instance of LROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DeploymentExtended] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._create_or_update_at_scope_initial( + scope=scope, + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("DeploymentExtended", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[_models.DeploymentExtended].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.DeploymentExtended]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @distributed_trace + def get_at_scope(self, scope: str, deployment_name: str, **kwargs: Any) -> _models.DeploymentExtended: + """Gets a deployment. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: DeploymentExtended or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentExtended + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentExtended] = kwargs.pop("cls", None) + + _request = build_get_at_scope_request( + scope=scope, + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentExtended", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def cancel_at_scope( # pylint: disable=inconsistent-return-statements + self, scope: str, deployment_name: str, **kwargs: Any + ) -> 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. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: None or the result of cls(response) + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_cancel_at_scope_request( + scope=scope, + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + def _validate_at_scope_initial( + self, scope: str, deployment_name: str, parameters: Union[_models.Deployment, IO[bytes]], **kwargs: Any + ) -> Iterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "Deployment") + + _request = build_validate_at_scope_request( + scope=scope, + deployment_name=deployment_name, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 202, 400]: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def begin_validate_at_scope( + self, + scope: str, + deployment_name: str, + parameters: _models.Deployment, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either DeploymentValidateResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def begin_validate_at_scope( + self, + scope: str, + deployment_name: str, + parameters: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either DeploymentValidateResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def begin_validate_at_scope( + self, scope: str, deployment_name: str, parameters: Union[_models.Deployment, IO[bytes]], **kwargs: Any + ) -> LROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Is either a Deployment type or a IO[bytes] type. + Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment or IO[bytes] + :return: An instance of LROPoller that returns either DeploymentValidateResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DeploymentValidateResult] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._validate_at_scope_initial( + scope=scope, + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("DeploymentValidateResult", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[_models.DeploymentValidateResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.DeploymentValidateResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @distributed_trace + def export_template_at_scope( + self, scope: str, deployment_name: str, **kwargs: Any + ) -> _models.DeploymentExportResult: + """Exports the template used for specified deployment. + + :param scope: The resource scope. Required. + :type scope: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: DeploymentExportResult or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentExportResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentExportResult] = kwargs.pop("cls", None) + + _request = build_export_template_at_scope_request( + scope=scope, + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentExportResult", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_at_scope( + self, scope: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any + ) -> Iterable["_models.DeploymentExtended"]: + """Get all the deployments at the given scope. + + :param scope: The resource scope. Required. + :type scope: str + :param filter: The filter to apply on the operation. For example, you can use + $filter=provisioningState eq '{state}'. Default value is None. + :type filter: str + :param top: The number of results to get. If null is passed, returns all deployments. Default + value is None. + :type top: int + :return: An iterator like instance of either DeploymentExtended or the result of cls(response) + :rtype: + ~azure.core.paging.ItemPaged[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentListResult] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_list_at_scope_request( + scope=scope, + filter=filter, + top=top, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request + + def extract_data(pipeline_response): + deserialized = self._deserialize("DeploymentListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + def _delete_at_tenant_scope_initial(self, deployment_name: str, **kwargs: Any) -> Iterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + + _request = build_delete_at_tenant_scope_request( + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202, 204]: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def begin_delete_at_tenant_scope(self, deployment_name: str, **kwargs: Any) -> LROPoller[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. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: An instance of LROPoller that returns either None or the result of cls(response) + :rtype: ~azure.core.polling.LROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._delete_at_tenant_scope_initial( + deployment_name=deployment_name, + api_version=api_version, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + if polling is True: + polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[None].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore + + @distributed_trace + def check_existence_at_tenant_scope(self, deployment_name: str, **kwargs: Any) -> bool: + """Checks whether the deployment exists. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: bool or the result of cls(response) + :rtype: bool + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_check_existence_at_tenant_scope_request( + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204, 404]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + return 200 <= response.status_code <= 299 + + def _create_or_update_at_tenant_scope_initial( # pylint: disable=name-too-long + self, deployment_name: str, parameters: Union[_models.ScopedDeployment, IO[bytes]], **kwargs: Any + ) -> Iterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "ScopedDeployment") + + _request = build_create_or_update_at_tenant_scope_request( + deployment_name=deployment_name, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def begin_create_or_update_at_tenant_scope( + self, + deployment_name: str, + parameters: _models.ScopedDeployment, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.DeploymentExtended]: + """Deploys resources at tenant scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeployment + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def begin_create_or_update_at_tenant_scope( + self, deployment_name: str, parameters: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.DeploymentExtended]: + """Deploys resources at tenant scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def begin_create_or_update_at_tenant_scope( + self, deployment_name: str, parameters: Union[_models.ScopedDeployment, IO[bytes]], **kwargs: Any + ) -> LROPoller[_models.DeploymentExtended]: + """Deploys resources at tenant scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Is either a + ScopedDeployment type or a IO[bytes] type. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeployment or IO[bytes] + :return: An instance of LROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DeploymentExtended] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._create_or_update_at_tenant_scope_initial( + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("DeploymentExtended", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[_models.DeploymentExtended].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.DeploymentExtended]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @distributed_trace + def get_at_tenant_scope(self, deployment_name: str, **kwargs: Any) -> _models.DeploymentExtended: + """Gets a deployment. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: DeploymentExtended or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentExtended + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentExtended] = kwargs.pop("cls", None) + + _request = build_get_at_tenant_scope_request( + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentExtended", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def cancel_at_tenant_scope( # pylint: disable=inconsistent-return-statements + self, deployment_name: str, **kwargs: Any + ) -> 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. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: None or the result of cls(response) + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_cancel_at_tenant_scope_request( + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + def _validate_at_tenant_scope_initial( + self, deployment_name: str, parameters: Union[_models.ScopedDeployment, IO[bytes]], **kwargs: Any + ) -> Iterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "ScopedDeployment") + + _request = build_validate_at_tenant_scope_request( + deployment_name=deployment_name, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 202, 400]: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def begin_validate_at_tenant_scope( + self, + deployment_name: str, + parameters: _models.ScopedDeployment, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeployment + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either DeploymentValidateResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def begin_validate_at_tenant_scope( + self, deployment_name: str, parameters: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either DeploymentValidateResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def begin_validate_at_tenant_scope( + self, deployment_name: str, parameters: Union[_models.ScopedDeployment, IO[bytes]], **kwargs: Any + ) -> LROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Is either a ScopedDeployment type or a IO[bytes] + type. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeployment or IO[bytes] + :return: An instance of LROPoller that returns either DeploymentValidateResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DeploymentValidateResult] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._validate_at_tenant_scope_initial( + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("DeploymentValidateResult", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[_models.DeploymentValidateResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.DeploymentValidateResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + def _what_if_at_tenant_scope_initial( + self, deployment_name: str, parameters: Union[_models.ScopedDeploymentWhatIf, IO[bytes]], **kwargs: Any + ) -> Iterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "ScopedDeploymentWhatIf") + + _request = build_what_if_at_tenant_scope_request( + deployment_name=deployment_name, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 202]: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + response_headers = {} + if response.status_code == 202: + response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) + response_headers["Retry-After"] = self._deserialize("str", response.headers.get("Retry-After")) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + def begin_what_if_at_tenant_scope( + self, + deployment_name: str, + parameters: _models.ScopedDeploymentWhatIf, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the tenant + group. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeploymentWhatIf + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either WhatIfOperationResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def begin_what_if_at_tenant_scope( + self, deployment_name: str, parameters: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the tenant + group. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either WhatIfOperationResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def begin_what_if_at_tenant_scope( + self, deployment_name: str, parameters: Union[_models.ScopedDeploymentWhatIf, IO[bytes]], **kwargs: Any + ) -> LROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the tenant + group. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Is either a ScopedDeploymentWhatIf type or a + IO[bytes] type. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeploymentWhatIf or + IO[bytes] + :return: An instance of LROPoller that returns either WhatIfOperationResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.WhatIfOperationResult] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._what_if_at_tenant_scope_initial( + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("WhatIfOperationResult", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: PollingMethod = cast( + PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "location"}, **kwargs) + ) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[_models.WhatIfOperationResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.WhatIfOperationResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @distributed_trace + def export_template_at_tenant_scope(self, deployment_name: str, **kwargs: Any) -> _models.DeploymentExportResult: + """Exports the template used for specified deployment. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: DeploymentExportResult or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentExportResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentExportResult] = kwargs.pop("cls", None) + + _request = build_export_template_at_tenant_scope_request( + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentExportResult", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_at_tenant_scope( + self, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any + ) -> Iterable["_models.DeploymentExtended"]: + """Get all the deployments at the tenant scope. + + :param filter: The filter to apply on the operation. For example, you can use + $filter=provisioningState eq '{state}'. Default value is None. + :type filter: str + :param top: The number of results to get. If null is passed, returns all deployments. Default + value is None. + :type top: int + :return: An iterator like instance of either DeploymentExtended or the result of cls(response) + :rtype: + ~azure.core.paging.ItemPaged[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentListResult] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_list_at_tenant_scope_request( + filter=filter, + top=top, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request + + def extract_data(pipeline_response): + deserialized = self._deserialize("DeploymentListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + def _delete_at_management_group_scope_initial( # pylint: disable=name-too-long + self, group_id: str, deployment_name: str, **kwargs: Any + ) -> Iterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + + _request = build_delete_at_management_group_scope_request( + group_id=group_id, + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202, 204]: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def begin_delete_at_management_group_scope( + self, group_id: str, deployment_name: str, **kwargs: Any + ) -> LROPoller[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. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: An instance of LROPoller that returns either None or the result of cls(response) + :rtype: ~azure.core.polling.LROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._delete_at_management_group_scope_initial( + group_id=group_id, + deployment_name=deployment_name, + api_version=api_version, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + if polling is True: + polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[None].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore + + @distributed_trace + def check_existence_at_management_group_scope( # pylint: disable=name-too-long + self, group_id: str, deployment_name: str, **kwargs: Any + ) -> bool: + """Checks whether the deployment exists. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: bool or the result of cls(response) + :rtype: bool + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_check_existence_at_management_group_scope_request( + group_id=group_id, + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204, 404]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + return 200 <= response.status_code <= 299 + + def _create_or_update_at_management_group_scope_initial( # pylint: disable=name-too-long + self, group_id: str, deployment_name: str, parameters: Union[_models.ScopedDeployment, IO[bytes]], **kwargs: Any + ) -> Iterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "ScopedDeployment") + + _request = build_create_or_update_at_management_group_scope_request( + group_id=group_id, + deployment_name=deployment_name, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def begin_create_or_update_at_management_group_scope( # pylint: disable=name-too-long + self, + group_id: str, + deployment_name: str, + parameters: _models.ScopedDeployment, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.DeploymentExtended]: + """Deploys resources at management group scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeployment + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def begin_create_or_update_at_management_group_scope( # pylint: disable=name-too-long + self, + group_id: str, + deployment_name: str, + parameters: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.DeploymentExtended]: + """Deploys resources at management group scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def begin_create_or_update_at_management_group_scope( # pylint: disable=name-too-long + self, group_id: str, deployment_name: str, parameters: Union[_models.ScopedDeployment, IO[bytes]], **kwargs: Any + ) -> LROPoller[_models.DeploymentExtended]: + """Deploys resources at management group scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Is either a + ScopedDeployment type or a IO[bytes] type. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeployment or IO[bytes] + :return: An instance of LROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DeploymentExtended] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._create_or_update_at_management_group_scope_initial( + group_id=group_id, + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("DeploymentExtended", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[_models.DeploymentExtended].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.DeploymentExtended]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @distributed_trace + def get_at_management_group_scope( + self, group_id: str, deployment_name: str, **kwargs: Any + ) -> _models.DeploymentExtended: + """Gets a deployment. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: DeploymentExtended or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentExtended + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentExtended] = kwargs.pop("cls", None) + + _request = build_get_at_management_group_scope_request( + group_id=group_id, + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentExtended", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def cancel_at_management_group_scope( # pylint: disable=inconsistent-return-statements + self, group_id: str, deployment_name: str, **kwargs: Any + ) -> 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. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: None or the result of cls(response) + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_cancel_at_management_group_scope_request( + group_id=group_id, + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + def _validate_at_management_group_scope_initial( # pylint: disable=name-too-long + self, group_id: str, deployment_name: str, parameters: Union[_models.ScopedDeployment, IO[bytes]], **kwargs: Any + ) -> Iterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "ScopedDeployment") + + _request = build_validate_at_management_group_scope_request( + group_id=group_id, + deployment_name=deployment_name, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 202, 400]: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def begin_validate_at_management_group_scope( + self, + group_id: str, + deployment_name: str, + parameters: _models.ScopedDeployment, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeployment + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either DeploymentValidateResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def begin_validate_at_management_group_scope( + self, + group_id: str, + deployment_name: str, + parameters: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either DeploymentValidateResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def begin_validate_at_management_group_scope( + self, group_id: str, deployment_name: str, parameters: Union[_models.ScopedDeployment, IO[bytes]], **kwargs: Any + ) -> LROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Is either a ScopedDeployment type or a IO[bytes] + type. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeployment or IO[bytes] + :return: An instance of LROPoller that returns either DeploymentValidateResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DeploymentValidateResult] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._validate_at_management_group_scope_initial( + group_id=group_id, + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("DeploymentValidateResult", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[_models.DeploymentValidateResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.DeploymentValidateResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + def _what_if_at_management_group_scope_initial( # pylint: disable=name-too-long + self, + group_id: str, + deployment_name: str, + parameters: Union[_models.ScopedDeploymentWhatIf, IO[bytes]], + **kwargs: Any + ) -> Iterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "ScopedDeploymentWhatIf") + + _request = build_what_if_at_management_group_scope_request( + group_id=group_id, + deployment_name=deployment_name, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 202]: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + response_headers = {} + if response.status_code == 202: + response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) + response_headers["Retry-After"] = self._deserialize("str", response.headers.get("Retry-After")) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + def begin_what_if_at_management_group_scope( + self, + group_id: str, + deployment_name: str, + parameters: _models.ScopedDeploymentWhatIf, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the management + group. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeploymentWhatIf + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either WhatIfOperationResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def begin_what_if_at_management_group_scope( + self, + group_id: str, + deployment_name: str, + parameters: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the management + group. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either WhatIfOperationResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def begin_what_if_at_management_group_scope( + self, + group_id: str, + deployment_name: str, + parameters: Union[_models.ScopedDeploymentWhatIf, IO[bytes]], + **kwargs: Any + ) -> LROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the management + group. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Is either a ScopedDeploymentWhatIf type or a + IO[bytes] type. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.ScopedDeploymentWhatIf or + IO[bytes] + :return: An instance of LROPoller that returns either WhatIfOperationResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.WhatIfOperationResult] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._what_if_at_management_group_scope_initial( + group_id=group_id, + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("WhatIfOperationResult", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: PollingMethod = cast( + PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "location"}, **kwargs) + ) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[_models.WhatIfOperationResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.WhatIfOperationResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @distributed_trace + def export_template_at_management_group_scope( # pylint: disable=name-too-long + self, group_id: str, deployment_name: str, **kwargs: Any + ) -> _models.DeploymentExportResult: + """Exports the template used for specified deployment. + + :param group_id: The management group ID. Required. + :type group_id: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: DeploymentExportResult or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentExportResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentExportResult] = kwargs.pop("cls", None) + + _request = build_export_template_at_management_group_scope_request( + group_id=group_id, + deployment_name=deployment_name, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentExportResult", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_at_management_group_scope( + self, group_id: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any + ) -> Iterable["_models.DeploymentExtended"]: + """Get all the deployments for a management group. + + :param group_id: The management group ID. Required. + :type group_id: str + :param filter: The filter to apply on the operation. For example, you can use + $filter=provisioningState eq '{state}'. Default value is None. + :type filter: str + :param top: The number of results to get. If null is passed, returns all deployments. Default + value is None. + :type top: int + :return: An iterator like instance of either DeploymentExtended or the result of cls(response) + :rtype: + ~azure.core.paging.ItemPaged[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentListResult] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_list_at_management_group_scope_request( + group_id=group_id, + filter=filter, + top=top, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request + + def extract_data(pipeline_response): + deserialized = self._deserialize("DeploymentListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + def _delete_at_subscription_scope_initial(self, deployment_name: str, **kwargs: Any) -> Iterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + + _request = build_delete_at_subscription_scope_request( + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202, 204]: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def begin_delete_at_subscription_scope(self, deployment_name: str, **kwargs: Any) -> LROPoller[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. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: An instance of LROPoller that returns either None or the result of cls(response) + :rtype: ~azure.core.polling.LROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._delete_at_subscription_scope_initial( + deployment_name=deployment_name, + api_version=api_version, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + if polling is True: + polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[None].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore + + @distributed_trace + def check_existence_at_subscription_scope(self, deployment_name: str, **kwargs: Any) -> bool: + """Checks whether the deployment exists. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: bool or the result of cls(response) + :rtype: bool + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_check_existence_at_subscription_scope_request( + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204, 404]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + return 200 <= response.status_code <= 299 + + def _create_or_update_at_subscription_scope_initial( # pylint: disable=name-too-long + self, deployment_name: str, parameters: Union[_models.Deployment, IO[bytes]], **kwargs: Any + ) -> Iterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "Deployment") + + _request = build_create_or_update_at_subscription_scope_request( + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def begin_create_or_update_at_subscription_scope( # pylint: disable=name-too-long + self, + deployment_name: str, + parameters: _models.Deployment, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.DeploymentExtended]: + """Deploys resources at subscription scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def begin_create_or_update_at_subscription_scope( # pylint: disable=name-too-long + self, deployment_name: str, parameters: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.DeploymentExtended]: + """Deploys resources at subscription scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def begin_create_or_update_at_subscription_scope( # pylint: disable=name-too-long + self, deployment_name: str, parameters: Union[_models.Deployment, IO[bytes]], **kwargs: Any + ) -> LROPoller[_models.DeploymentExtended]: + """Deploys resources at subscription scope. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Is either a Deployment type + or a IO[bytes] type. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment or IO[bytes] + :return: An instance of LROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DeploymentExtended] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._create_or_update_at_subscription_scope_initial( + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("DeploymentExtended", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[_models.DeploymentExtended].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.DeploymentExtended]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @distributed_trace + def get_at_subscription_scope(self, deployment_name: str, **kwargs: Any) -> _models.DeploymentExtended: + """Gets a deployment. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: DeploymentExtended or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentExtended + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentExtended] = kwargs.pop("cls", None) + + _request = build_get_at_subscription_scope_request( + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentExtended", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def cancel_at_subscription_scope( # pylint: disable=inconsistent-return-statements + self, deployment_name: str, **kwargs: Any + ) -> 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. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: None or the result of cls(response) + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_cancel_at_subscription_scope_request( + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + def _validate_at_subscription_scope_initial( + self, deployment_name: str, parameters: Union[_models.Deployment, IO[bytes]], **kwargs: Any + ) -> Iterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "Deployment") + + _request = build_validate_at_subscription_scope_request( + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 202, 400]: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def begin_validate_at_subscription_scope( + self, + deployment_name: str, + parameters: _models.Deployment, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either DeploymentValidateResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def begin_validate_at_subscription_scope( + self, deployment_name: str, parameters: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either DeploymentValidateResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def begin_validate_at_subscription_scope( + self, deployment_name: str, parameters: Union[_models.Deployment, IO[bytes]], **kwargs: Any + ) -> LROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Is either a Deployment type or a IO[bytes] type. + Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment or IO[bytes] + :return: An instance of LROPoller that returns either DeploymentValidateResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DeploymentValidateResult] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._validate_at_subscription_scope_initial( + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("DeploymentValidateResult", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[_models.DeploymentValidateResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.DeploymentValidateResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + def _what_if_at_subscription_scope_initial( + self, deployment_name: str, parameters: Union[_models.DeploymentWhatIf, IO[bytes]], **kwargs: Any + ) -> Iterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "DeploymentWhatIf") + + _request = build_what_if_at_subscription_scope_request( + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 202]: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + response_headers = {} + if response.status_code == 202: + response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) + response_headers["Retry-After"] = self._deserialize("str", response.headers.get("Retry-After")) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + def begin_what_if_at_subscription_scope( + self, + deployment_name: str, + parameters: _models.DeploymentWhatIf, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the + subscription. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to What If. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.DeploymentWhatIf + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either WhatIfOperationResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def begin_what_if_at_subscription_scope( + self, deployment_name: str, parameters: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the + subscription. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to What If. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either WhatIfOperationResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def begin_what_if_at_subscription_scope( + self, deployment_name: str, parameters: Union[_models.DeploymentWhatIf, IO[bytes]], **kwargs: Any + ) -> LROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the + subscription. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to What If. Is either a DeploymentWhatIf type or a IO[bytes] + type. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.DeploymentWhatIf or IO[bytes] + :return: An instance of LROPoller that returns either WhatIfOperationResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.WhatIfOperationResult] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._what_if_at_subscription_scope_initial( + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("WhatIfOperationResult", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: PollingMethod = cast( + PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "location"}, **kwargs) + ) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[_models.WhatIfOperationResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.WhatIfOperationResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @distributed_trace + def export_template_at_subscription_scope( + self, deployment_name: str, **kwargs: Any + ) -> _models.DeploymentExportResult: + """Exports the template used for specified deployment. + + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: DeploymentExportResult or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentExportResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentExportResult] = kwargs.pop("cls", None) + + _request = build_export_template_at_subscription_scope_request( + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentExportResult", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_at_subscription_scope( + self, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any + ) -> Iterable["_models.DeploymentExtended"]: + """Get all the deployments for a subscription. + + :param filter: The filter to apply on the operation. For example, you can use + $filter=provisioningState eq '{state}'. Default value is None. + :type filter: str + :param top: The number of results to get. If null is passed, returns all deployments. Default + value is None. + :type top: int + :return: An iterator like instance of either DeploymentExtended or the result of cls(response) + :rtype: + ~azure.core.paging.ItemPaged[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentListResult] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_list_at_subscription_scope_request( + subscription_id=self._config.subscription_id, + filter=filter, + top=top, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request + + def extract_data(pipeline_response): + deserialized = self._deserialize("DeploymentListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + def _delete_initial(self, resource_group_name: str, deployment_name: str, **kwargs: Any) -> Iterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + + _request = build_delete_request( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202, 204]: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def begin_delete(self, resource_group_name: str, deployment_name: str, **kwargs: Any) -> LROPoller[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. + + :param resource_group_name: The name of the resource group with the deployment to delete. The + name is case insensitive. Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: An instance of LROPoller that returns either None or the result of cls(response) + :rtype: ~azure.core.polling.LROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._delete_initial( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + api_version=api_version, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + if polling is True: + polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[None].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore + + @distributed_trace + def check_existence(self, resource_group_name: str, deployment_name: str, **kwargs: Any) -> bool: + """Checks whether the deployment exists. + + :param resource_group_name: The name of the resource group with the deployment to check. The + name is case insensitive. Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: bool or the result of cls(response) + :rtype: bool + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_check_existence_request( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204, 404]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + return 200 <= response.status_code <= 299 + + def _create_or_update_initial( + self, + resource_group_name: str, + deployment_name: str, + parameters: Union[_models.Deployment, IO[bytes]], + **kwargs: Any + ) -> Iterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "Deployment") + + _request = build_create_or_update_request( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def begin_create_or_update( + self, + resource_group_name: str, + deployment_name: str, + parameters: _models.Deployment, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.DeploymentExtended]: + """Deploys resources to a resource group. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param resource_group_name: The name of the resource group to deploy the resources to. The name + is case insensitive. The resource group must already exist. Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def begin_create_or_update( + self, + resource_group_name: str, + deployment_name: str, + parameters: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.DeploymentExtended]: + """Deploys resources to a resource group. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param resource_group_name: The name of the resource group to deploy the resources to. The name + is case insensitive. The resource group must already exist. Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def begin_create_or_update( + self, + resource_group_name: str, + deployment_name: str, + parameters: Union[_models.Deployment, IO[bytes]], + **kwargs: Any + ) -> LROPoller[_models.DeploymentExtended]: + """Deploys resources to a resource group. + + You can provide the template and parameters directly in the request or link to JSON files. + + :param resource_group_name: The name of the resource group to deploy the resources to. The name + is case insensitive. The resource group must already exist. Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Additional parameters supplied to the operation. Is either a Deployment type + or a IO[bytes] type. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment or IO[bytes] + :return: An instance of LROPoller that returns either DeploymentExtended or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DeploymentExtended] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._create_or_update_initial( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("DeploymentExtended", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[_models.DeploymentExtended].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.DeploymentExtended]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @distributed_trace + def get(self, resource_group_name: str, deployment_name: str, **kwargs: Any) -> _models.DeploymentExtended: + """Gets a deployment. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: DeploymentExtended or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentExtended + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentExtended] = kwargs.pop("cls", None) + + _request = build_get_request( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentExtended", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def cancel( # pylint: disable=inconsistent-return-statements + self, resource_group_name: str, deployment_name: str, **kwargs: Any + ) -> 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. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: None or the result of cls(response) + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_cancel_request( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + def _validate_initial( + self, + resource_group_name: str, + deployment_name: str, + parameters: Union[_models.Deployment, IO[bytes]], + **kwargs: Any + ) -> Iterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "Deployment") + + _request = build_validate_request( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 202, 400]: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def begin_validate( + self, + resource_group_name: str, + deployment_name: str, + parameters: _models.Deployment, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param resource_group_name: The name of the resource group the template will be deployed to. + The name is case insensitive. Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either DeploymentValidateResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def begin_validate( + self, + resource_group_name: str, + deployment_name: str, + parameters: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param resource_group_name: The name of the resource group the template will be deployed to. + The name is case insensitive. Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either DeploymentValidateResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def begin_validate( + self, + resource_group_name: str, + deployment_name: str, + parameters: Union[_models.Deployment, IO[bytes]], + **kwargs: Any + ) -> LROPoller[_models.DeploymentValidateResult]: + """Validates whether the specified template is syntactically correct and will be accepted by Azure + Resource Manager.. + + :param resource_group_name: The name of the resource group the template will be deployed to. + The name is case insensitive. Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Is either a Deployment type or a IO[bytes] type. + Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.Deployment or IO[bytes] + :return: An instance of LROPoller that returns either DeploymentValidateResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.DeploymentValidateResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DeploymentValidateResult] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._validate_initial( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("DeploymentValidateResult", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs)) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[_models.DeploymentValidateResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.DeploymentValidateResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + def _what_if_initial( + self, + resource_group_name: str, + deployment_name: str, + parameters: Union[_models.DeploymentWhatIf, IO[bytes]], + **kwargs: Any + ) -> Iterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(parameters, (IOBase, bytes)): + _content = parameters + else: + _json = self._serialize.body(parameters, "DeploymentWhatIf") + + _request = build_what_if_request( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + content_type=content_type, + json=_json, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 202]: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + response_headers = {} + if response.status_code == 202: + response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) + response_headers["Retry-After"] = self._deserialize("str", response.headers.get("Retry-After")) + + deserialized = response.stream_download(self._client._pipeline, decompress=_decompress) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + def begin_what_if( + self, + resource_group_name: str, + deployment_name: str, + parameters: _models.DeploymentWhatIf, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the resource + group. + + :param resource_group_name: The name of the resource group the template will be deployed to. + The name is case insensitive. Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.DeploymentWhatIf + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either WhatIfOperationResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def begin_what_if( + self, + resource_group_name: str, + deployment_name: str, + parameters: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the resource + group. + + :param resource_group_name: The name of the resource group the template will be deployed to. + The name is case insensitive. Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Required. + :type parameters: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns either WhatIfOperationResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def begin_what_if( + self, + resource_group_name: str, + deployment_name: str, + parameters: Union[_models.DeploymentWhatIf, IO[bytes]], + **kwargs: Any + ) -> LROPoller[_models.WhatIfOperationResult]: + """Returns changes that will be made by the deployment if executed at the scope of the resource + group. + + :param resource_group_name: The name of the resource group the template will be deployed to. + The name is case insensitive. Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :param parameters: Parameters to validate. Is either a DeploymentWhatIf type or a IO[bytes] + type. Required. + :type parameters: ~azure.mgmt.deployments.deployments.models.DeploymentWhatIf or IO[bytes] + :return: An instance of LROPoller that returns either WhatIfOperationResult or the result of + cls(response) + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.deployments.deployments.models.WhatIfOperationResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.WhatIfOperationResult] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._what_if_initial( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + parameters=parameters, + api_version=api_version, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + deserialized = self._deserialize("WhatIfOperationResult", pipeline_response.http_response) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized + + if polling is True: + polling_method: PollingMethod = cast( + PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "location"}, **kwargs) + ) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[_models.WhatIfOperationResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.WhatIfOperationResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @distributed_trace + def export_template( + self, resource_group_name: str, deployment_name: str, **kwargs: Any + ) -> _models.DeploymentExportResult: + """Exports the template used for specified deployment. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param deployment_name: The name of the deployment. Required. + :type deployment_name: str + :return: DeploymentExportResult or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.DeploymentExportResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentExportResult] = kwargs.pop("cls", None) + + _request = build_export_template_request( + resource_group_name=resource_group_name, + deployment_name=deployment_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("DeploymentExportResult", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_by_resource_group( + self, resource_group_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any + ) -> Iterable["_models.DeploymentExtended"]: + """Get all the deployments for a resource group. + + :param resource_group_name: The name of the resource group with the deployments to get. The + name is case insensitive. Required. + :type resource_group_name: str + :param filter: The filter to apply on the operation. For example, you can use + $filter=provisioningState eq '{state}'. Default value is None. + :type filter: str + :param top: The number of results to get. If null is passed, returns all deployments. Default + value is None. + :type top: int + :return: An iterator like instance of either DeploymentExtended or the result of cls(response) + :rtype: + ~azure.core.paging.ItemPaged[~azure.mgmt.deployments.deployments.models.DeploymentExtended] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DeploymentListResult] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_list_by_resource_group_request( + resource_group_name=resource_group_name, + subscription_id=self._config.subscription_id, + filter=filter, + top=top, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request + + def extract_data(pipeline_response): + deserialized = self._deserialize("DeploymentListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + @distributed_trace + def calculate_template_hash(self, template: JSON, **kwargs: Any) -> _models.TemplateHashResult: + """Calculate the hash of the given template. + + :param template: The template provided to calculate hash. Required. + :type template: JSON + :return: TemplateHashResult or the result of cls(response) + :rtype: ~azure.mgmt.deployments.deployments.models.TemplateHashResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: str = kwargs.pop("content_type", _headers.pop("Content-Type", "application/json")) + cls: ClsType[_models.TemplateHashResult] = kwargs.pop("cls", None) + + _json = self._serialize.body(template, "object") + + _request = build_calculate_template_hash_request( + api_version=api_version, + content_type=content_type, + json=_json, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response, error_format=ARMErrorFormat) + + deserialized = self._deserialize("TemplateHashResult", pipeline_response.http_response) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/operations/_patch.py b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/operations/_patch.py new file mode 100644 index 000000000000..8bcb627aa475 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/operations/_patch.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/py.typed b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/py.typed new file mode 100644 index 000000000000..e5aff4f83af8 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/azure/mgmt/deployments/deployments/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/dev_requirements.txt b/sdk/deployments/azure-mgmt-deployments-deployments/dev_requirements.txt new file mode 100644 index 000000000000..dab09d85bafa --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/dev_requirements.txt @@ -0,0 +1,2 @@ +-e ../../../tools/azure-sdk-tools +../../identity/azure-identity diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/calculate_template_hash.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/calculate_template_hash.py new file mode 100644 index 000000000000..8ffe1eefde77 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/calculate_template_hash.py @@ -0,0 +1,55 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.mgmt.deployments.deployments import DeploymentsClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-mgmt-deployments-deployments +# USAGE + python calculate_template_hash.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = DeploymentsClient( + credential=DefaultAzureCredential(), + subscription_id="SUBSCRIPTION_ID", + ) + + response = client.deployments.calculate_template_hash( + template={ + "$schema": "http://schemas.management.azure.com/deploymentTemplate?api-version=2014-04-01-preview", + "contentVersion": "1.0.0.0", + "outputs": {"string": {"type": "string", "value": "myvalue"}}, + "parameters": {"string": {"type": "string"}}, + "resources": [], + "variables": { + "array": [1, 2, 3, 4], + "bool": True, + "int": 42, + "object": {"object": {"location": "West US", "vmSize": "Large"}}, + "string": "string", + }, + }, + ) + print(response) + + +# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/CalculateTemplateHash.json +if __name__ == "__main__": + main() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_validate_on_management_group.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_validate_on_management_group.py new file mode 100644 index 000000000000..264011f06807 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_validate_on_management_group.py @@ -0,0 +1,51 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.mgmt.deployments.deployments import DeploymentsClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-mgmt-deployments-deployments +# USAGE + python post_deployment_validate_on_management_group.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = DeploymentsClient( + credential=DefaultAzureCredential(), + subscription_id="SUBSCRIPTION_ID", + ) + + response = client.deployments.begin_validate_at_management_group_scope( + group_id="my-management-group-id", + deployment_name="my-deployment", + parameters={ + "location": "eastus", + "properties": { + "mode": "Incremental", + "parameters": {}, + "templateLink": {"uri": "https://example.com/exampleTemplate.json"}, + }, + }, + ).result() + print(response) + + +# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PostDeploymentValidateOnManagementGroup.json +if __name__ == "__main__": + main() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_validate_on_resource_group.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_validate_on_resource_group.py new file mode 100644 index 000000000000..cb24082e86c4 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_validate_on_resource_group.py @@ -0,0 +1,53 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.mgmt.deployments.deployments import DeploymentsClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-mgmt-deployments-deployments +# USAGE + python post_deployment_validate_on_resource_group.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = DeploymentsClient( + credential=DefaultAzureCredential(), + subscription_id="00000000-0000-0000-0000-000000000001", + ) + + response = client.deployments.begin_validate( + resource_group_name="my-resource-group", + deployment_name="my-deployment", + parameters={ + "properties": { + "mode": "Incremental", + "parameters": {}, + "templateLink": { + "queryString": "sv=2019-02-02&st=2019-04-29T22%3A18%3A26Z&se=2019-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=xxxxxxxx0xxxxxxxxxxxxx%2bxxxxxxxxxxxxxxxxxxxx%3d", + "uri": "https://example.com/exampleTemplate.json", + }, + } + }, + ).result() + print(response) + + +# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PostDeploymentValidateOnResourceGroup.json +if __name__ == "__main__": + main() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_validate_on_scope.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_validate_on_scope.py new file mode 100644 index 000000000000..1c8acafb7d1a --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_validate_on_scope.py @@ -0,0 +1,53 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.mgmt.deployments.deployments import DeploymentsClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-mgmt-deployments-deployments +# USAGE + python post_deployment_validate_on_scope.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = DeploymentsClient( + credential=DefaultAzureCredential(), + subscription_id="SUBSCRIPTION_ID", + ) + + response = client.deployments.begin_validate_at_scope( + scope="subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group", + deployment_name="my-deployment", + parameters={ + "properties": { + "mode": "Incremental", + "parameters": {}, + "templateLink": { + "queryString": "sv=2019-02-02&st=2019-04-29T22%3A18%3A26Z&se=2019-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=xxxxxxxx0xxxxxxxxxxxxx%2bxxxxxxxxxxxxxxxxxxxx%3d", + "uri": "https://example.com/exampleTemplate.json", + }, + } + }, + ).result() + print(response) + + +# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PostDeploymentValidateOnScope.json +if __name__ == "__main__": + main() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_validate_on_subscription.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_validate_on_subscription.py new file mode 100644 index 000000000000..b74a45075444 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_validate_on_subscription.py @@ -0,0 +1,50 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.mgmt.deployments.deployments import DeploymentsClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-mgmt-deployments-deployments +# USAGE + python post_deployment_validate_on_subscription.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = DeploymentsClient( + credential=DefaultAzureCredential(), + subscription_id="00000000-0000-0000-0000-000000000001", + ) + + response = client.deployments.begin_validate_at_subscription_scope( + deployment_name="my-deployment", + parameters={ + "location": "eastus", + "properties": { + "mode": "Incremental", + "parameters": {}, + "templateLink": {"uri": "https://example.com/exampleTemplate.json"}, + }, + }, + ).result() + print(response) + + +# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PostDeploymentValidateOnSubscription.json +if __name__ == "__main__": + main() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_validate_on_tenant.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_validate_on_tenant.py new file mode 100644 index 000000000000..c692d994a4a4 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_validate_on_tenant.py @@ -0,0 +1,50 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.mgmt.deployments.deployments import DeploymentsClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-mgmt-deployments-deployments +# USAGE + python post_deployment_validate_on_tenant.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = DeploymentsClient( + credential=DefaultAzureCredential(), + subscription_id="SUBSCRIPTION_ID", + ) + + response = client.deployments.begin_validate_at_tenant_scope( + deployment_name="my-deployment", + parameters={ + "location": "eastus", + "properties": { + "mode": "Incremental", + "parameters": {}, + "templateLink": {"uri": "https://example.com/exampleTemplate.json"}, + }, + }, + ).result() + print(response) + + +# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PostDeploymentValidateOnTenant.json +if __name__ == "__main__": + main() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_what_if_on_management_group.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_what_if_on_management_group.py new file mode 100644 index 000000000000..3339893db085 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_what_if_on_management_group.py @@ -0,0 +1,51 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.mgmt.deployments.deployments import DeploymentsClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-mgmt-deployments-deployments +# USAGE + python post_deployment_what_if_on_management_group.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = DeploymentsClient( + credential=DefaultAzureCredential(), + subscription_id="SUBSCRIPTION_ID", + ) + + response = client.deployments.begin_what_if_at_management_group_scope( + group_id="myManagementGruop", + deployment_name="exampleDeploymentName", + parameters={ + "location": "eastus", + "properties": { + "mode": "Incremental", + "parameters": {}, + "templateLink": {"uri": "https://example.com/exampleTemplate.json"}, + }, + }, + ).result() + print(response) + + +# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PostDeploymentWhatIfOnManagementGroup.json +if __name__ == "__main__": + main() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_what_if_on_resource_group.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_what_if_on_resource_group.py new file mode 100644 index 000000000000..3910f69bdb55 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_what_if_on_resource_group.py @@ -0,0 +1,50 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.mgmt.deployments.deployments import DeploymentsClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-mgmt-deployments-deployments +# USAGE + python post_deployment_what_if_on_resource_group.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = DeploymentsClient( + credential=DefaultAzureCredential(), + subscription_id="00000000-0000-0000-0000-000000000001", + ) + + response = client.deployments.begin_what_if( + resource_group_name="my-resource-group", + deployment_name="my-deployment", + parameters={ + "properties": { + "mode": "Incremental", + "parameters": {}, + "templateLink": {"uri": "https://example.com/exampleTemplate.json"}, + } + }, + ).result() + print(response) + + +# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PostDeploymentWhatIfOnResourceGroup.json +if __name__ == "__main__": + main() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_what_if_on_subscription.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_what_if_on_subscription.py new file mode 100644 index 000000000000..66375895b7a3 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_what_if_on_subscription.py @@ -0,0 +1,50 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.mgmt.deployments.deployments import DeploymentsClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-mgmt-deployments-deployments +# USAGE + python post_deployment_what_if_on_subscription.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = DeploymentsClient( + credential=DefaultAzureCredential(), + subscription_id="00000000-0000-0000-0000-000000000001", + ) + + response = client.deployments.begin_what_if_at_subscription_scope( + deployment_name="my-deployment", + parameters={ + "location": "westus", + "properties": { + "mode": "Incremental", + "parameters": {}, + "templateLink": {"uri": "https://example.com/exampleTemplate.json"}, + }, + }, + ).result() + print(response) + + +# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PostDeploymentWhatIfOnSubscription.json +if __name__ == "__main__": + main() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_what_if_on_tenant.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_what_if_on_tenant.py new file mode 100644 index 000000000000..34f131dfc696 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/post_deployment_what_if_on_tenant.py @@ -0,0 +1,50 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.mgmt.deployments.deployments import DeploymentsClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-mgmt-deployments-deployments +# USAGE + python post_deployment_what_if_on_tenant.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = DeploymentsClient( + credential=DefaultAzureCredential(), + subscription_id="SUBSCRIPTION_ID", + ) + + response = client.deployments.begin_what_if_at_tenant_scope( + deployment_name="exampleDeploymentName", + parameters={ + "location": "eastus", + "properties": { + "mode": "Incremental", + "parameters": {}, + "templateLink": {"uri": "https://example.com/exampleTemplate.json"}, + }, + }, + ).result() + print(response) + + +# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PostDeploymentWhatIfOnTenant.json +if __name__ == "__main__": + main() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_at_management_group.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_at_management_group.py new file mode 100644 index 000000000000..fbe47ab7fa8f --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_at_management_group.py @@ -0,0 +1,51 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.mgmt.deployments.deployments import DeploymentsClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-mgmt-deployments-deployments +# USAGE + python put_deployment_at_management_group.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = DeploymentsClient( + credential=DefaultAzureCredential(), + subscription_id="SUBSCRIPTION_ID", + ) + + response = client.deployments.begin_create_or_update_at_management_group_scope( + group_id="my-management-group-id", + deployment_name="my-deployment", + parameters={ + "location": "eastus", + "properties": { + "mode": "Incremental", + "parameters": {}, + "templateLink": {"uri": "https://example.com/exampleTemplate.json"}, + }, + }, + ).result() + print(response) + + +# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentAtManagementGroup.json +if __name__ == "__main__": + main() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_at_scope.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_at_scope.py new file mode 100644 index 000000000000..46d9ccc038c6 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_at_scope.py @@ -0,0 +1,52 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.mgmt.deployments.deployments import DeploymentsClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-mgmt-deployments-deployments +# USAGE + python put_deployment_at_scope.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = DeploymentsClient( + credential=DefaultAzureCredential(), + subscription_id="SUBSCRIPTION_ID", + ) + + response = client.deployments.begin_create_or_update_at_scope( + scope="providers/Microsoft.Management/managementGroups/my-management-group-id", + deployment_name="my-deployment", + parameters={ + "location": "eastus", + "properties": { + "mode": "Incremental", + "parameters": {}, + "templateLink": {"uri": "https://example.com/exampleTemplate.json"}, + }, + "tags": {"tagKey1": "tag-value-1", "tagKey2": "tag-value-2"}, + }, + ).result() + print(response) + + +# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentAtScope.json +if __name__ == "__main__": + main() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_at_tenant.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_at_tenant.py new file mode 100644 index 000000000000..58e441d544b1 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_at_tenant.py @@ -0,0 +1,51 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.mgmt.deployments.deployments import DeploymentsClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-mgmt-deployments-deployments +# USAGE + python put_deployment_at_tenant.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = DeploymentsClient( + credential=DefaultAzureCredential(), + subscription_id="SUBSCRIPTION_ID", + ) + + response = client.deployments.begin_create_or_update_at_tenant_scope( + deployment_name="tenant-dep01", + parameters={ + "location": "eastus", + "properties": { + "mode": "Incremental", + "parameters": {}, + "templateLink": {"uri": "https://example.com/exampleTemplate.json"}, + }, + "tags": {"tagKey1": "tag-value-1", "tagKey2": "tag-value-2"}, + }, + ).result() + print(response) + + +# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentAtTenant.json +if __name__ == "__main__": + main() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_resource_group.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_resource_group.py new file mode 100644 index 000000000000..ad8613f62dcd --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_resource_group.py @@ -0,0 +1,53 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.mgmt.deployments.deployments import DeploymentsClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-mgmt-deployments-deployments +# USAGE + python put_deployment_resource_group.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = DeploymentsClient( + credential=DefaultAzureCredential(), + subscription_id="00000000-0000-0000-0000-000000000001", + ) + + response = client.deployments.begin_create_or_update( + resource_group_name="my-resource-group", + deployment_name="my-deployment", + parameters={ + "properties": { + "mode": "Incremental", + "parameters": {}, + "templateLink": { + "queryString": "sv=2019-02-02&st=2019-04-29T22%3A18%3A26Z&se=2019-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=xxxxxxxx0xxxxxxxxxxxxx%2bxxxxxxxxxxxxxxxxxxxx%3d", + "uri": "https://example.com/exampleTemplate.json", + }, + } + }, + ).result() + print(response) + + +# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentResourceGroup.json +if __name__ == "__main__": + main() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_resource_group_template_specs_with_id.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_resource_group_template_specs_with_id.py new file mode 100644 index 000000000000..242ccc9b695c --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_resource_group_template_specs_with_id.py @@ -0,0 +1,52 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.mgmt.deployments.deployments import DeploymentsClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-mgmt-deployments-deployments +# USAGE + python put_deployment_resource_group_template_specs_with_id.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = DeploymentsClient( + credential=DefaultAzureCredential(), + subscription_id="00000000-0000-0000-0000-000000000001", + ) + + response = client.deployments.begin_create_or_update( + resource_group_name="my-resource-group", + deployment_name="my-deployment", + parameters={ + "properties": { + "mode": "Incremental", + "parameters": {}, + "templateLink": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1" + }, + } + }, + ).result() + print(response) + + +# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json +if __name__ == "__main__": + main() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_subscription_template_specs_with_id.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_subscription_template_specs_with_id.py new file mode 100644 index 000000000000..cd3e7a0a2f25 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_subscription_template_specs_with_id.py @@ -0,0 +1,52 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.mgmt.deployments.deployments import DeploymentsClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-mgmt-deployments-deployments +# USAGE + python put_deployment_subscription_template_specs_with_id.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = DeploymentsClient( + credential=DefaultAzureCredential(), + subscription_id="00000000-0000-0000-0000-000000000001", + ) + + response = client.deployments.begin_create_or_update_at_subscription_scope( + deployment_name="my-deployment", + parameters={ + "location": "eastus", + "properties": { + "mode": "Incremental", + "parameters": {}, + "templateLink": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1" + }, + }, + }, + ).result() + print(response) + + +# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json +if __name__ == "__main__": + main() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_with_external_inputs.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_with_external_inputs.py new file mode 100644 index 000000000000..088392ee5bf5 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_with_external_inputs.py @@ -0,0 +1,58 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.mgmt.deployments.deployments import DeploymentsClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-mgmt-deployments-deployments +# USAGE + python put_deployment_with_external_inputs.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = DeploymentsClient( + credential=DefaultAzureCredential(), + subscription_id="00000000-0000-0000-0000-000000000001", + ) + + response = client.deployments.begin_create_or_update( + resource_group_name="my-resource-group", + deployment_name="my-deployment", + parameters={ + "properties": { + "externalInputDefinitions": {"fooValue": {"config": "FOO_VALUE", "kind": "sys.envVar"}}, + "externalInputs": {"fooValue": {"value": "baz"}}, + "mode": "Incremental", + "parameters": {"inputObj": {"expression": "[createObject('foo', externalInputs('fooValue'))]"}}, + "template": { + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#", + "contentVersion": "1.0.0.0", + "outputs": {"inputObj": {"type": "object", "value": "[parameters('inputObj')]"}}, + "parameters": {"inputObj": {"type": "object"}}, + "resources": [], + }, + } + }, + ).result() + print(response) + + +# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentWithExternalInputs.json +if __name__ == "__main__": + main() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_with_on_error_deployment_last_successful.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_with_on_error_deployment_last_successful.py new file mode 100644 index 000000000000..00477c57da55 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_with_on_error_deployment_last_successful.py @@ -0,0 +1,51 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.mgmt.deployments.deployments import DeploymentsClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-mgmt-deployments-deployments +# USAGE + python put_deployment_with_on_error_deployment_last_successful.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = DeploymentsClient( + credential=DefaultAzureCredential(), + subscription_id="00000000-0000-0000-0000-000000000000", + ) + + response = client.deployments.begin_create_or_update( + resource_group_name="my-resource-group", + deployment_name="my-deployment", + parameters={ + "properties": { + "mode": "Complete", + "onErrorDeployment": {"type": "LastSuccessful"}, + "parameters": {}, + "templateLink": {"uri": "https://example.com/exampleTemplate.json"}, + } + }, + ).result() + print(response) + + +# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json +if __name__ == "__main__": + main() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_with_on_error_deployment_specific_deployment.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_with_on_error_deployment_specific_deployment.py new file mode 100644 index 000000000000..e8d71a784b22 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_samples/put_deployment_with_on_error_deployment_specific_deployment.py @@ -0,0 +1,51 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.mgmt.deployments.deployments import DeploymentsClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-mgmt-deployments-deployments +# USAGE + python put_deployment_with_on_error_deployment_specific_deployment.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = DeploymentsClient( + credential=DefaultAzureCredential(), + subscription_id="00000000-0000-0000-0000-000000000000", + ) + + response = client.deployments.begin_create_or_update( + resource_group_name="my-resource-group", + deployment_name="my-deployment", + parameters={ + "properties": { + "mode": "Complete", + "onErrorDeployment": {"deploymentName": "name-of-deployment-to-use", "type": "SpecificDeployment"}, + "parameters": {}, + "templateLink": {"uri": "https://example.com/exampleTemplate.json"}, + } + }, + ).result() + print(response) + + +# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json +if __name__ == "__main__": + main() diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_tests/conftest.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_tests/conftest.py new file mode 100644 index 000000000000..5d55d4b63591 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_tests/conftest.py @@ -0,0 +1,35 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import os +import pytest +from dotenv import load_dotenv +from devtools_testutils import ( + test_proxy, + add_general_regex_sanitizer, + add_body_key_sanitizer, + add_header_regex_sanitizer, +) + +load_dotenv() + + +# For security, please avoid record sensitive identity information in recordings +@pytest.fixture(scope="session", autouse=True) +def add_sanitizers(test_proxy): + deployments_subscription_id = os.environ.get("AZURE_SUBSCRIPTION_ID", "00000000-0000-0000-0000-000000000000") + deployments_tenant_id = os.environ.get("AZURE_TENANT_ID", "00000000-0000-0000-0000-000000000000") + deployments_client_id = os.environ.get("AZURE_CLIENT_ID", "00000000-0000-0000-0000-000000000000") + deployments_client_secret = os.environ.get("AZURE_CLIENT_SECRET", "00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=deployments_subscription_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=deployments_tenant_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=deployments_client_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=deployments_client_secret, value="00000000-0000-0000-0000-000000000000") + + add_header_regex_sanitizer(key="Set-Cookie", value="[set-cookie;]") + add_header_regex_sanitizer(key="Cookie", value="cookie;") + add_body_key_sanitizer(json_path="$..access_token", value="access_token") diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_tests/test_deployments_deployment_operations_operations.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_tests/test_deployments_deployment_operations_operations.py new file mode 100644 index 000000000000..81afa203deb1 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_tests/test_deployments_deployment_operations_operations.py @@ -0,0 +1,140 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from azure.mgmt.deployments.deployments import DeploymentsClient + +from devtools_testutils import AzureMgmtRecordedTestCase, RandomNameResourceGroupPreparer, recorded_by_proxy + +AZURE_LOCATION = "eastus" + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestDeploymentsDeploymentOperationsOperations(AzureMgmtRecordedTestCase): + def setup_method(self, method): + self.client = self.create_mgmt_client(DeploymentsClient) + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployment_operations_get_at_scope(self, resource_group): + response = self.client.deployment_operations.get_at_scope( + scope="str", + deployment_name="str", + operation_id="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployment_operations_list_at_scope(self, resource_group): + response = self.client.deployment_operations.list_at_scope( + scope="str", + deployment_name="str", + api_version="2025-04-01", + ) + result = [r for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployment_operations_get_at_tenant_scope(self, resource_group): + response = self.client.deployment_operations.get_at_tenant_scope( + deployment_name="str", + operation_id="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployment_operations_list_at_tenant_scope(self, resource_group): + response = self.client.deployment_operations.list_at_tenant_scope( + deployment_name="str", + api_version="2025-04-01", + ) + result = [r for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployment_operations_get_at_management_group_scope(self, resource_group): + response = self.client.deployment_operations.get_at_management_group_scope( + group_id="str", + deployment_name="str", + operation_id="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployment_operations_list_at_management_group_scope(self, resource_group): + response = self.client.deployment_operations.list_at_management_group_scope( + group_id="str", + deployment_name="str", + api_version="2025-04-01", + ) + result = [r for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployment_operations_get_at_subscription_scope(self, resource_group): + response = self.client.deployment_operations.get_at_subscription_scope( + deployment_name="str", + operation_id="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployment_operations_list_at_subscription_scope(self, resource_group): + response = self.client.deployment_operations.list_at_subscription_scope( + deployment_name="str", + api_version="2025-04-01", + ) + result = [r for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployment_operations_get(self, resource_group): + response = self.client.deployment_operations.get( + resource_group_name=resource_group.name, + deployment_name="str", + operation_id="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployment_operations_list(self, resource_group): + response = self.client.deployment_operations.list( + resource_group_name=resource_group.name, + deployment_name="str", + api_version="2025-04-01", + ) + result = [r for r in response] + # please add some check logic here by yourself + # ... diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_tests/test_deployments_deployment_operations_operations_async.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_tests/test_deployments_deployment_operations_operations_async.py new file mode 100644 index 000000000000..f150ccc5b4fd --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_tests/test_deployments_deployment_operations_operations_async.py @@ -0,0 +1,141 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from azure.mgmt.deployments.deployments.aio import DeploymentsClient + +from devtools_testutils import AzureMgmtRecordedTestCase, RandomNameResourceGroupPreparer +from devtools_testutils.aio import recorded_by_proxy_async + +AZURE_LOCATION = "eastus" + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestDeploymentsDeploymentOperationsOperationsAsync(AzureMgmtRecordedTestCase): + def setup_method(self, method): + self.client = self.create_mgmt_client(DeploymentsClient, is_async=True) + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployment_operations_get_at_scope(self, resource_group): + response = await self.client.deployment_operations.get_at_scope( + scope="str", + deployment_name="str", + operation_id="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployment_operations_list_at_scope(self, resource_group): + response = self.client.deployment_operations.list_at_scope( + scope="str", + deployment_name="str", + api_version="2025-04-01", + ) + result = [r async for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployment_operations_get_at_tenant_scope(self, resource_group): + response = await self.client.deployment_operations.get_at_tenant_scope( + deployment_name="str", + operation_id="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployment_operations_list_at_tenant_scope(self, resource_group): + response = self.client.deployment_operations.list_at_tenant_scope( + deployment_name="str", + api_version="2025-04-01", + ) + result = [r async for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployment_operations_get_at_management_group_scope(self, resource_group): + response = await self.client.deployment_operations.get_at_management_group_scope( + group_id="str", + deployment_name="str", + operation_id="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployment_operations_list_at_management_group_scope(self, resource_group): + response = self.client.deployment_operations.list_at_management_group_scope( + group_id="str", + deployment_name="str", + api_version="2025-04-01", + ) + result = [r async for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployment_operations_get_at_subscription_scope(self, resource_group): + response = await self.client.deployment_operations.get_at_subscription_scope( + deployment_name="str", + operation_id="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployment_operations_list_at_subscription_scope(self, resource_group): + response = self.client.deployment_operations.list_at_subscription_scope( + deployment_name="str", + api_version="2025-04-01", + ) + result = [r async for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployment_operations_get(self, resource_group): + response = await self.client.deployment_operations.get( + resource_group_name=resource_group.name, + deployment_name="str", + operation_id="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployment_operations_list(self, resource_group): + response = self.client.deployment_operations.list( + resource_group_name=resource_group.name, + deployment_name="str", + api_version="2025-04-01", + ) + result = [r async for r in response] + # please add some check logic here by yourself + # ... diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_tests/test_deployments_deployments_operations.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_tests/test_deployments_deployments_operations.py new file mode 100644 index 000000000000..aaf47614ce69 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_tests/test_deployments_deployments_operations.py @@ -0,0 +1,1148 @@ +# pylint: disable=too-many-lines +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from azure.mgmt.deployments.deployments import DeploymentsClient + +from devtools_testutils import AzureMgmtRecordedTestCase, RandomNameResourceGroupPreparer, recorded_by_proxy + +AZURE_LOCATION = "eastus" + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestDeploymentsDeploymentsOperations(AzureMgmtRecordedTestCase): + def setup_method(self, method): + self.client = self.create_mgmt_client(DeploymentsClient) + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_begin_delete_at_scope(self, resource_group): + response = self.client.deployments.begin_delete_at_scope( + scope="str", + deployment_name="str", + api_version="2025-04-01", + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_check_existence_at_scope(self, resource_group): + response = self.client.deployments.check_existence_at_scope( + scope="str", + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_begin_create_or_update_at_scope(self, resource_group): + response = self.client.deployments.begin_create_or_update_at_scope( + scope="str", + deployment_name="str", + parameters={ + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + }, + "identity": { + "type": "str", + "userAssignedIdentities": {"str": {"clientId": "str", "principalId": "str"}}, + }, + "location": "str", + "tags": {"str": "str"}, + }, + api_version="2025-04-01", + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_get_at_scope(self, resource_group): + response = self.client.deployments.get_at_scope( + scope="str", + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_cancel_at_scope(self, resource_group): + response = self.client.deployments.cancel_at_scope( + scope="str", + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_begin_validate_at_scope(self, resource_group): + response = self.client.deployments.begin_validate_at_scope( + scope="str", + deployment_name="str", + parameters={ + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + }, + "identity": { + "type": "str", + "userAssignedIdentities": {"str": {"clientId": "str", "principalId": "str"}}, + }, + "location": "str", + "tags": {"str": "str"}, + }, + api_version="2025-04-01", + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_export_template_at_scope(self, resource_group): + response = self.client.deployments.export_template_at_scope( + scope="str", + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_list_at_scope(self, resource_group): + response = self.client.deployments.list_at_scope( + scope="str", + api_version="2025-04-01", + ) + result = [r for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_begin_delete_at_tenant_scope(self, resource_group): + response = self.client.deployments.begin_delete_at_tenant_scope( + deployment_name="str", + api_version="2025-04-01", + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_check_existence_at_tenant_scope(self, resource_group): + response = self.client.deployments.check_existence_at_tenant_scope( + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_begin_create_or_update_at_tenant_scope(self, resource_group): + response = self.client.deployments.begin_create_or_update_at_tenant_scope( + deployment_name="str", + parameters={ + "location": "str", + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + }, + "tags": {"str": "str"}, + }, + api_version="2025-04-01", + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_get_at_tenant_scope(self, resource_group): + response = self.client.deployments.get_at_tenant_scope( + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_cancel_at_tenant_scope(self, resource_group): + response = self.client.deployments.cancel_at_tenant_scope( + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_begin_validate_at_tenant_scope(self, resource_group): + response = self.client.deployments.begin_validate_at_tenant_scope( + deployment_name="str", + parameters={ + "location": "str", + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + }, + "tags": {"str": "str"}, + }, + api_version="2025-04-01", + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_begin_what_if_at_tenant_scope(self, resource_group): + response = self.client.deployments.begin_what_if_at_tenant_scope( + deployment_name="str", + parameters={ + "location": "str", + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + "whatIfSettings": {"resultFormat": "str"}, + }, + }, + api_version="2025-04-01", + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_export_template_at_tenant_scope(self, resource_group): + response = self.client.deployments.export_template_at_tenant_scope( + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_list_at_tenant_scope(self, resource_group): + response = self.client.deployments.list_at_tenant_scope( + api_version="2025-04-01", + ) + result = [r for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_begin_delete_at_management_group_scope(self, resource_group): + response = self.client.deployments.begin_delete_at_management_group_scope( + group_id="str", + deployment_name="str", + api_version="2025-04-01", + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_check_existence_at_management_group_scope(self, resource_group): + response = self.client.deployments.check_existence_at_management_group_scope( + group_id="str", + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_begin_create_or_update_at_management_group_scope(self, resource_group): + response = self.client.deployments.begin_create_or_update_at_management_group_scope( + group_id="str", + deployment_name="str", + parameters={ + "location": "str", + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + }, + "tags": {"str": "str"}, + }, + api_version="2025-04-01", + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_get_at_management_group_scope(self, resource_group): + response = self.client.deployments.get_at_management_group_scope( + group_id="str", + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_cancel_at_management_group_scope(self, resource_group): + response = self.client.deployments.cancel_at_management_group_scope( + group_id="str", + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_begin_validate_at_management_group_scope(self, resource_group): + response = self.client.deployments.begin_validate_at_management_group_scope( + group_id="str", + deployment_name="str", + parameters={ + "location": "str", + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + }, + "tags": {"str": "str"}, + }, + api_version="2025-04-01", + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_begin_what_if_at_management_group_scope(self, resource_group): + response = self.client.deployments.begin_what_if_at_management_group_scope( + group_id="str", + deployment_name="str", + parameters={ + "location": "str", + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + "whatIfSettings": {"resultFormat": "str"}, + }, + }, + api_version="2025-04-01", + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_export_template_at_management_group_scope(self, resource_group): + response = self.client.deployments.export_template_at_management_group_scope( + group_id="str", + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_list_at_management_group_scope(self, resource_group): + response = self.client.deployments.list_at_management_group_scope( + group_id="str", + api_version="2025-04-01", + ) + result = [r for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_begin_delete_at_subscription_scope(self, resource_group): + response = self.client.deployments.begin_delete_at_subscription_scope( + deployment_name="str", + api_version="2025-04-01", + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_check_existence_at_subscription_scope(self, resource_group): + response = self.client.deployments.check_existence_at_subscription_scope( + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_begin_create_or_update_at_subscription_scope(self, resource_group): + response = self.client.deployments.begin_create_or_update_at_subscription_scope( + deployment_name="str", + parameters={ + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + }, + "identity": { + "type": "str", + "userAssignedIdentities": {"str": {"clientId": "str", "principalId": "str"}}, + }, + "location": "str", + "tags": {"str": "str"}, + }, + api_version="2025-04-01", + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_get_at_subscription_scope(self, resource_group): + response = self.client.deployments.get_at_subscription_scope( + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_cancel_at_subscription_scope(self, resource_group): + response = self.client.deployments.cancel_at_subscription_scope( + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_begin_validate_at_subscription_scope(self, resource_group): + response = self.client.deployments.begin_validate_at_subscription_scope( + deployment_name="str", + parameters={ + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + }, + "identity": { + "type": "str", + "userAssignedIdentities": {"str": {"clientId": "str", "principalId": "str"}}, + }, + "location": "str", + "tags": {"str": "str"}, + }, + api_version="2025-04-01", + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_begin_what_if_at_subscription_scope(self, resource_group): + response = self.client.deployments.begin_what_if_at_subscription_scope( + deployment_name="str", + parameters={ + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + "whatIfSettings": {"resultFormat": "str"}, + }, + "location": "str", + }, + api_version="2025-04-01", + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_export_template_at_subscription_scope(self, resource_group): + response = self.client.deployments.export_template_at_subscription_scope( + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_list_at_subscription_scope(self, resource_group): + response = self.client.deployments.list_at_subscription_scope( + api_version="2025-04-01", + ) + result = [r for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_begin_delete(self, resource_group): + response = self.client.deployments.begin_delete( + resource_group_name=resource_group.name, + deployment_name="str", + api_version="2025-04-01", + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_check_existence(self, resource_group): + response = self.client.deployments.check_existence( + resource_group_name=resource_group.name, + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_begin_create_or_update(self, resource_group): + response = self.client.deployments.begin_create_or_update( + resource_group_name=resource_group.name, + deployment_name="str", + parameters={ + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + }, + "identity": { + "type": "str", + "userAssignedIdentities": {"str": {"clientId": "str", "principalId": "str"}}, + }, + "location": "str", + "tags": {"str": "str"}, + }, + api_version="2025-04-01", + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_get(self, resource_group): + response = self.client.deployments.get( + resource_group_name=resource_group.name, + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_cancel(self, resource_group): + response = self.client.deployments.cancel( + resource_group_name=resource_group.name, + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_begin_validate(self, resource_group): + response = self.client.deployments.begin_validate( + resource_group_name=resource_group.name, + deployment_name="str", + parameters={ + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + }, + "identity": { + "type": "str", + "userAssignedIdentities": {"str": {"clientId": "str", "principalId": "str"}}, + }, + "location": "str", + "tags": {"str": "str"}, + }, + api_version="2025-04-01", + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_begin_what_if(self, resource_group): + response = self.client.deployments.begin_what_if( + resource_group_name=resource_group.name, + deployment_name="str", + parameters={ + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + "whatIfSettings": {"resultFormat": "str"}, + }, + "location": "str", + }, + api_version="2025-04-01", + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_export_template(self, resource_group): + response = self.client.deployments.export_template( + resource_group_name=resource_group.name, + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_list_by_resource_group(self, resource_group): + response = self.client.deployments.list_by_resource_group( + resource_group_name=resource_group.name, + api_version="2025-04-01", + ) + result = [r for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_deployments_calculate_template_hash(self, resource_group): + response = self.client.deployments.calculate_template_hash( + template={}, + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/generated_tests/test_deployments_deployments_operations_async.py b/sdk/deployments/azure-mgmt-deployments-deployments/generated_tests/test_deployments_deployments_operations_async.py new file mode 100644 index 000000000000..6a5493dd359b --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/generated_tests/test_deployments_deployments_operations_async.py @@ -0,0 +1,1187 @@ +# pylint: disable=too-many-lines +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from azure.mgmt.deployments.deployments.aio import DeploymentsClient + +from devtools_testutils import AzureMgmtRecordedTestCase, RandomNameResourceGroupPreparer +from devtools_testutils.aio import recorded_by_proxy_async + +AZURE_LOCATION = "eastus" + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestDeploymentsDeploymentsOperationsAsync(AzureMgmtRecordedTestCase): + def setup_method(self, method): + self.client = self.create_mgmt_client(DeploymentsClient, is_async=True) + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_begin_delete_at_scope(self, resource_group): + response = await ( + await self.client.deployments.begin_delete_at_scope( + scope="str", + deployment_name="str", + api_version="2025-04-01", + ) + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_check_existence_at_scope(self, resource_group): + response = await self.client.deployments.check_existence_at_scope( + scope="str", + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_begin_create_or_update_at_scope(self, resource_group): + response = await ( + await self.client.deployments.begin_create_or_update_at_scope( + scope="str", + deployment_name="str", + parameters={ + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + }, + "identity": { + "type": "str", + "userAssignedIdentities": {"str": {"clientId": "str", "principalId": "str"}}, + }, + "location": "str", + "tags": {"str": "str"}, + }, + api_version="2025-04-01", + ) + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_get_at_scope(self, resource_group): + response = await self.client.deployments.get_at_scope( + scope="str", + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_cancel_at_scope(self, resource_group): + response = await self.client.deployments.cancel_at_scope( + scope="str", + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_begin_validate_at_scope(self, resource_group): + response = await ( + await self.client.deployments.begin_validate_at_scope( + scope="str", + deployment_name="str", + parameters={ + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + }, + "identity": { + "type": "str", + "userAssignedIdentities": {"str": {"clientId": "str", "principalId": "str"}}, + }, + "location": "str", + "tags": {"str": "str"}, + }, + api_version="2025-04-01", + ) + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_export_template_at_scope(self, resource_group): + response = await self.client.deployments.export_template_at_scope( + scope="str", + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_list_at_scope(self, resource_group): + response = self.client.deployments.list_at_scope( + scope="str", + api_version="2025-04-01", + ) + result = [r async for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_begin_delete_at_tenant_scope(self, resource_group): + response = await ( + await self.client.deployments.begin_delete_at_tenant_scope( + deployment_name="str", + api_version="2025-04-01", + ) + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_check_existence_at_tenant_scope(self, resource_group): + response = await self.client.deployments.check_existence_at_tenant_scope( + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_begin_create_or_update_at_tenant_scope(self, resource_group): + response = await ( + await self.client.deployments.begin_create_or_update_at_tenant_scope( + deployment_name="str", + parameters={ + "location": "str", + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + }, + "tags": {"str": "str"}, + }, + api_version="2025-04-01", + ) + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_get_at_tenant_scope(self, resource_group): + response = await self.client.deployments.get_at_tenant_scope( + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_cancel_at_tenant_scope(self, resource_group): + response = await self.client.deployments.cancel_at_tenant_scope( + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_begin_validate_at_tenant_scope(self, resource_group): + response = await ( + await self.client.deployments.begin_validate_at_tenant_scope( + deployment_name="str", + parameters={ + "location": "str", + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + }, + "tags": {"str": "str"}, + }, + api_version="2025-04-01", + ) + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_begin_what_if_at_tenant_scope(self, resource_group): + response = await ( + await self.client.deployments.begin_what_if_at_tenant_scope( + deployment_name="str", + parameters={ + "location": "str", + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + "whatIfSettings": {"resultFormat": "str"}, + }, + }, + api_version="2025-04-01", + ) + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_export_template_at_tenant_scope(self, resource_group): + response = await self.client.deployments.export_template_at_tenant_scope( + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_list_at_tenant_scope(self, resource_group): + response = self.client.deployments.list_at_tenant_scope( + api_version="2025-04-01", + ) + result = [r async for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_begin_delete_at_management_group_scope(self, resource_group): + response = await ( + await self.client.deployments.begin_delete_at_management_group_scope( + group_id="str", + deployment_name="str", + api_version="2025-04-01", + ) + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_check_existence_at_management_group_scope(self, resource_group): + response = await self.client.deployments.check_existence_at_management_group_scope( + group_id="str", + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_begin_create_or_update_at_management_group_scope(self, resource_group): + response = await ( + await self.client.deployments.begin_create_or_update_at_management_group_scope( + group_id="str", + deployment_name="str", + parameters={ + "location": "str", + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + }, + "tags": {"str": "str"}, + }, + api_version="2025-04-01", + ) + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_get_at_management_group_scope(self, resource_group): + response = await self.client.deployments.get_at_management_group_scope( + group_id="str", + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_cancel_at_management_group_scope(self, resource_group): + response = await self.client.deployments.cancel_at_management_group_scope( + group_id="str", + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_begin_validate_at_management_group_scope(self, resource_group): + response = await ( + await self.client.deployments.begin_validate_at_management_group_scope( + group_id="str", + deployment_name="str", + parameters={ + "location": "str", + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + }, + "tags": {"str": "str"}, + }, + api_version="2025-04-01", + ) + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_begin_what_if_at_management_group_scope(self, resource_group): + response = await ( + await self.client.deployments.begin_what_if_at_management_group_scope( + group_id="str", + deployment_name="str", + parameters={ + "location": "str", + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + "whatIfSettings": {"resultFormat": "str"}, + }, + }, + api_version="2025-04-01", + ) + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_export_template_at_management_group_scope(self, resource_group): + response = await self.client.deployments.export_template_at_management_group_scope( + group_id="str", + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_list_at_management_group_scope(self, resource_group): + response = self.client.deployments.list_at_management_group_scope( + group_id="str", + api_version="2025-04-01", + ) + result = [r async for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_begin_delete_at_subscription_scope(self, resource_group): + response = await ( + await self.client.deployments.begin_delete_at_subscription_scope( + deployment_name="str", + api_version="2025-04-01", + ) + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_check_existence_at_subscription_scope(self, resource_group): + response = await self.client.deployments.check_existence_at_subscription_scope( + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_begin_create_or_update_at_subscription_scope(self, resource_group): + response = await ( + await self.client.deployments.begin_create_or_update_at_subscription_scope( + deployment_name="str", + parameters={ + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + }, + "identity": { + "type": "str", + "userAssignedIdentities": {"str": {"clientId": "str", "principalId": "str"}}, + }, + "location": "str", + "tags": {"str": "str"}, + }, + api_version="2025-04-01", + ) + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_get_at_subscription_scope(self, resource_group): + response = await self.client.deployments.get_at_subscription_scope( + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_cancel_at_subscription_scope(self, resource_group): + response = await self.client.deployments.cancel_at_subscription_scope( + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_begin_validate_at_subscription_scope(self, resource_group): + response = await ( + await self.client.deployments.begin_validate_at_subscription_scope( + deployment_name="str", + parameters={ + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + }, + "identity": { + "type": "str", + "userAssignedIdentities": {"str": {"clientId": "str", "principalId": "str"}}, + }, + "location": "str", + "tags": {"str": "str"}, + }, + api_version="2025-04-01", + ) + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_begin_what_if_at_subscription_scope(self, resource_group): + response = await ( + await self.client.deployments.begin_what_if_at_subscription_scope( + deployment_name="str", + parameters={ + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + "whatIfSettings": {"resultFormat": "str"}, + }, + "location": "str", + }, + api_version="2025-04-01", + ) + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_export_template_at_subscription_scope(self, resource_group): + response = await self.client.deployments.export_template_at_subscription_scope( + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_list_at_subscription_scope(self, resource_group): + response = self.client.deployments.list_at_subscription_scope( + api_version="2025-04-01", + ) + result = [r async for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_begin_delete(self, resource_group): + response = await ( + await self.client.deployments.begin_delete( + resource_group_name=resource_group.name, + deployment_name="str", + api_version="2025-04-01", + ) + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_check_existence(self, resource_group): + response = await self.client.deployments.check_existence( + resource_group_name=resource_group.name, + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_begin_create_or_update(self, resource_group): + response = await ( + await self.client.deployments.begin_create_or_update( + resource_group_name=resource_group.name, + deployment_name="str", + parameters={ + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + }, + "identity": { + "type": "str", + "userAssignedIdentities": {"str": {"clientId": "str", "principalId": "str"}}, + }, + "location": "str", + "tags": {"str": "str"}, + }, + api_version="2025-04-01", + ) + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_get(self, resource_group): + response = await self.client.deployments.get( + resource_group_name=resource_group.name, + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_cancel(self, resource_group): + response = await self.client.deployments.cancel( + resource_group_name=resource_group.name, + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_begin_validate(self, resource_group): + response = await ( + await self.client.deployments.begin_validate( + resource_group_name=resource_group.name, + deployment_name="str", + parameters={ + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + }, + "identity": { + "type": "str", + "userAssignedIdentities": {"str": {"clientId": "str", "principalId": "str"}}, + }, + "location": "str", + "tags": {"str": "str"}, + }, + api_version="2025-04-01", + ) + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_begin_what_if(self, resource_group): + response = await ( + await self.client.deployments.begin_what_if( + resource_group_name=resource_group.name, + deployment_name="str", + parameters={ + "properties": { + "mode": "str", + "debugSetting": {"detailLevel": "str"}, + "expressionEvaluationOptions": {"scope": "str"}, + "extensionConfigs": { + "str": { + "str": { + "keyVaultReference": { + "keyVault": {"id": "str"}, + "secretName": "str", + "secretVersion": "str", + }, + "type": "str", + "value": {}, + } + } + }, + "externalInputDefinitions": {"str": {"kind": "str", "config": {}}}, + "externalInputs": {"str": {"value": {}}}, + "onErrorDeployment": {"deploymentName": "str", "type": "str"}, + "parameters": { + "str": { + "expression": "str", + "reference": {"keyVault": {"id": "str"}, "secretName": "str", "secretVersion": "str"}, + "value": {}, + } + }, + "parametersLink": {"uri": "str", "contentVersion": "str"}, + "template": {}, + "templateLink": { + "contentVersion": "str", + "id": "str", + "queryString": "str", + "relativePath": "str", + "uri": "str", + }, + "validationLevel": "str", + "whatIfSettings": {"resultFormat": "str"}, + }, + "location": "str", + }, + api_version="2025-04-01", + ) + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_export_template(self, resource_group): + response = await self.client.deployments.export_template( + resource_group_name=resource_group.name, + deployment_name="str", + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_list_by_resource_group(self, resource_group): + response = self.client.deployments.list_by_resource_group( + resource_group_name=resource_group.name, + api_version="2025-04-01", + ) + result = [r async for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_deployments_calculate_template_hash(self, resource_group): + response = await self.client.deployments.calculate_template_hash( + template={}, + api_version="2025-04-01", + ) + + # please add some check logic here by yourself + # ... diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/pyproject.toml b/sdk/deployments/azure-mgmt-deployments-deployments/pyproject.toml new file mode 100644 index 000000000000..42a7f73e0386 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/pyproject.toml @@ -0,0 +1,2 @@ +[tool.azure-sdk-build] +breaking = false diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/sdk_packaging.toml b/sdk/deployments/azure-mgmt-deployments-deployments/sdk_packaging.toml new file mode 100644 index 000000000000..103ecc4b9298 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/sdk_packaging.toml @@ -0,0 +1,12 @@ +[packaging] +package_name = "azure-mgmt-deployments-deployments" +package_nspkg = "azure-mgmt-deployments-nspkg" +package_pprint_name = "Deployments-deployments Management" +package_doc_id = "" +is_stable = true +is_arm = true +need_msrestazure = false +need_azuremgmtcore = true +sample_link = "" +exclude_folders = "" +title = "DeploymentsClient" diff --git a/sdk/deployments/azure-mgmt-deployments-deployments/setup.py b/sdk/deployments/azure-mgmt-deployments-deployments/setup.py new file mode 100644 index 000000000000..eb5eb0128452 --- /dev/null +++ b/sdk/deployments/azure-mgmt-deployments-deployments/setup.py @@ -0,0 +1,83 @@ +#!/usr/bin/env python + +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- + +import re +import os.path +from io import open +from setuptools import find_packages, setup + +# Change the PACKAGE_NAME only to change folder and different name +PACKAGE_NAME = "azure-mgmt-deployments-deployments" +PACKAGE_PPRINT_NAME = "Deployments-deployments Management" + +# a-b-c => a/b/c +package_folder_path = PACKAGE_NAME.replace("-", "/") +# a-b-c => a.b.c +namespace_name = PACKAGE_NAME.replace("-", ".") + +# Version extraction inspired from 'requests' +with open( + os.path.join(package_folder_path, "version.py") + if os.path.exists(os.path.join(package_folder_path, "version.py")) + else os.path.join(package_folder_path, "_version.py"), + "r", +) as fd: + version = re.search(r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]', fd.read(), re.MULTILINE).group(1) + +if not version: + raise RuntimeError("Cannot find version information") + +with open("README.md", encoding="utf-8") as f: + readme = f.read() +with open("CHANGELOG.md", encoding="utf-8") as f: + changelog = f.read() + +setup( + name=PACKAGE_NAME, + version=version, + description="Microsoft Azure {} Client Library for Python".format(PACKAGE_PPRINT_NAME), + long_description=readme + "\n\n" + changelog, + long_description_content_type="text/markdown", + license="MIT License", + author="Microsoft Corporation", + author_email="azpysdkhelp@microsoft.com", + url="https://github.com/Azure/azure-sdk-for-python", + keywords="azure, azure sdk", # update with search keywords relevant to the azure service / product + classifiers=[ + "Development Status :: 5 - Production/Stable", + "Programming Language :: Python", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "License :: OSI Approved :: MIT License", + ], + zip_safe=False, + packages=find_packages( + exclude=[ + "tests", + # Exclude packages that will be covered by PEP420 or nspkg + "azure", + "azure.mgmt", + "azure.mgmt.deployments", + ] + ), + include_package_data=True, + package_data={ + "pytyped": ["py.typed"], + }, + install_requires=[ + "isodate>=0.6.1", + "typing-extensions>=4.6.0", + "azure-common>=1.1", + "azure-mgmt-core>=1.5.0", + ], + python_requires=">=3.9", +) diff --git a/sdk/deployments/ci.yml b/sdk/deployments/ci.yml new file mode 100644 index 000000000000..efd2a046ed75 --- /dev/null +++ b/sdk/deployments/ci.yml @@ -0,0 +1,34 @@ +# DO NOT EDIT THIS FILE +# This file is generated automatically and any changes will be lost. + +trigger: + branches: + include: + - main + - hotfix/* + - release/* + - restapi* + paths: + include: + - sdk/deployments/ + +pr: + branches: + include: + - main + - feature/* + - hotfix/* + - release/* + - restapi* + paths: + include: + - sdk/deployments/ + +extends: + template: ../../eng/pipelines/templates/stages/archetype-sdk-client.yml + parameters: + ServiceDirectory: deployments + TestProxy: true + Artifacts: + - name: azure-mgmt-deployments-deployments + safeName: azuremgmtdeploymentsdeployments