diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/CHANGELOG.md b/sdk/mongocluster/azure-mgmt-mongocluster/CHANGELOG.md new file mode 100644 index 0000000000000..628743d283a92 --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/CHANGELOG.md @@ -0,0 +1,5 @@ +# Release History + +## 1.0.0b1 (1970-01-01) + +- Initial version diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/LICENSE b/sdk/mongocluster/azure-mgmt-mongocluster/LICENSE new file mode 100644 index 0000000000000..b2f52a2bad4e2 --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/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/mongocluster/azure-mgmt-mongocluster/MANIFEST.in b/sdk/mongocluster/azure-mgmt-mongocluster/MANIFEST.in new file mode 100644 index 0000000000000..bc608254569a8 --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/MANIFEST.in @@ -0,0 +1,8 @@ +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 LICENSE +include azure/mgmt/mongocluster/py.typed diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/README.md b/sdk/mongocluster/azure-mgmt-mongocluster/README.md new file mode 100644 index 0000000000000..7478dc9e46c03 --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/README.md @@ -0,0 +1,61 @@ +# Microsoft Azure SDK for Python + +This is the Microsoft Azure MyService Management Client Library. +This package has been tested with Python 3.8+. +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.8+ is required to use this package. +- [Azure subscription](https://azure.microsoft.com/free/) + +### Install the package + +```bash +pip install azure-mgmt-mongocluster +pip install azure-identity +``` + +### Authentication + +By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configure of 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.mongocluster import +import os + +sub_id = os.getenv("AZURE_SUBSCRIPTION_ID") +client = (credential=DefaultAzureCredential(), subscription_id=sub_id) +``` + +## Examples + +Code samples for this package can be found at: +- [Search MyService 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/mongocluster/azure-mgmt-mongocluster/_meta.json b/sdk/mongocluster/azure-mgmt-mongocluster/_meta.json new file mode 100644 index 0000000000000..33733ef9f0bc3 --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/_meta.json @@ -0,0 +1,7 @@ +{ + "commit": "1e830c2bf5e944abb147e05549d83cfec632aebf", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/mongocluster/DocumentDB.MongoCluster.Management", + "@azure-tools/typespec-python": "0.23.13", + "@autorest/python": "6.13.18" +} \ No newline at end of file diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/__init__.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/__init__.py new file mode 100644 index 0000000000000..8db66d3d0f0f2 --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/__init__.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/__init__.py new file mode 100644 index 0000000000000..8db66d3d0f0f2 --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/__init__.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/__init__.py new file mode 100644 index 0000000000000..7c7f589084c0f --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/__init__.py @@ -0,0 +1,26 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import MongoClusterMgmtClient +from ._version import VERSION + +__version__ = VERSION + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "MongoClusterMgmtClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_client.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_client.py new file mode 100644 index 0000000000000..22dd013d10a48 --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_client.py @@ -0,0 +1,136 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, TYPE_CHECKING + +from azure.core.pipeline import policies +from azure.core.rest import HttpRequest, HttpResponse +from azure.mgmt.core import ARMPipelineClient +from azure.mgmt.core.policies import ARMAutoResourceProviderRegistrationPolicy + +from ._configuration import MongoClusterMgmtClientConfiguration +from ._serialization import Deserializer, Serializer +from .operations import ( + FirewallRulesOperations, + MongoClustersOperations, + Operations, + PrivateEndpointConnectionsOperations, + PrivateLinksOperations, + ReplicasOperations, +) + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials import TokenCredential + + +class MongoClusterMgmtClient: # pylint: disable=client-accepts-api-version-keyword + """The Microsoft Azure management API provides create, read, update, and delete functionality for + Azure Cosmos DB for MongoDB vCore resources including clusters and firewall rules. + + :ivar operations: Operations operations + :vartype operations: azure.mgmt.mongocluster.operations.Operations + :ivar mongo_clusters: MongoClustersOperations operations + :vartype mongo_clusters: azure.mgmt.mongocluster.operations.MongoClustersOperations + :ivar firewall_rules: FirewallRulesOperations operations + :vartype firewall_rules: azure.mgmt.mongocluster.operations.FirewallRulesOperations + :ivar private_endpoint_connections: PrivateEndpointConnectionsOperations operations + :vartype private_endpoint_connections: + azure.mgmt.mongocluster.operations.PrivateEndpointConnectionsOperations + :ivar private_links: PrivateLinksOperations operations + :vartype private_links: azure.mgmt.mongocluster.operations.PrivateLinksOperations + :ivar replicas: ReplicasOperations operations + :vartype replicas: azure.mgmt.mongocluster.operations.ReplicasOperations + :param credential: Credential used to authenticate requests to the service. Required. + :type credential: ~azure.core.credentials.TokenCredential + :param subscription_id: The ID of the target subscription. Required. + :type subscription_id: str + :param base_url: Service host. Default value is "https://management.azure.com". + :type base_url: str + :keyword api_version: The API version to use for this operation. Default value is + "2024-06-01-preview". 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: str = "https://management.azure.com", + **kwargs: Any + ) -> None: + self._config = MongoClusterMgmtClientConfiguration( + credential=credential, subscription_id=subscription_id, **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=base_url, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + self.operations = Operations(self._client, self._config, self._serialize, self._deserialize) + self.mongo_clusters = MongoClustersOperations(self._client, self._config, self._serialize, self._deserialize) + self.firewall_rules = FirewallRulesOperations(self._client, self._config, self._serialize, self._deserialize) + self.private_endpoint_connections = PrivateEndpointConnectionsOperations( + self._client, self._config, self._serialize, self._deserialize + ) + self.private_links = PrivateLinksOperations(self._client, self._config, self._serialize, self._deserialize) + self.replicas = ReplicasOperations(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) -> "MongoClusterMgmtClient": + self._client.__enter__() + return self + + def __exit__(self, *exc_details: Any) -> None: + self._client.__exit__(*exc_details) diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_configuration.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_configuration.py new file mode 100644 index 0000000000000..a9204c4afd4ee --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_configuration.py @@ -0,0 +1,66 @@ +# 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) Python 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: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials import TokenCredential + + +class MongoClusterMgmtClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for MongoClusterMgmtClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param credential: Credential used to authenticate requests to the service. Required. + :type credential: ~azure.core.credentials.TokenCredential + :param subscription_id: The ID of the target subscription. Required. + :type subscription_id: str + :keyword api_version: The API version to use for this operation. Default value is + "2024-06-01-preview". 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", "2024-06-01-preview") + + 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-mongocluster/{}".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/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_model_base.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_model_base.py new file mode 100644 index 0000000000000..5cf70733404de --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_model_base.py @@ -0,0 +1,887 @@ +# 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. +# -------------------------------------------------------------------------- +# pylint: disable=protected-access, arguments-differ, signature-differs, broad-except + +import copy +import calendar +import decimal +import functools +import sys +import logging +import base64 +import re +import typing +import enum +import email.utils +from datetime import datetime, date, time, timedelta, timezone +from json import JSONEncoder +from typing_extensions import Self +import isodate +from azure.core.exceptions import DeserializationError +from azure.core import CaseInsensitiveEnumMeta +from azure.core.pipeline import PipelineResponse +from azure.core.serialization import _Null + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping + +_LOGGER = logging.getLogger(__name__) + +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] + +TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") + + +def _timedelta_as_isostr(td: timedelta) -> str: + """Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S' + + Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython + + :param timedelta td: The timedelta to convert + :rtype: str + :return: ISO8601 version of this timedelta + """ + + # Split seconds to larger units + seconds = td.total_seconds() + minutes, seconds = divmod(seconds, 60) + hours, minutes = divmod(minutes, 60) + days, hours = divmod(hours, 24) + + days, hours, minutes = list(map(int, (days, hours, minutes))) + seconds = round(seconds, 6) + + # Build date + date_str = "" + if days: + date_str = "%sD" % days + + if hours or minutes or seconds: + # Build time + time_str = "T" + + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) + + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) + + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) + + time_str += "{}S".format(seconds_string) + else: + time_str = "" + + return "P" + date_str + time_str + + +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded + + +def _serialize_datetime(o, format: typing.Optional[str] = None): + if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) + if not o.tzinfo: + iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() + else: + iso_formatted = o.astimezone(TZ_UTC).isoformat() + # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) + return iso_formatted.replace("+00:00", "Z") + # Next try datetime.date or datetime.time + return o.isoformat() + + +def _is_readonly(p): + try: + return p._visibility == ["read"] # pylint: disable=protected-access + except AttributeError: + return False + + +class SdkJSONEncoder(JSONEncoder): + """A JSON encoder that's capable of serializing datetime objects and bytes.""" + + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + + def default(self, o): # pylint: disable=too-many-return-statements + if _is_model(o): + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) + try: + return super(SdkJSONEncoder, self).default(o) + except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, self.format) + try: + # First try datetime.datetime + return _serialize_datetime(o, self.format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return super(SdkJSONEncoder, self).default(o) + + +_VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) + + +def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + attr = attr.upper() + match = _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") + return date_obj + + +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + +def _deserialize_date(attr: typing.Union[str, date]) -> date: + """Deserialize ISO-8601 formatted string into Date object. + :param str attr: response string to be deserialized. + :rtype: date + :returns: The date object from that input + """ + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + if isinstance(attr, date): + return attr + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore + + +def _deserialize_time(attr: typing.Union[str, time]) -> time: + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :returns: The time object from that input + """ + if isinstance(attr, time): + return attr + return isodate.parse_time(attr) + + +def _deserialize_bytes(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + return bytes(base64.b64decode(attr)) + + +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): + if isinstance(attr, timedelta): + return attr + return isodate.parse_duration(attr) + + +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + +_DESERIALIZE_MAPPING = { + datetime: _deserialize_datetime, + date: _deserialize_date, + time: _deserialize_time, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, + typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, +} + +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + + +def _get_model(module_name: str, model_name: str): + models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} + module_end = module_name.rsplit(".", 1)[0] + models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) + if isinstance(model_name, str): + model_name = model_name.split(".")[-1] + if model_name not in models: + return model_name + return models[model_name] + + +_UNSET = object() + + +class _MyMutableMapping(MutableMapping[str, typing.Any]): # pylint: disable=unsubscriptable-object + def __init__(self, data: typing.Dict[str, typing.Any]) -> None: + self._data = data + + def __contains__(self, key: typing.Any) -> bool: + return key in self._data + + def __getitem__(self, key: str) -> typing.Any: + return self._data.__getitem__(key) + + def __setitem__(self, key: str, value: typing.Any) -> None: + self._data.__setitem__(key, value) + + def __delitem__(self, key: str) -> None: + self._data.__delitem__(key) + + def __iter__(self) -> typing.Iterator[typing.Any]: + return self._data.__iter__() + + def __len__(self) -> int: + return self._data.__len__() + + def __ne__(self, other: typing.Any) -> bool: + return not self.__eq__(other) + + def keys(self) -> typing.KeysView[str]: + return self._data.keys() + + def values(self) -> typing.ValuesView[typing.Any]: + return self._data.values() + + def items(self) -> typing.ItemsView[str, typing.Any]: + return self._data.items() + + def get(self, key: str, default: typing.Any = None) -> typing.Any: + try: + return self[key] + except KeyError: + return default + + @typing.overload + def pop(self, key: str) -> typing.Any: ... + + @typing.overload + def pop(self, key: str, default: _T) -> _T: ... + + @typing.overload + def pop(self, key: str, default: typing.Any) -> typing.Any: ... + + def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.pop(key) + return self._data.pop(key, default) + + def popitem(self) -> typing.Tuple[str, typing.Any]: + return self._data.popitem() + + def clear(self) -> None: + self._data.clear() + + def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: + self._data.update(*args, **kwargs) + + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: ... + + @typing.overload + def setdefault(self, key: str, default: typing.Any) -> typing.Any: ... + + def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.setdefault(key) + return self._data.setdefault(key, default) + + def __eq__(self, other: typing.Any) -> bool: + try: + other_model = self.__class__(other) + except Exception: + return False + return self._data == other_model._data + + def __repr__(self) -> str: + return str(self._data) + + +def _is_model(obj: typing.Any) -> bool: + return getattr(obj, "_is_model", False) + + +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, enum.Enum): + return o.value + try: + # First try datetime.datetime + return _serialize_datetime(o, format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return o + + +def _get_rest_field( + attr_to_rest_field: typing.Dict[str, "_RestField"], rest_name: str +) -> typing.Optional["_RestField"]: + try: + return next(rf for rf in attr_to_rest_field.values() if rf._rest_name == rest_name) + except StopIteration: + return None + + +def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: + if not rf: + return _serialize(value, None) + if rf._is_multipart_file_input: + return value + if rf._is_model: + return _deserialize(rf._type, value) + return _serialize(value, rf._format) + + +class Model(_MyMutableMapping): + _is_model = True + + def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: + class_name = self.__class__.__name__ + if len(args) > 1: + raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given") + dict_to_pass = { + rest_field._rest_name: rest_field._default + for rest_field in self._attr_to_rest_field.values() + if rest_field._default is not _UNSET + } + if args: + dict_to_pass.update( + {k: _create_value(_get_rest_field(self._attr_to_rest_field, k), v) for k, v in args[0].items()} + ) + else: + non_attr_kwargs = [k for k in kwargs if k not in self._attr_to_rest_field] + if non_attr_kwargs: + # actual type errors only throw the first wrong keyword arg they see, so following that. + raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) + super().__init__(dict_to_pass) + + def copy(self) -> "Model": + return Model(self.__dict__) + + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: # pylint: disable=unused-argument + # we know the last three classes in mro are going to be 'Model', 'dict', and 'object' + mros = cls.__mro__[:-3][::-1] # ignore model, dict, and object parents, and reverse the mro order + attr_to_rest_field: typing.Dict[str, _RestField] = { # map attribute name to rest_field property + k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type") + } + annotations = { + k: v + for mro_class in mros + if hasattr(mro_class, "__annotations__") # pylint: disable=no-member + for k, v in mro_class.__annotations__.items() # pylint: disable=no-member + } + for attr, rf in attr_to_rest_field.items(): + rf._module = cls.__module__ + if not rf._type: + rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None)) + if not rf._rest_name_input: + rf._rest_name_input = attr + cls._attr_to_rest_field: typing.Dict[str, _RestField] = dict(attr_to_rest_field.items()) + + return super().__new__(cls) # pylint: disable=no-value-for-parameter + + def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: + for base in cls.__bases__: + if hasattr(base, "__mapping__"): # pylint: disable=no-member + base.__mapping__[discriminator or cls.__name__] = cls # type: ignore # pylint: disable=no-member + + @classmethod + def _get_discriminator(cls, exist_discriminators) -> typing.Optional[str]: + for v in cls.__dict__.values(): + if ( + isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators + ): # pylint: disable=protected-access + return v._rest_name # pylint: disable=protected-access + return None + + @classmethod + def _deserialize(cls, data, exist_discriminators): + if not hasattr(cls, "__mapping__"): # pylint: disable=no-member + return cls(data) + discriminator = cls._get_discriminator(exist_discriminators) + exist_discriminators.append(discriminator) + mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pyright: ignore # pylint: disable=no-member + if mapped_cls == cls: + return cls(data) + return mapped_cls._deserialize(data, exist_discriminators) # pylint: disable=protected-access + + def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]: + """Return a dict that can be JSONify using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore + continue + is_multipart_file_input = False + try: + is_multipart_file_input = next( + rf for rf in self._attr_to_rest_field.values() if rf._rest_name == k + )._is_multipart_file_input + except StopIteration: + pass + result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return type(v)(Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v) + if isinstance(v, dict): + return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v + + +def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + +def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): + if obj is None: + return obj + return _deserialize_with_callable(if_obj_deserializer, obj) + + +def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + +def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj: typing.Dict[typing.Any, typing.Any], +): + if obj is None: + return obj + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} + + +def _deserialize_multiple_sequence( + entry_deserializers: typing.List[typing.Optional[typing.Callable]], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry, deserializer in zip(obj, entry_deserializers)) + + +def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + +def _sorted_annotations(types: typing.List[typing.Any]) -> typing.List[typing.Any]: + return sorted( + types, + key=lambda x: hasattr(x, "__name__") and x.__name__.lower() in ("str", "float", "int", "bool"), + ) + + +def _get_deserialize_callable_from_annotation( # pylint: disable=R0911, R0915, R0912 + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, +) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + if not annotation or annotation in [int, float]: + return None + + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) + + try: + if module and _is_model(annotation): + if rf: + rf._is_model = True + + return functools.partial(_deserialize_model, annotation) # pyright: ignore + except Exception: + pass + + # is it a literal? + try: + if annotation.__origin__ is typing.Literal: # pyright: ignore + return None + except AttributeError: + pass + + # is it optional? + try: + if any(a for a in annotation.__args__ if a == type(None)): # pyright: ignore + if len(annotation.__args__) <= 2: # pyright: ignore + if_obj_deserializer = _get_deserialize_callable_from_annotation( + next(a for a in annotation.__args__ if a != type(None)), module, rf # pyright: ignore + ) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + # the type is Optional[Union[...]], we need to remove the None type from the Union + annotation_copy = copy.copy(annotation) + annotation_copy.__args__ = [a for a in annotation_copy.__args__ if a != type(None)] # pyright: ignore + return _get_deserialize_callable_from_annotation(annotation_copy, module, rf) + except AttributeError: + pass + + # is it union? + if getattr(annotation, "__origin__", None) is typing.Union: + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in _sorted_annotations(annotation.__args__) # pyright: ignore + ] + + return functools.partial(_deserialize_with_union, deserializers) + + try: + if annotation._name == "Dict": # pyright: ignore + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) + + return functools.partial( + _deserialize_dict, + value_deserializer, + module, + ) + except (AttributeError, IndexError): + pass + try: + if annotation._name in ["List", "Set", "Tuple", "Sequence"]: # pyright: ignore + if len(annotation.__args__) > 1: # pyright: ignore + + entry_deserializers = [ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore + ] + return functools.partial(_deserialize_multiple_sequence, entry_deserializers, module) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) + + return functools.partial(_deserialize_sequence, deserializer, module) + except (TypeError, IndexError, AttributeError, SyntaxError): + pass + + def _deserialize_default( + deserializer, + obj, + ): + if obj is None: + return obj + try: + return _deserialize_with_callable(deserializer, obj) + except Exception: + pass + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) + + return functools.partial(_deserialize_default, annotation) + + +def _deserialize_with_callable( + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, +): + try: + if value is None or isinstance(value, _Null): + return None + if deserializer is None: + return value + if isinstance(deserializer, CaseInsensitiveEnumMeta): + try: + return deserializer(value) + except ValueError: + # for unknown value, return raw value + return value + if isinstance(deserializer, type) and issubclass(deserializer, Model): + return deserializer._deserialize(value, []) + return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) + except Exception as e: + raise DeserializationError() from e + + +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + if isinstance(value, PipelineResponse): + value = value.http_response.json() + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) + return _deserialize_with_callable(deserializer, value) + + +class _RestField: + def __init__( + self, + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + is_discriminator: bool = False, + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + ): + self._type = type + self._rest_name_input = name + self._module: typing.Optional[str] = None + self._is_discriminator = is_discriminator + self._visibility = visibility + self._is_model = False + self._default = default + self._format = format + self._is_multipart_file_input = is_multipart_file_input + + @property + def _class_type(self) -> typing.Any: + return getattr(self._type, "args", [None])[0] + + @property + def _rest_name(self) -> str: + if self._rest_name_input is None: + raise ValueError("Rest name was never set") + return self._rest_name_input + + def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin + # by this point, type and rest_name will have a value bc we default + # them in __new__ of the Model class + item = obj.get(self._rest_name) + if item is None: + return item + if self._is_model: + return item + return _deserialize(self._type, _serialize(item, self._format), rf=self) + + def __set__(self, obj: Model, value) -> None: + if value is None: + # we want to wipe out entries if users set attr to None + try: + obj.__delitem__(self._rest_name) + except KeyError: + pass + return + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) + + def _get_deserialize_callable_from_annotation( + self, annotation: typing.Any + ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + return _get_deserialize_callable_from_annotation(annotation, self._module, self) + + +def rest_field( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, +) -> typing.Any: + return _RestField( + name=name, + type=type, + visibility=visibility, + default=default, + format=format, + is_multipart_file_input=is_multipart_file_input, + ) + + +def rest_discriminator( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True) diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_patch.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_patch.py new file mode 100644 index 0000000000000..f7dd32510333d --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""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/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_serialization.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_serialization.py new file mode 100644 index 0000000000000..f0c6180722c89 --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_serialization.py @@ -0,0 +1,1998 @@ +# -------------------------------------------------------------------------- +# +# Copyright (c) Microsoft Corporation. All rights reserved. +# +# The MIT License (MIT) +# +# 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. +# +# -------------------------------------------------------------------------- + +# pylint: skip-file +# 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, + TypeVar, + MutableMapping, + Type, + List, + Mapping, +) + +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 azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull + +_BOM = codecs.BOM_UTF8.decode(encoding="utf-8") + +ModelType = TypeVar("ModelType", bound="Model") +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. + """ + 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) + 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 + 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" + """ + # 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 + + +class UTC(datetime.tzinfo): + """Time Zone info for handling UTC""" + + def utcoffset(self, dt): + """UTF offset for UTC is 0.""" + return datetime.timedelta(0) + + def tzname(self, dt): + """Timestamp representation.""" + return "Z" + + def dst(self, dt): + """No daylight saving for UTC.""" + return datetime.timedelta(hours=1) + + +try: + from datetime import timezone as _FixedOffset # type: ignore +except ImportError: # Python 2.7 + + class _FixedOffset(datetime.tzinfo): # type: ignore + """Fixed offset in minutes east from UTC. + Copy/pasted from Python doc + :param datetime.timedelta offset: offset in timedelta format + """ + + def __init__(self, offset): + self.__offset = offset + + def utcoffset(self, dt): + return self.__offset + + def tzname(self, dt): + return str(self.__offset.total_seconds() / 3600) + + def __repr__(self): + return "".format(self.tzname(None)) + + def dst(self, dt): + return datetime.timedelta(0) + + def __getinitargs__(self): + return (self.__offset,) + + +try: + from datetime import timezone + + TZ_UTC = timezone.utc +except ImportError: + TZ_UTC = UTC() # type: ignore + +_FLATTEN = re.compile(r"(? None: + self.additional_properties: Optional[Dict[str, Any]] = {} + for k in kwargs: + 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.""" + if isinstance(other, self.__class__): + return self.__dict__ == other.__dict__ + return False + + def __ne__(self, other: Any) -> bool: + """Compare objects by comparing all attributes.""" + 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.""" + 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(self, keep_readonly=keep_readonly, **kwargs) # type: ignore + + 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 function key_transformer: A key transformer function. + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) # type: ignore + + @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: + # Assume it's not Autorest generated (tests?). Add ourselves as dependencies. + client_models = {cls.__name__: cls} + return client_models + + @classmethod + def deserialize(cls: Type[ModelType], data: Any, content_type: Optional[str] = None) -> ModelType: + """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 + """ + deserializer = Deserializer(cls._infer_class_models()) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def from_dict( + cls: Type[ModelType], + data: Any, + key_extractors: Optional[Callable[[str, Dict[str, Any], Any], Any]] = None, + content_type: Optional[str] = None, + ) -> ModelType: + """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 str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises: DeserializationError if something went wrong + """ + 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)) + 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. + Remove the polymorphic key from the initial data. + """ + 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.pop(rest_api_response_key, None) or response.pop(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 + """ + return key.replace("\\.", ".") + + +class Serializer(object): + """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): + 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(self, target_obj, data_type=None, **kwargs): + """Serialize data into a string according to type. + + :param 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. + """ + 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() + try: + attributes = target_obj._attribute_map + for attr, attr_desc in attributes.items(): + attr_name = attr + if not keep_readonly and target_obj._validation.get(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 + else: + return serialized + + def body(self, data, data_type, **kwargs): + """Serialize data intended for a request body. + + :param 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 + """ + + # 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) + 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 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 + """ + 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: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return output + + def query(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL query. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :keyword bool skip_quote: Whether to skip quote the serialized result. + Defaults to False. + :rtype: str, list + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + 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: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def header(self, name, data, data_type, **kwargs): + """Serialize data intended for a request header. + + :param 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 + """ + 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: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def serialize_data(self, data, data_type, **kwargs): + """Serialize generic data according to supplied data type. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :param bool required: Whether it's essential that the data not be + empty or None + :raises: AttributeError if required data is None. + :raises: ValueError if data is None + :raises: SerializationError if serialization fails. + """ + 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) + + elif 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 + else: + return self._serialize(data, **kwargs) + + @classmethod + def _get_custom_serializers(cls, data_type, **kwargs): + 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 data: Object to be serialized. + :param str data_type: Type of object in the iterable. + """ + 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 + + @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 data: Object to be serialized. + :rtype: str + """ + 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) + else: + 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 attr: Object to be serialized. + :param str iter_type: Type of object in the iterable. + :param bool required: Whether the objects in the iterable must + not be None or empty. + :param str div: If set, this str will be used to combine the elements + in the iterable into a combined string. Default is 'None'. + :keyword bool do_quote: Whether to quote the serialized result of each iterable element. + Defaults to False. + :rtype: list, str + """ + 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. + :param bool required: Whether the objects in the dictionary must + not be None or empty. + :rtype: dict + """ + 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): + """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 + """ + 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 + elif 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: + 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)) + + @staticmethod + def serialize_bytearray(attr, **kwargs): + """Serialize bytearray into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + return b64encode(attr).decode() + + @staticmethod + def serialize_base64(attr, **kwargs): + """Serialize str into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + encoded = b64encode(attr).decode("ascii") + return encoded.strip("=").replace("+", "-").replace("/", "_") + + @staticmethod + def serialize_decimal(attr, **kwargs): + """Serialize Decimal object to float. + + :param attr: Object to be serialized. + :rtype: float + """ + return float(attr) + + @staticmethod + def serialize_long(attr, **kwargs): + """Serialize long (Py2) or int (Py3). + + :param attr: Object to be serialized. + :rtype: int/long + """ + return _long_type(attr) + + @staticmethod + def serialize_date(attr, **kwargs): + """Serialize Date object into ISO-8601 formatted string. + + :param Date attr: Object to be serialized. + :rtype: str + """ + 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): + """Serialize Time object into ISO-8601 formatted string. + + :param datetime.time attr: Object to be serialized. + :rtype: str + """ + 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): + """Serialize TimeDelta object into ISO-8601 formatted string. + + :param TimeDelta attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + return isodate.duration_isoformat(attr) + + @staticmethod + def serialize_rfc(attr, **kwargs): + """Serialize Datetime object into RFC-1123 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: TypeError if format invalid. + """ + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + except AttributeError: + raise TypeError("RFC1123 object must be valid Datetime object.") + + 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): + """Serialize Datetime object into ISO-8601 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: SerializationError if format invalid. + """ + 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): + """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 + """ + 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: + raise TypeError("Unix time object must be valid Datetime object.") + + +def rest_key_extractor(attr, attr_desc, data): + 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(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): + """Extract the attribute in "data" based on the last part of the JSON path key.""" + 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): + """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" + """ + 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): + 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 + else: + 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 + else: # 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(object): + """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}" r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + + def __init__(self, classes: Optional[Mapping[str, type]] = 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. + """ + data = self._unpack_content(response_data, content_type) + return self._deserialize(target_obj, data) + + def _deserialize(self, target_obj, data): + """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. + """ + # 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(): + 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) + elif 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 + 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 + else: + 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. + """ + 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 + 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. + """ + try: + return self(target_obj, data, content_type=content_type) + 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 raw_data: Data to be processed. + :param 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 + """ + # 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: The response model class. + :param d_attrs: The deserialized response attributes. + """ + if callable(response): + subtype = getattr(response, "_subtype_map", {}) + try: + readonly = [k for k, v in response._validation.items() if v.get("readonly")] + const = [k for k, v in response._validation.items() 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 + return response_obj + except TypeError as err: + msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore + raise DeserializationError(msg + str(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) + + def deserialize_data(self, data, data_type): + """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. + """ + 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 ["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 + else: + 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. + :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. + :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): + """Deserialize a generic object. + This will be handled as a dictionary. + + :param dict attr: Dictionary to be deserialized. + :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 + + else: + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) + + def deserialize_basic(self, attr, data_type): + """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. + :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 "" + else: + # 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) + elif isinstance(attr, str): + if attr.lower() in ["true", "1"]: + return True + elif 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 + + @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. + :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) + else: + 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. + :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: + error = "{!r} is not a valid index for enum {!r}" + raise DeserializationError(error.format(data, enum_obj)) + 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. + :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. + :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. + :rtype: Decimal + :raises: DeserializationError if string format invalid. + """ + 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. + :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. + :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 + else: + return duration + + @staticmethod + def deserialize_date(attr): + """Deserialize ISO-8601 formatted string into Date object. + + :param str attr: response string to be deserialized. + :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. + :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. + :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=_FixedOffset(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 + else: + return date_obj + + @staticmethod + def deserialize_iso(attr): + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :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 + else: + 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. + :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 + else: + return date_obj diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_validation.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_validation.py new file mode 100644 index 0000000000000..752b2822f9d3e --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_validation.py @@ -0,0 +1,50 @@ +# -------------------------------------------------------------------------- +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import functools + + +def api_version_validation(**kwargs): + params_added_on = kwargs.pop("params_added_on", {}) + method_added_on = kwargs.pop("method_added_on", "") + + def decorator(func): + @functools.wraps(func) + def wrapper(*args, **kwargs): + try: + # this assumes the client has an _api_version attribute + client = args[0] + client_api_version = client._config.api_version # pylint: disable=protected-access + except AttributeError: + return func(*args, **kwargs) + + if method_added_on > client_api_version: + raise ValueError( + f"'{func.__name__}' is not available in API version " + f"{client_api_version}. Pass service API version {method_added_on} or newer to your client." + ) + + unsupported = { + parameter: api_version + for api_version, parameters in params_added_on.items() + for parameter in parameters + if parameter in kwargs and api_version > client_api_version + } + if unsupported: + raise ValueError( + "".join( + [ + f"'{param}' is not available in API version {client_api_version}. " + f"Use service API version {version} or newer.\n" + for param, version in unsupported.items() + ] + ) + ) + return func(*args, **kwargs) + + return wrapper + + return decorator diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_version.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_version.py new file mode 100644 index 0000000000000..be71c81bd2821 --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +VERSION = "1.0.0b1" diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/__init__.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/__init__.py new file mode 100644 index 0000000000000..450287ccbf628 --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/__init__.py @@ -0,0 +1,23 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import MongoClusterMgmtClient + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "MongoClusterMgmtClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/_client.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/_client.py new file mode 100644 index 0000000000000..c8f2c140ca3de --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/_client.py @@ -0,0 +1,138 @@ +# 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) Python 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, TYPE_CHECKING + +from azure.core.pipeline import policies +from azure.core.rest import AsyncHttpResponse, HttpRequest +from azure.mgmt.core import AsyncARMPipelineClient +from azure.mgmt.core.policies import AsyncARMAutoResourceProviderRegistrationPolicy + +from .._serialization import Deserializer, Serializer +from ._configuration import MongoClusterMgmtClientConfiguration +from .operations import ( + FirewallRulesOperations, + MongoClustersOperations, + Operations, + PrivateEndpointConnectionsOperations, + PrivateLinksOperations, + ReplicasOperations, +) + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials_async import AsyncTokenCredential + + +class MongoClusterMgmtClient: # pylint: disable=client-accepts-api-version-keyword + """The Microsoft Azure management API provides create, read, update, and delete functionality for + Azure Cosmos DB for MongoDB vCore resources including clusters and firewall rules. + + :ivar operations: Operations operations + :vartype operations: azure.mgmt.mongocluster.aio.operations.Operations + :ivar mongo_clusters: MongoClustersOperations operations + :vartype mongo_clusters: azure.mgmt.mongocluster.aio.operations.MongoClustersOperations + :ivar firewall_rules: FirewallRulesOperations operations + :vartype firewall_rules: azure.mgmt.mongocluster.aio.operations.FirewallRulesOperations + :ivar private_endpoint_connections: PrivateEndpointConnectionsOperations operations + :vartype private_endpoint_connections: + azure.mgmt.mongocluster.aio.operations.PrivateEndpointConnectionsOperations + :ivar private_links: PrivateLinksOperations operations + :vartype private_links: azure.mgmt.mongocluster.aio.operations.PrivateLinksOperations + :ivar replicas: ReplicasOperations operations + :vartype replicas: azure.mgmt.mongocluster.aio.operations.ReplicasOperations + :param credential: Credential used to authenticate requests to the service. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + :param subscription_id: The ID of the target subscription. Required. + :type subscription_id: str + :param base_url: Service host. Default value is "https://management.azure.com". + :type base_url: str + :keyword api_version: The API version to use for this operation. Default value is + "2024-06-01-preview". 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: str = "https://management.azure.com", + **kwargs: Any + ) -> None: + self._config = MongoClusterMgmtClientConfiguration( + credential=credential, subscription_id=subscription_id, **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=base_url, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + self.operations = Operations(self._client, self._config, self._serialize, self._deserialize) + self.mongo_clusters = MongoClustersOperations(self._client, self._config, self._serialize, self._deserialize) + self.firewall_rules = FirewallRulesOperations(self._client, self._config, self._serialize, self._deserialize) + self.private_endpoint_connections = PrivateEndpointConnectionsOperations( + self._client, self._config, self._serialize, self._deserialize + ) + self.private_links = PrivateLinksOperations(self._client, self._config, self._serialize, self._deserialize) + self.replicas = ReplicasOperations(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) -> "MongoClusterMgmtClient": + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details: Any) -> None: + await self._client.__aexit__(*exc_details) diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/_configuration.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/_configuration.py new file mode 100644 index 0000000000000..ccd01ed9ffb14 --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/_configuration.py @@ -0,0 +1,66 @@ +# 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) Python 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: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials_async import AsyncTokenCredential + + +class MongoClusterMgmtClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for MongoClusterMgmtClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param credential: Credential used to authenticate requests to the service. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + :param subscription_id: The ID of the target subscription. Required. + :type subscription_id: str + :keyword api_version: The API version to use for this operation. Default value is + "2024-06-01-preview". 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", "2024-06-01-preview") + + 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-mongocluster/{}".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/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/_patch.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/_patch.py new file mode 100644 index 0000000000000..f7dd32510333d --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""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/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/operations/__init__.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/operations/__init__.py new file mode 100644 index 0000000000000..c2fa532ddd595 --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/operations/__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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import Operations +from ._operations import MongoClustersOperations +from ._operations import FirewallRulesOperations +from ._operations import PrivateEndpointConnectionsOperations +from ._operations import PrivateLinksOperations +from ._operations import ReplicasOperations + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "Operations", + "MongoClustersOperations", + "FirewallRulesOperations", + "PrivateEndpointConnectionsOperations", + "PrivateLinksOperations", + "ReplicasOperations", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/operations/_operations.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/operations/_operations.py new file mode 100644 index 0000000000000..769f284d47c64 --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/operations/_operations.py @@ -0,0 +1,6043 @@ +# pylint: disable=too-many-lines,too-many-statements +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from io import IOBase +import json +import sys +from typing import Any, AsyncIterable, Callable, Dict, IO, List, Optional, Type, TypeVar, Union, cast, overload +import urllib.parse + +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.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 ..._model_base import SdkJSONEncoder, _deserialize +from ..._validation import api_version_validation +from ...operations._operations import ( + build_firewall_rules_create_or_update_request, + build_firewall_rules_delete_request, + build_firewall_rules_get_request, + build_firewall_rules_list_by_mongo_cluster_request, + build_mongo_clusters_check_name_availability_request, + build_mongo_clusters_create_or_update_request, + build_mongo_clusters_delete_request, + build_mongo_clusters_get_request, + build_mongo_clusters_list_by_resource_group_request, + build_mongo_clusters_list_connection_strings_request, + build_mongo_clusters_list_request, + build_mongo_clusters_promote_request, + build_mongo_clusters_update_request, + build_operations_list_request, + build_private_endpoint_connections_create_request, + build_private_endpoint_connections_delete_request, + build_private_endpoint_connections_get_request, + build_private_endpoint_connections_list_by_mongo_cluster_request, + build_private_links_list_by_mongo_cluster_request, + build_replicas_list_by_mongo_cluster_request, +) + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object + + +class Operations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.mgmt.mongocluster.aio.MongoClusterMgmtClient`'s + :attr:`operations` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={"2024-03-01-preview": ["api_version", "accept"]}, + ) + def list(self, **kwargs: Any) -> AsyncIterable["_models.Operation"]: + # pylint: disable=line-too-long + """List the operations for the provider. + + :return: An iterator like instance of Operation + :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.mongocluster.models.Operation] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "actionType": "str", # Optional. Extensible enum. Indicates the action type. + "Internal" refers to actions that are for internal only APIs. "Internal" + "display": { + "description": "str", # Optional. The short, localized friendly + description of the operation; suitable for tool tips and detailed views. + "operation": "str", # Optional. The concise, localized friendly name + for the operation; suitable for dropdowns. E.g. "Create or Update Virtual + Machine", "Restart Virtual Machine". + "provider": "str", # Optional. The localized friendly form of the + resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft + Compute". + "resource": "str" # Optional. The localized friendly name of the + resource type related to this operation. E.g. "Virtual Machines" or "Job + Schedule Collections". + }, + "isDataAction": bool, # Optional. Whether the operation applies to + data-plane. This is "true" for data-plane operations and "false" for Azure + Resource Manager/control-plane operations. + "name": "str", # Optional. The name of the operation, as per Resource-Based + Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", + "Microsoft.Compute/virtualMachines/capture/action". + "origin": "str" # Optional. The intended executor of the operation; as in + Resource Based Access Control (RBAC) and audit logs UX. Default value is + "user,system". Known values are: "user", "system", and "user,system". + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.Operation]] = kwargs.pop("cls", None) + + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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_operations_list_request( + api_version=self._config.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) + + return _request + + async def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.Operation], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") 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]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + +class MongoClustersOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.mgmt.mongocluster.aio.MongoClusterMgmtClient`'s + :attr:`mongo_clusters` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace_async + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "accept", + ] + }, + ) + async def get(self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any) -> _models.MongoCluster: + # pylint: disable=line-too-long + """Gets information about a mongo cluster. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :return: MongoCluster. The MongoCluster is compatible with MutableMapping + :rtype: ~azure.mgmt.mongocluster.models.MongoCluster + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.MongoCluster] = kwargs.pop("cls", None) + + _request = build_mongo_clusters_get_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + subscription_id=self._config.subscription_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = kwargs.pop("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]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.MongoCluster, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @api_version_validation( + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "content_type", + "accept", + ] + }, + ) + async def _create_or_update_initial( + self, + resource_group_name: str, + mongo_cluster_name: str, + resource: Union[_models.MongoCluster, JSON, IO[bytes]], + **kwargs: Any + ) -> JSON: + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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 = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[JSON] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(resource, (IOBase, bytes)): + _content = resource + else: + _content = json.dumps(resource, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_mongo_clusters_create_or_update_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + subscription_id=self._config.subscription_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + 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, 201]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + response_headers = {} + if response.status_code == 200: + deserialized = _deserialize(JSON, response.json()) + + if response.status_code == 201: + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + + deserialized = _deserialize(JSON, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "content_type", + "accept", + ] + }, + ) + async def begin_create_or_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + resource: _models.MongoCluster, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.MongoCluster]: + # pylint: disable=line-too-long + """Create or update a mongo cluster. Update overwrites all properties for the resource. To only + modify some of the properties, use PATCH. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param resource: Resource create parameters. Required. + :type resource: ~azure.mgmt.mongocluster.models.MongoCluster + :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 MongoCluster. The MongoCluster is + compatible with MutableMapping + :rtype: ~azure.core.polling.AsyncLROPoller[~azure.mgmt.mongocluster.models.MongoCluster] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + + # response body for status code(s): 200, 201 + response == { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "content_type", + "accept", + ] + }, + ) + async def begin_create_or_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + resource: JSON, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.MongoCluster]: + # pylint: disable=line-too-long + """Create or update a mongo cluster. Update overwrites all properties for the resource. To only + modify some of the properties, use PATCH. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param resource: Resource create parameters. Required. + :type resource: JSON + :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 MongoCluster. The MongoCluster is + compatible with MutableMapping + :rtype: ~azure.core.polling.AsyncLROPoller[~azure.mgmt.mongocluster.models.MongoCluster] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "content_type", + "accept", + ] + }, + ) + async def begin_create_or_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.MongoCluster]: + # pylint: disable=line-too-long + """Create or update a mongo cluster. Update overwrites all properties for the resource. To only + modify some of the properties, use PATCH. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param resource: Resource create parameters. Required. + :type resource: 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 MongoCluster. The MongoCluster is + compatible with MutableMapping + :rtype: ~azure.core.polling.AsyncLROPoller[~azure.mgmt.mongocluster.models.MongoCluster] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @distributed_trace_async + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "content_type", + "accept", + ] + }, + ) + async def begin_create_or_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + resource: Union[_models.MongoCluster, JSON, IO[bytes]], + **kwargs: Any + ) -> AsyncLROPoller[_models.MongoCluster]: + # pylint: disable=line-too-long + """Create or update a mongo cluster. Update overwrites all properties for the resource. To only + modify some of the properties, use PATCH. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param resource: Resource create parameters. Is one of the following types: MongoCluster, JSON, + IO[bytes] Required. + :type resource: ~azure.mgmt.mongocluster.models.MongoCluster or JSON or IO[bytes] + :return: An instance of AsyncLROPoller that returns MongoCluster. The MongoCluster is + compatible with MutableMapping + :rtype: ~azure.core.polling.AsyncLROPoller[~azure.mgmt.mongocluster.models.MongoCluster] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + + # response body for status code(s): 200, 201 + response == { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.MongoCluster] = 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, + mongo_cluster_name=mongo_cluster_name, + resource=resource, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + response = pipeline_response.http_response + deserialized = _deserialize(_models.MongoCluster, response.json()) + 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.MongoCluster].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.MongoCluster]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @api_version_validation( + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "content_type", + "accept", + ] + }, + ) + async def _update_initial( + self, + resource_group_name: str, + mongo_cluster_name: str, + properties: Union[_models.MongoClusterUpdate, JSON, IO[bytes]], + **kwargs: Any + ) -> Optional[JSON]: + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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 = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[Optional[JSON]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(properties, (IOBase, bytes)): + _content = properties + else: + _content = json.dumps(properties, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_mongo_clusters_update_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + subscription_id=self._config.subscription_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + 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, 202]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + deserialized = None + response_headers = {} + if response.status_code == 200: + deserialized = _deserialize(JSON, response.json()) + + if response.status_code == 202: + response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "content_type", + "accept", + ] + }, + ) + async def begin_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + properties: _models.MongoClusterUpdate, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.MongoCluster]: + # pylint: disable=line-too-long + """Updates an existing mongo cluster. The request body can contain one to many of the properties + present in the normal mongo cluster definition. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param properties: The resource properties to be updated. Required. + :type properties: ~azure.mgmt.mongocluster.models.MongoClusterUpdate + :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 MongoCluster. The MongoCluster is + compatible with MutableMapping + :rtype: ~azure.core.polling.AsyncLROPoller[~azure.mgmt.mongocluster.models.MongoCluster] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + properties = { + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "tags": { + "str": "str" # Optional. Resource tags. + } + } + + # response body for status code(s): 200, 202 + response == { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "content_type", + "accept", + ] + }, + ) + async def begin_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + properties: JSON, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.MongoCluster]: + # pylint: disable=line-too-long + """Updates an existing mongo cluster. The request body can contain one to many of the properties + present in the normal mongo cluster definition. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param properties: The resource properties to be updated. Required. + :type properties: JSON + :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 MongoCluster. The MongoCluster is + compatible with MutableMapping + :rtype: ~azure.core.polling.AsyncLROPoller[~azure.mgmt.mongocluster.models.MongoCluster] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 202 + response == { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "content_type", + "accept", + ] + }, + ) + async def begin_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + properties: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.MongoCluster]: + # pylint: disable=line-too-long + """Updates an existing mongo cluster. The request body can contain one to many of the properties + present in the normal mongo cluster definition. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param properties: The resource properties to be updated. Required. + :type properties: 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 MongoCluster. The MongoCluster is + compatible with MutableMapping + :rtype: ~azure.core.polling.AsyncLROPoller[~azure.mgmt.mongocluster.models.MongoCluster] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 202 + response == { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @distributed_trace_async + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "content_type", + "accept", + ] + }, + ) + async def begin_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + properties: Union[_models.MongoClusterUpdate, JSON, IO[bytes]], + **kwargs: Any + ) -> AsyncLROPoller[_models.MongoCluster]: + # pylint: disable=line-too-long + """Updates an existing mongo cluster. The request body can contain one to many of the properties + present in the normal mongo cluster definition. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param properties: The resource properties to be updated. Is one of the following types: + MongoClusterUpdate, JSON, IO[bytes] Required. + :type properties: ~azure.mgmt.mongocluster.models.MongoClusterUpdate or JSON or IO[bytes] + :return: An instance of AsyncLROPoller that returns MongoCluster. The MongoCluster is + compatible with MutableMapping + :rtype: ~azure.core.polling.AsyncLROPoller[~azure.mgmt.mongocluster.models.MongoCluster] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + properties = { + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "tags": { + "str": "str" # Optional. Resource tags. + } + } + + # response body for status code(s): 200, 202 + response == { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.MongoCluster] = 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._update_initial( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + properties=properties, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + response = pipeline_response.http_response + deserialized = _deserialize(_models.MongoCluster, response.json()) + 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.MongoCluster].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.MongoCluster]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @api_version_validation( + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "accept", + ] + }, + ) # pylint: disable=inconsistent-return-statements + async def _delete_initial( # pylint: disable=inconsistent-return-statements + self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any + ) -> None: + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_mongo_clusters_delete_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + subscription_id=self._config.subscription_id, + api_version=self._config.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 [202, 204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, 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("int", response.headers.get("Retry-After")) + + if cls: + return cls(pipeline_response, None, response_headers) # type: ignore + + @distributed_trace_async + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "accept", + ] + }, + ) + async def begin_delete( + self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any + ) -> AsyncLROPoller[None]: + """Deletes a mongo cluster. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :return: An instance of AsyncLROPoller that returns None + :rtype: ~azure.core.polling.AsyncLROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + 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( # type: ignore + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + 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 + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={"2024-03-01-preview": ["api_version", "subscription_id", "resource_group_name", "accept"]}, + ) + def list_by_resource_group(self, resource_group_name: str, **kwargs: Any) -> AsyncIterable["_models.MongoCluster"]: + # pylint: disable=line-too-long + """List all the mongo clusters in a given resource group. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :return: An iterator like instance of MongoCluster + :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.mongocluster.models.MongoCluster] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.MongoCluster]] = kwargs.pop("cls", None) + + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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_mongo_clusters_list_by_resource_group_request( + resource_group_name=resource_group_name, + subscription_id=self._config.subscription_id, + api_version=self._config.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) + + return _request + + async def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.MongoCluster], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") 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]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + @distributed_trace + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={"2024-03-01-preview": ["api_version", "subscription_id", "accept"]}, + ) + def list(self, **kwargs: Any) -> AsyncIterable["_models.MongoCluster"]: + # pylint: disable=line-too-long + """List all the mongo clusters in a given subscription. + + :return: An iterator like instance of MongoCluster + :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.mongocluster.models.MongoCluster] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.MongoCluster]] = kwargs.pop("cls", None) + + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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_mongo_clusters_list_request( + subscription_id=self._config.subscription_id, + api_version=self._config.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) + + return _request + + async def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.MongoCluster], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") 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]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + @distributed_trace_async + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "accept", + ] + }, + ) + async def list_connection_strings( + self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any + ) -> _models.ListConnectionStringsResult: + """List mongo cluster connection strings. This includes the default connection string using + SCRAM-SHA-256, as well as other connection strings supported by the cluster. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :return: ListConnectionStringsResult. The ListConnectionStringsResult is compatible with + MutableMapping + :rtype: ~azure.mgmt.mongocluster.models.ListConnectionStringsResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "connectionStrings": [ + { + "connectionString": "str", # Optional. Value of the + connection string. + "description": "str" # Optional. Description of the + connection string. + } + ] + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.ListConnectionStringsResult] = kwargs.pop("cls", None) + + _request = build_mongo_clusters_list_connection_strings_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + subscription_id=self._config.subscription_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = kwargs.pop("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]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.ListConnectionStringsResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": ["api_version", "subscription_id", "location", "content_type", "accept"] + }, + ) + async def check_name_availability( + self, + location: str, + body: _models.CheckNameAvailabilityRequest, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.CheckNameAvailabilityResponse: + # pylint: disable=line-too-long + """Check if mongo cluster name is available for use. + + :param location: The location name. Required. + :type location: str + :param body: The CheckAvailability request. Required. + :type body: ~azure.mgmt.mongocluster.models.CheckNameAvailabilityRequest + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: CheckNameAvailabilityResponse. The CheckNameAvailabilityResponse is compatible with + MutableMapping + :rtype: ~azure.mgmt.mongocluster.models.CheckNameAvailabilityResponse + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "name": "str", # Optional. The name of the resource for which availability + needs to be checked. + "type": "str" # Optional. The resource type. + } + + # response body for status code(s): 200 + response == { + "message": "str", # Optional. Detailed reason why the given name is not + available. + "nameAvailable": bool, # Optional. Indicates if the resource name is + available. + "reason": "str" # Optional. The reason why the given name is not available. + Known values are: "Invalid" and "AlreadyExists". + } + """ + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": ["api_version", "subscription_id", "location", "content_type", "accept"] + }, + ) + async def check_name_availability( + self, location: str, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.CheckNameAvailabilityResponse: + # pylint: disable=line-too-long + """Check if mongo cluster name is available for use. + + :param location: The location name. Required. + :type location: str + :param body: The CheckAvailability request. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: CheckNameAvailabilityResponse. The CheckNameAvailabilityResponse is compatible with + MutableMapping + :rtype: ~azure.mgmt.mongocluster.models.CheckNameAvailabilityResponse + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "message": "str", # Optional. Detailed reason why the given name is not + available. + "nameAvailable": bool, # Optional. Indicates if the resource name is + available. + "reason": "str" # Optional. The reason why the given name is not available. + Known values are: "Invalid" and "AlreadyExists". + } + """ + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": ["api_version", "subscription_id", "location", "content_type", "accept"] + }, + ) + async def check_name_availability( + self, location: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.CheckNameAvailabilityResponse: + # pylint: disable=line-too-long + """Check if mongo cluster name is available for use. + + :param location: The location name. Required. + :type location: str + :param body: The CheckAvailability request. Required. + :type body: 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: CheckNameAvailabilityResponse. The CheckNameAvailabilityResponse is compatible with + MutableMapping + :rtype: ~azure.mgmt.mongocluster.models.CheckNameAvailabilityResponse + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "message": "str", # Optional. Detailed reason why the given name is not + available. + "nameAvailable": bool, # Optional. Indicates if the resource name is + available. + "reason": "str" # Optional. The reason why the given name is not available. + Known values are: "Invalid" and "AlreadyExists". + } + """ + + @distributed_trace_async + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": ["api_version", "subscription_id", "location", "content_type", "accept"] + }, + ) + async def check_name_availability( + self, location: str, body: Union[_models.CheckNameAvailabilityRequest, JSON, IO[bytes]], **kwargs: Any + ) -> _models.CheckNameAvailabilityResponse: + # pylint: disable=line-too-long + """Check if mongo cluster name is available for use. + + :param location: The location name. Required. + :type location: str + :param body: The CheckAvailability request. Is one of the following types: + CheckNameAvailabilityRequest, JSON, IO[bytes] Required. + :type body: ~azure.mgmt.mongocluster.models.CheckNameAvailabilityRequest or JSON or IO[bytes] + :return: CheckNameAvailabilityResponse. The CheckNameAvailabilityResponse is compatible with + MutableMapping + :rtype: ~azure.mgmt.mongocluster.models.CheckNameAvailabilityResponse + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "name": "str", # Optional. The name of the resource for which availability + needs to be checked. + "type": "str" # Optional. The resource type. + } + + # response body for status code(s): 200 + response == { + "message": "str", # Optional. Detailed reason why the given name is not + available. + "nameAvailable": bool, # Optional. Indicates if the resource name is + available. + "reason": "str" # Optional. The reason why the given name is not available. + Known values are: "Invalid" and "AlreadyExists". + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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 = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.CheckNameAvailabilityResponse] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_mongo_clusters_check_name_availability_request( + location=location, + subscription_id=self._config.subscription_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = kwargs.pop("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]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.CheckNameAvailabilityResponse, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def promote( # pylint: disable=inconsistent-return-statements + self, + resource_group_name: str, + mongo_cluster_name: str, + body: _models.PromoteReplicaRequest, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Promotes a replica mongo cluster to a primary role. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param body: The content of the action request. Required. + :type body: ~azure.mgmt.mongocluster.models.PromoteReplicaRequest + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "promoteOption": "str", # The promote option to apply to the operation. + Required. "Forced" + "mode": "str" # Optional. The mode to apply to the promote operation. Value + is optional and defalt value is 'Switchover'. "Switchover" + } + """ + + @overload + async def promote( # pylint: disable=inconsistent-return-statements + self, + resource_group_name: str, + mongo_cluster_name: str, + body: JSON, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Promotes a replica mongo cluster to a primary role. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param body: The content of the action request. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def promote( # pylint: disable=inconsistent-return-statements + self, + resource_group_name: str, + mongo_cluster_name: str, + body: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Promotes a replica mongo cluster to a primary role. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param body: The content of the action request. Required. + :type body: 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: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def promote( # pylint: disable=inconsistent-return-statements + self, + resource_group_name: str, + mongo_cluster_name: str, + body: Union[_models.PromoteReplicaRequest, JSON, IO[bytes]], + **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Promotes a replica mongo cluster to a primary role. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param body: The content of the action request. Is one of the following types: + PromoteReplicaRequest, JSON, IO[bytes] Required. + :type body: ~azure.mgmt.mongocluster.models.PromoteReplicaRequest or JSON or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "promoteOption": "str", # The promote option to apply to the operation. + Required. "Forced" + "mode": "str" # Optional. The mode to apply to the promote operation. Value + is optional and defalt value is 'Switchover'. "Switchover" + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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 = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_mongo_clusters_promote_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + subscription_id=self._config.subscription_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + 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]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + +class FirewallRulesOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.mgmt.mongocluster.aio.MongoClusterMgmtClient`'s + :attr:`firewall_rules` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace_async + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "firewall_rule_name", + "accept", + ] + }, + ) + async def get( + self, resource_group_name: str, mongo_cluster_name: str, firewall_rule_name: str, **kwargs: Any + ) -> _models.FirewallRule: + # pylint: disable=line-too-long + """Gets information about a mongo cluster firewall rule. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :type firewall_rule_name: str + :return: FirewallRule. The FirewallRule is compatible with MutableMapping + :rtype: ~azure.mgmt.mongocluster.models.FirewallRule + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "endIpAddress": "str", # The end IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "startIpAddress": "str", # The start IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "provisioningState": "str" # Optional. The provisioning state of the + firewall rule. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.FirewallRule] = kwargs.pop("cls", None) + + _request = build_firewall_rules_get_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + firewall_rule_name=firewall_rule_name, + subscription_id=self._config.subscription_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = kwargs.pop("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]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.FirewallRule, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @api_version_validation( + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "firewall_rule_name", + "content_type", + "accept", + ] + }, + ) + async def _create_or_update_initial( + self, + resource_group_name: str, + mongo_cluster_name: str, + firewall_rule_name: str, + resource: Union[_models.FirewallRule, JSON, IO[bytes]], + **kwargs: Any + ) -> Optional[JSON]: + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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 = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[Optional[JSON]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(resource, (IOBase, bytes)): + _content = resource + else: + _content = json.dumps(resource, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_firewall_rules_create_or_update_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + firewall_rule_name=firewall_rule_name, + subscription_id=self._config.subscription_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + 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, 201, 202]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + deserialized = None + response_headers = {} + if response.status_code == 200: + deserialized = _deserialize(JSON, response.json()) + + if response.status_code == 201: + deserialized = _deserialize(JSON, response.json()) + + if response.status_code == 202: + response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "firewall_rule_name", + "content_type", + "accept", + ] + }, + ) + async def begin_create_or_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + firewall_rule_name: str, + resource: _models.FirewallRule, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.FirewallRule]: + # pylint: disable=line-too-long + """Creates a new firewall rule or updates an existing firewall rule on a mongo cluster. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :type firewall_rule_name: str + :param resource: Resource create parameters. Required. + :type resource: ~azure.mgmt.mongocluster.models.FirewallRule + :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 FirewallRule. The FirewallRule is + compatible with MutableMapping + :rtype: ~azure.core.polling.AsyncLROPoller[~azure.mgmt.mongocluster.models.FirewallRule] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "endIpAddress": "str", # The end IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "startIpAddress": "str", # The start IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "provisioningState": "str" # Optional. The provisioning state of the + firewall rule. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + + # response body for status code(s): 200, 201 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "endIpAddress": "str", # The end IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "startIpAddress": "str", # The start IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "provisioningState": "str" # Optional. The provisioning state of the + firewall rule. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "firewall_rule_name", + "content_type", + "accept", + ] + }, + ) + async def begin_create_or_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + firewall_rule_name: str, + resource: JSON, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.FirewallRule]: + # pylint: disable=line-too-long + """Creates a new firewall rule or updates an existing firewall rule on a mongo cluster. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :type firewall_rule_name: str + :param resource: Resource create parameters. Required. + :type resource: JSON + :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 FirewallRule. The FirewallRule is + compatible with MutableMapping + :rtype: ~azure.core.polling.AsyncLROPoller[~azure.mgmt.mongocluster.models.FirewallRule] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "endIpAddress": "str", # The end IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "startIpAddress": "str", # The start IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "provisioningState": "str" # Optional. The provisioning state of the + firewall rule. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "firewall_rule_name", + "content_type", + "accept", + ] + }, + ) + async def begin_create_or_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + firewall_rule_name: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.FirewallRule]: + # pylint: disable=line-too-long + """Creates a new firewall rule or updates an existing firewall rule on a mongo cluster. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :type firewall_rule_name: str + :param resource: Resource create parameters. Required. + :type resource: 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 FirewallRule. The FirewallRule is + compatible with MutableMapping + :rtype: ~azure.core.polling.AsyncLROPoller[~azure.mgmt.mongocluster.models.FirewallRule] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "endIpAddress": "str", # The end IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "startIpAddress": "str", # The start IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "provisioningState": "str" # Optional. The provisioning state of the + firewall rule. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @distributed_trace_async + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "firewall_rule_name", + "content_type", + "accept", + ] + }, + ) + async def begin_create_or_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + firewall_rule_name: str, + resource: Union[_models.FirewallRule, JSON, IO[bytes]], + **kwargs: Any + ) -> AsyncLROPoller[_models.FirewallRule]: + # pylint: disable=line-too-long + """Creates a new firewall rule or updates an existing firewall rule on a mongo cluster. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :type firewall_rule_name: str + :param resource: Resource create parameters. Is one of the following types: FirewallRule, JSON, + IO[bytes] Required. + :type resource: ~azure.mgmt.mongocluster.models.FirewallRule or JSON or IO[bytes] + :return: An instance of AsyncLROPoller that returns FirewallRule. The FirewallRule is + compatible with MutableMapping + :rtype: ~azure.core.polling.AsyncLROPoller[~azure.mgmt.mongocluster.models.FirewallRule] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "endIpAddress": "str", # The end IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "startIpAddress": "str", # The start IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "provisioningState": "str" # Optional. The provisioning state of the + firewall rule. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + + # response body for status code(s): 200, 201 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "endIpAddress": "str", # The end IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "startIpAddress": "str", # The start IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "provisioningState": "str" # Optional. The provisioning state of the + firewall rule. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + 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._create_or_update_initial( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + firewall_rule_name=firewall_rule_name, + resource=resource, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + response = pipeline_response.http_response + deserialized = _deserialize(_models.FirewallRule, response.json()) + 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.FirewallRule].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.FirewallRule]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @api_version_validation( + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "firewall_rule_name", + "accept", + ] + }, + ) # pylint: disable=inconsistent-return-statements + async def _delete_initial( # pylint: disable=inconsistent-return-statements + self, resource_group_name: str, mongo_cluster_name: str, firewall_rule_name: str, **kwargs: Any + ) -> None: + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_firewall_rules_delete_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + firewall_rule_name=firewall_rule_name, + subscription_id=self._config.subscription_id, + api_version=self._config.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 [202, 204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, 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("int", response.headers.get("Retry-After")) + + if cls: + return cls(pipeline_response, None, response_headers) # type: ignore + + @distributed_trace_async + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "firewall_rule_name", + "accept", + ] + }, + ) + async def begin_delete( + self, resource_group_name: str, mongo_cluster_name: str, firewall_rule_name: str, **kwargs: Any + ) -> AsyncLROPoller[None]: + """Deletes a mongo cluster firewall rule. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :type firewall_rule_name: str + :return: An instance of AsyncLROPoller that returns None + :rtype: ~azure.core.polling.AsyncLROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + 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( # type: ignore + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + firewall_rule_name=firewall_rule_name, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + 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 + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "accept", + ] + }, + ) + def list_by_mongo_cluster( + self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any + ) -> AsyncIterable["_models.FirewallRule"]: + # pylint: disable=line-too-long + """List all the firewall rules in a given mongo cluster. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :return: An iterator like instance of FirewallRule + :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.mongocluster.models.FirewallRule] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "endIpAddress": "str", # The end IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "startIpAddress": "str", # The start IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "provisioningState": "str" # Optional. The provisioning state of the + firewall rule. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.FirewallRule]] = kwargs.pop("cls", None) + + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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_firewall_rules_list_by_mongo_cluster_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + subscription_id=self._config.subscription_id, + api_version=self._config.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) + + return _request + + async def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.FirewallRule], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") 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]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + +class PrivateEndpointConnectionsOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.mgmt.mongocluster.aio.MongoClusterMgmtClient`'s + :attr:`private_endpoint_connections` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "accept", + ] + }, + ) + def list_by_mongo_cluster( + self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any + ) -> AsyncIterable["_models.PrivateEndpointConnectionResource"]: + # pylint: disable=line-too-long + """List existing private connections. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :return: An iterator like instance of PrivateEndpointConnectionResource + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.mongocluster.models.PrivateEndpointConnectionResource] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # Optional. A message indicating + if changes on the service provider require any updates on the consumer. + "description": "str", # Optional. The reason for + approval/rejection of the connection. + "status": "str" # Optional. Indicates whether the connection + has been Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group identifiers for the private + endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource identifier for private + endpoint. + }, + "provisioningState": "str" # Optional. The provisioning state of the + private endpoint connection resource. Known values are: "Succeeded", + "Failed", "Canceled", "Creating", and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.PrivateEndpointConnectionResource]] = kwargs.pop("cls", None) + + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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_private_endpoint_connections_list_by_mongo_cluster_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + subscription_id=self._config.subscription_id, + api_version=self._config.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) + + return _request + + async def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.PrivateEndpointConnectionResource], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") 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]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + @distributed_trace_async + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "private_endpoint_connection_name", + "accept", + ] + }, + ) + async def get( + self, resource_group_name: str, mongo_cluster_name: str, private_endpoint_connection_name: str, **kwargs: Any + ) -> _models.PrivateEndpointConnectionResource: + # pylint: disable=line-too-long + """Get a specific private connection. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param private_endpoint_connection_name: The name of the private endpoint connection associated + with the Azure resource. Required. + :type private_endpoint_connection_name: str + :return: PrivateEndpointConnectionResource. The PrivateEndpointConnectionResource is compatible + with MutableMapping + :rtype: ~azure.mgmt.mongocluster.models.PrivateEndpointConnectionResource + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # Optional. A message indicating + if changes on the service provider require any updates on the consumer. + "description": "str", # Optional. The reason for + approval/rejection of the connection. + "status": "str" # Optional. Indicates whether the connection + has been Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group identifiers for the private + endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource identifier for private + endpoint. + }, + "provisioningState": "str" # Optional. The provisioning state of the + private endpoint connection resource. Known values are: "Succeeded", + "Failed", "Canceled", "Creating", and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.PrivateEndpointConnectionResource] = kwargs.pop("cls", None) + + _request = build_private_endpoint_connections_get_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + private_endpoint_connection_name=private_endpoint_connection_name, + subscription_id=self._config.subscription_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = kwargs.pop("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]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.PrivateEndpointConnectionResource, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @api_version_validation( + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "private_endpoint_connection_name", + "content_type", + "accept", + ] + }, + ) + async def _create_initial( + self, + resource_group_name: str, + mongo_cluster_name: str, + private_endpoint_connection_name: str, + resource: Union[_models.PrivateEndpointConnectionResource, JSON, IO[bytes]], + **kwargs: Any + ) -> Optional[JSON]: + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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 = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[Optional[JSON]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(resource, (IOBase, bytes)): + _content = resource + else: + _content = json.dumps(resource, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_private_endpoint_connections_create_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + private_endpoint_connection_name=private_endpoint_connection_name, + subscription_id=self._config.subscription_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + 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, 201, 202]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + deserialized = None + response_headers = {} + if response.status_code == 200: + deserialized = _deserialize(JSON, response.json()) + + if response.status_code == 201: + deserialized = _deserialize(JSON, response.json()) + + if response.status_code == 202: + response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "private_endpoint_connection_name", + "content_type", + "accept", + ] + }, + ) + async def begin_create( + self, + resource_group_name: str, + mongo_cluster_name: str, + private_endpoint_connection_name: str, + resource: _models.PrivateEndpointConnectionResource, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.PrivateEndpointConnectionResource]: + # pylint: disable=line-too-long + """Create a Private endpoint connection. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param private_endpoint_connection_name: The name of the private endpoint connection associated + with the Azure resource. Required. + :type private_endpoint_connection_name: str + :param resource: Resource create parameters. Required. + :type resource: ~azure.mgmt.mongocluster.models.PrivateEndpointConnectionResource + :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 PrivateEndpointConnectionResource. The + PrivateEndpointConnectionResource is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.mongocluster.models.PrivateEndpointConnectionResource] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # Optional. A message indicating + if changes on the service provider require any updates on the consumer. + "description": "str", # Optional. The reason for + approval/rejection of the connection. + "status": "str" # Optional. Indicates whether the connection + has been Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group identifiers for the private + endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource identifier for private + endpoint. + }, + "provisioningState": "str" # Optional. The provisioning state of the + private endpoint connection resource. Known values are: "Succeeded", + "Failed", "Canceled", "Creating", and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + + # response body for status code(s): 200, 201 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # Optional. A message indicating + if changes on the service provider require any updates on the consumer. + "description": "str", # Optional. The reason for + approval/rejection of the connection. + "status": "str" # Optional. Indicates whether the connection + has been Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group identifiers for the private + endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource identifier for private + endpoint. + }, + "provisioningState": "str" # Optional. The provisioning state of the + private endpoint connection resource. Known values are: "Succeeded", + "Failed", "Canceled", "Creating", and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "private_endpoint_connection_name", + "content_type", + "accept", + ] + }, + ) + async def begin_create( + self, + resource_group_name: str, + mongo_cluster_name: str, + private_endpoint_connection_name: str, + resource: JSON, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.PrivateEndpointConnectionResource]: + # pylint: disable=line-too-long + """Create a Private endpoint connection. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param private_endpoint_connection_name: The name of the private endpoint connection associated + with the Azure resource. Required. + :type private_endpoint_connection_name: str + :param resource: Resource create parameters. Required. + :type resource: JSON + :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 PrivateEndpointConnectionResource. The + PrivateEndpointConnectionResource is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.mongocluster.models.PrivateEndpointConnectionResource] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # Optional. A message indicating + if changes on the service provider require any updates on the consumer. + "description": "str", # Optional. The reason for + approval/rejection of the connection. + "status": "str" # Optional. Indicates whether the connection + has been Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group identifiers for the private + endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource identifier for private + endpoint. + }, + "provisioningState": "str" # Optional. The provisioning state of the + private endpoint connection resource. Known values are: "Succeeded", + "Failed", "Canceled", "Creating", and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "private_endpoint_connection_name", + "content_type", + "accept", + ] + }, + ) + async def begin_create( + self, + resource_group_name: str, + mongo_cluster_name: str, + private_endpoint_connection_name: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.PrivateEndpointConnectionResource]: + # pylint: disable=line-too-long + """Create a Private endpoint connection. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param private_endpoint_connection_name: The name of the private endpoint connection associated + with the Azure resource. Required. + :type private_endpoint_connection_name: str + :param resource: Resource create parameters. Required. + :type resource: 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 PrivateEndpointConnectionResource. The + PrivateEndpointConnectionResource is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.mongocluster.models.PrivateEndpointConnectionResource] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # Optional. A message indicating + if changes on the service provider require any updates on the consumer. + "description": "str", # Optional. The reason for + approval/rejection of the connection. + "status": "str" # Optional. Indicates whether the connection + has been Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group identifiers for the private + endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource identifier for private + endpoint. + }, + "provisioningState": "str" # Optional. The provisioning state of the + private endpoint connection resource. Known values are: "Succeeded", + "Failed", "Canceled", "Creating", and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @distributed_trace_async + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "private_endpoint_connection_name", + "content_type", + "accept", + ] + }, + ) + async def begin_create( + self, + resource_group_name: str, + mongo_cluster_name: str, + private_endpoint_connection_name: str, + resource: Union[_models.PrivateEndpointConnectionResource, JSON, IO[bytes]], + **kwargs: Any + ) -> AsyncLROPoller[_models.PrivateEndpointConnectionResource]: + # pylint: disable=line-too-long + """Create a Private endpoint connection. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param private_endpoint_connection_name: The name of the private endpoint connection associated + with the Azure resource. Required. + :type private_endpoint_connection_name: str + :param resource: Resource create parameters. Is one of the following types: + PrivateEndpointConnectionResource, JSON, IO[bytes] Required. + :type resource: ~azure.mgmt.mongocluster.models.PrivateEndpointConnectionResource or JSON or + IO[bytes] + :return: An instance of AsyncLROPoller that returns PrivateEndpointConnectionResource. The + PrivateEndpointConnectionResource is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.mgmt.mongocluster.models.PrivateEndpointConnectionResource] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # Optional. A message indicating + if changes on the service provider require any updates on the consumer. + "description": "str", # Optional. The reason for + approval/rejection of the connection. + "status": "str" # Optional. Indicates whether the connection + has been Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group identifiers for the private + endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource identifier for private + endpoint. + }, + "provisioningState": "str" # Optional. The provisioning state of the + private endpoint connection resource. Known values are: "Succeeded", + "Failed", "Canceled", "Creating", and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + + # response body for status code(s): 200, 201 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # Optional. A message indicating + if changes on the service provider require any updates on the consumer. + "description": "str", # Optional. The reason for + approval/rejection of the connection. + "status": "str" # Optional. Indicates whether the connection + has been Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group identifiers for the private + endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource identifier for private + endpoint. + }, + "provisioningState": "str" # Optional. The provisioning state of the + private endpoint connection resource. Known values are: "Succeeded", + "Failed", "Canceled", "Creating", and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + 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._create_initial( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + private_endpoint_connection_name=private_endpoint_connection_name, + resource=resource, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + response = pipeline_response.http_response + deserialized = _deserialize(_models.PrivateEndpointConnectionResource, response.json()) + 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.PrivateEndpointConnectionResource].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.PrivateEndpointConnectionResource]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @api_version_validation( + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "private_endpoint_connection_name", + "accept", + ] + }, + ) # pylint: disable=inconsistent-return-statements + async def _delete_initial( # pylint: disable=inconsistent-return-statements + self, resource_group_name: str, mongo_cluster_name: str, private_endpoint_connection_name: str, **kwargs: Any + ) -> None: + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_private_endpoint_connections_delete_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + private_endpoint_connection_name=private_endpoint_connection_name, + subscription_id=self._config.subscription_id, + api_version=self._config.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 [202, 204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, 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("int", response.headers.get("Retry-After")) + + if cls: + return cls(pipeline_response, None, response_headers) # type: ignore + + @distributed_trace_async + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "private_endpoint_connection_name", + "accept", + ] + }, + ) + async def begin_delete( + self, resource_group_name: str, mongo_cluster_name: str, private_endpoint_connection_name: str, **kwargs: Any + ) -> AsyncLROPoller[None]: + """Delete the private endpoint connection. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param private_endpoint_connection_name: The name of the private endpoint connection associated + with the Azure resource. Required. + :type private_endpoint_connection_name: str + :return: An instance of AsyncLROPoller that returns None + :rtype: ~azure.core.polling.AsyncLROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + 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( # type: ignore + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + private_endpoint_connection_name=private_endpoint_connection_name, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + 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 + + +class PrivateLinksOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.mgmt.mongocluster.aio.MongoClusterMgmtClient`'s + :attr:`private_links` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "accept", + ] + }, + ) + def list_by_mongo_cluster( + self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any + ) -> AsyncIterable["_models.PrivateLinkResource"]: + # pylint: disable=line-too-long + """list private links on the given resource. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :return: An iterator like instance of PrivateLinkResource + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.mongocluster.models.PrivateLinkResource] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "groupId": "str", # Optional. The private link resource group id. + "requiredMembers": [ + "str" # Optional. The private link resource required member + names. + ], + "requiredZoneNames": [ + "str" # Optional. The private link resource private link DNS + zone name. + ] + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.PrivateLinkResource]] = kwargs.pop("cls", None) + + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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_private_links_list_by_mongo_cluster_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + subscription_id=self._config.subscription_id, + api_version=self._config.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) + + return _request + + async def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.PrivateLinkResource], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") 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]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + +class ReplicasOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.mgmt.mongocluster.aio.MongoClusterMgmtClient`'s + :attr:`replicas` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace + def list_by_mongo_cluster( + self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any + ) -> AsyncIterable["_models.Replica"]: + # pylint: disable=line-too-long + """List all the replicas for the mongo cluster. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :return: An iterator like instance of Replica + :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.mongocluster.models.Replica] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.Replica]] = kwargs.pop("cls", None) + + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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_replicas_list_by_mongo_cluster_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + subscription_id=self._config.subscription_id, + api_version=self._config.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) + + return _request + + async def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.Replica], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") 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]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/operations/_patch.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/operations/_patch.py new file mode 100644 index 0000000000000..f7dd32510333d --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""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/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/__init__.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/__init__.py new file mode 100644 index 0000000000000..9af8669fb281e --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/__init__.py @@ -0,0 +1,111 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._models import CheckNameAvailabilityRequest +from ._models import CheckNameAvailabilityResponse +from ._models import ConnectionString +from ._models import ErrorAdditionalInfo +from ._models import ErrorDetail +from ._models import ErrorResponse +from ._models import FirewallRule +from ._models import FirewallRuleProperties +from ._models import ListConnectionStringsResult +from ._models import MongoCluster +from ._models import MongoClusterProperties +from ._models import MongoClusterReplicaParameters +from ._models import MongoClusterRestoreParameters +from ._models import MongoClusterUpdate +from ._models import MongoClusterUpdateProperties +from ._models import NodeGroupSpec +from ._models import Operation +from ._models import OperationDisplay +from ._models import PrivateEndpoint +from ._models import PrivateEndpointConnection +from ._models import PrivateEndpointConnectionProperties +from ._models import PrivateEndpointConnectionResource +from ._models import PrivateLinkResource +from ._models import PrivateLinkResourceProperties +from ._models import PrivateLinkServiceConnectionState +from ._models import PromoteReplicaRequest +from ._models import ProxyResource +from ._models import Replica +from ._models import ReplicationProperties +from ._models import Resource +from ._models import SystemData +from ._models import TrackedResource + +from ._enums import ActionType +from ._enums import CheckNameAvailabilityReason +from ._enums import CreateMode +from ._enums import CreatedByType +from ._enums import MongoClusterStatus +from ._enums import NodeKind +from ._enums import Origin +from ._enums import PrivateEndpointConnectionProvisioningState +from ._enums import PrivateEndpointServiceConnectionStatus +from ._enums import PromoteMode +from ._enums import PromoteOption +from ._enums import ProvisioningState +from ._enums import PublicNetworkAccess +from ._enums import ReplicationRole +from ._enums import ReplicationState +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "CheckNameAvailabilityRequest", + "CheckNameAvailabilityResponse", + "ConnectionString", + "ErrorAdditionalInfo", + "ErrorDetail", + "ErrorResponse", + "FirewallRule", + "FirewallRuleProperties", + "ListConnectionStringsResult", + "MongoCluster", + "MongoClusterProperties", + "MongoClusterReplicaParameters", + "MongoClusterRestoreParameters", + "MongoClusterUpdate", + "MongoClusterUpdateProperties", + "NodeGroupSpec", + "Operation", + "OperationDisplay", + "PrivateEndpoint", + "PrivateEndpointConnection", + "PrivateEndpointConnectionProperties", + "PrivateEndpointConnectionResource", + "PrivateLinkResource", + "PrivateLinkResourceProperties", + "PrivateLinkServiceConnectionState", + "PromoteReplicaRequest", + "ProxyResource", + "Replica", + "ReplicationProperties", + "Resource", + "SystemData", + "TrackedResource", + "ActionType", + "CheckNameAvailabilityReason", + "CreateMode", + "CreatedByType", + "MongoClusterStatus", + "NodeKind", + "Origin", + "PrivateEndpointConnectionProvisioningState", + "PrivateEndpointServiceConnectionStatus", + "PromoteMode", + "PromoteOption", + "ProvisioningState", + "PublicNetworkAccess", + "ReplicationRole", + "ReplicationState", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/_enums.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/_enums.py new file mode 100644 index 0000000000000..007fa9908cedf --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/_enums.py @@ -0,0 +1,192 @@ +# 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) Python 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 ActionType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal + only APIs. + """ + + INTERNAL = "Internal" + """Actions are for internal-only APIs.""" + + +class CheckNameAvailabilityReason(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Possible reasons for a name not being available.""" + + INVALID = "Invalid" + """Name is invalid.""" + ALREADY_EXISTS = "AlreadyExists" + """Name already exists.""" + + +class CreatedByType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The kind of entity that created the resource.""" + + USER = "User" + """The entity was created by a user.""" + APPLICATION = "Application" + """The entity was created by an application.""" + MANAGED_IDENTITY = "ManagedIdentity" + """The entity was created by a managed identity.""" + KEY = "Key" + """The entity was created by a key.""" + + +class CreateMode(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The mode that the Mongo Cluster is created with.""" + + DEFAULT = "Default" + """Create a new mongo cluster.""" + POINT_IN_TIME_RESTORE = "PointInTimeRestore" + """Create a mongo cluster from a restore point-in-time.""" + GEO_REPLICA = "GeoReplica" + """Create a replica cluster in distinct geographic region from the source cluster.""" + REPLICA = "Replica" + """Create a replica cluster in the same geographic region as the source cluster.""" + + +class MongoClusterStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The status of the Mongo cluster resource.""" + + READY = "Ready" + """The mongo cluster resource is ready for use.""" + PROVISIONING = "Provisioning" + """The mongo cluster resource is being provisioned.""" + UPDATING = "Updating" + """The mongo cluster resource is being updated.""" + STARTING = "Starting" + """The mongo cluster resource is being started.""" + STOPPING = "Stopping" + """The mongo cluster resource is being stopped.""" + STOPPED = "Stopped" + """The mongo cluster resource is stopped.""" + DROPPING = "Dropping" + """The mongo cluster resource is being dropped.""" + + +class NodeKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The kind of the node on the cluster.""" + + SHARD = "Shard" + """The node is a shard kind.""" + + +class Origin(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit + logs UX. Default value is "user,system". + """ + + USER = "user" + """Indicates the operation is initiated by a user.""" + SYSTEM = "system" + """Indicates the operation is initiated by a system.""" + USER_SYSTEM = "user,system" + """Indicates the operation is initiated by a user or system.""" + + +class PrivateEndpointConnectionProvisioningState(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The provisioning state of the connection.""" + + SUCCEEDED = "Succeeded" + """Resource has been created.""" + FAILED = "Failed" + """Resource creation failed.""" + CANCELED = "Canceled" + """Resource creation was canceled.""" + CREATING = "Creating" + """Connection is being created""" + DELETING = "Deleting" + """Connection is being deleted""" + + +class PrivateEndpointServiceConnectionStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The private endpoint connection status.""" + + PENDING = "Pending" + """Connectionaiting for approval or rejection""" + APPROVED = "Approved" + """Connection approved""" + REJECTED = "Rejected" + """Connection Rejected""" + + +class PromoteMode(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The mode to apply to a promote operation.""" + + SWITCHOVER = "Switchover" + """Promote mode which switches the primary role to the current cluster. The original primary will + be switched to a replica role.""" + + +class PromoteOption(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The option to apply to a promote operation.""" + + FORCED = "Forced" + """Promote option forces the promotion without waiting for the replica to be caught up to the + primary. This can result in data-loss so should only be used during disaster recovery + scenarios.""" + + +class ProvisioningState(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The provisioning state of the last accepted operation.""" + + SUCCEEDED = "Succeeded" + """Resource has been created.""" + FAILED = "Failed" + """Resource creation failed.""" + CANCELED = "Canceled" + """Resource creation was canceled.""" + IN_PROGRESS = "InProgress" + """An operation is in-progress on the resource.""" + UPDATING = "Updating" + """An update operation is in-progress on the resource.""" + DROPPING = "Dropping" + """A drop operation is in-progress on the resource.""" + + +class PublicNetworkAccess(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Whether or not public endpoint access is allowed for this Mongo cluster. Value is optional and + default value is 'Enabled'. + """ + + ENABLED = "Enabled" + """If set, mongo cluster can be accessed through private and public methods.""" + DISABLED = "Disabled" + """If set, the private endpoints are the exclusive access method.""" + + +class ReplicationRole(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Replication role of the mongo cluster.""" + + PRIMARY = "Primary" + """The cluster is a primary replica.""" + ASYNC_REPLICA = "AsyncReplica" + """The cluster is a local asynchronous replica.""" + GEO_ASYNC_REPLICA = "GeoAsyncReplica" + """The cluster is a geo-asynchronous replica.""" + + +class ReplicationState(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The state of the replication link between the replica and source cluster.""" + + ACTIVE = "Active" + """Replication link is active.""" + CATCHUP = "Catchup" + """Replication link is catching-up.""" + PROVISIONING = "Provisioning" + """Replication link is provisioning.""" + UPDATING = "Updating" + """Replication link is updating.""" + BROKEN = "Broken" + """Replication link is broken.""" + RECONFIGURING = "Reconfiguring" + """Replication link is re-configuring.""" diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/_models.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/_models.py new file mode 100644 index 0000000000000..ae217cf4f131a --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/_models.py @@ -0,0 +1,1306 @@ +# coding=utf-8 +# pylint: disable=too-many-lines +# -------------------------------------------------------------------------- +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +import datetime +from typing import Any, Dict, List, Mapping, Optional, TYPE_CHECKING, Union, overload + +from .. import _model_base +from .._model_base import rest_field + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from .. import models as _models + + +class CheckNameAvailabilityRequest(_model_base.Model): + """The check availability request body. + + :ivar name: The name of the resource for which availability needs to be checked. + :vartype name: str + :ivar type: The resource type. + :vartype type: str + """ + + name: Optional[str] = rest_field() + """The name of the resource for which availability needs to be checked.""" + type: Optional[str] = rest_field() + """The resource type.""" + + @overload + def __init__( + self, + *, + name: Optional[str] = None, + type: Optional[str] = None, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class CheckNameAvailabilityResponse(_model_base.Model): + """The check availability result. + + :ivar name_available: Indicates if the resource name is available. + :vartype name_available: bool + :ivar reason: The reason why the given name is not available. Known values are: "Invalid" and + "AlreadyExists". + :vartype reason: str or ~azure.mgmt.mongocluster.models.CheckNameAvailabilityReason + :ivar message: Detailed reason why the given name is not available. + :vartype message: str + """ + + name_available: Optional[bool] = rest_field(name="nameAvailable") + """Indicates if the resource name is available.""" + reason: Optional[Union[str, "_models.CheckNameAvailabilityReason"]] = rest_field() + """The reason why the given name is not available. Known values are: \"Invalid\" and + \"AlreadyExists\".""" + message: Optional[str] = rest_field() + """Detailed reason why the given name is not available.""" + + @overload + def __init__( + self, + *, + name_available: Optional[bool] = None, + reason: Optional[Union[str, "_models.CheckNameAvailabilityReason"]] = None, + message: Optional[str] = None, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ConnectionString(_model_base.Model): + """Connection string for the mongo cluster. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar connection_string: Value of the connection string. + :vartype connection_string: str + :ivar description: Description of the connection string. + :vartype description: str + """ + + connection_string: Optional[str] = rest_field(name="connectionString", visibility=["read"]) + """Value of the connection string.""" + description: Optional[str] = rest_field(visibility=["read"]) + """Description of the connection string.""" + + +class ErrorAdditionalInfo(_model_base.Model): + """The resource management error additional info. + + Readonly 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: any + """ + + type: Optional[str] = rest_field(visibility=["read"]) + """The additional info type.""" + info: Optional[Any] = rest_field(visibility=["read"]) + """The additional info.""" + + +class ErrorDetail(_model_base.Model): + """The error detail. + + Readonly 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.mongocluster.models.ErrorDetail] + :ivar additional_info: The error additional info. + :vartype additional_info: list[~azure.mgmt.mongocluster.models.ErrorAdditionalInfo] + """ + + code: Optional[str] = rest_field(visibility=["read"]) + """The error code.""" + message: Optional[str] = rest_field(visibility=["read"]) + """The error message.""" + target: Optional[str] = rest_field(visibility=["read"]) + """The error target.""" + details: Optional[List["_models.ErrorDetail"]] = rest_field(visibility=["read"]) + """The error details.""" + additional_info: Optional[List["_models.ErrorAdditionalInfo"]] = rest_field( + name="additionalInfo", visibility=["read"] + ) + """The error additional info.""" + + +class ErrorResponse(_model_base.Model): + """Common error response for all Azure Resource Manager APIs to return error details for failed + operations. + + :ivar error: The error object. + :vartype error: ~azure.mgmt.mongocluster.models.ErrorDetail + """ + + error: Optional["_models.ErrorDetail"] = rest_field() + """The error object.""" + + @overload + def __init__( + self, + *, + error: Optional["_models.ErrorDetail"] = None, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Resource(_model_base.Model): + """Common properties for all Azure Resource Manager resources. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar id: Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long + :vartype id: str + :ivar name: The name of the resource. + :vartype name: str + :ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + :vartype type: str + :ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy + information. + :vartype system_data: ~azure.mgmt.mongocluster.models.SystemData + """ + + id: Optional[str] = rest_field(visibility=["read"]) + """Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long""" + name: Optional[str] = rest_field(visibility=["read"]) + """The name of the resource.""" + type: Optional[str] = rest_field(visibility=["read"]) + """The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or + \"Microsoft.Storage/storageAccounts\".""" + system_data: Optional["_models.SystemData"] = rest_field(name="systemData", visibility=["read"]) + """Azure Resource Manager metadata containing createdBy and modifiedBy information.""" + + +class ProxyResource(Resource): + """The base proxy resource. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar id: Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long + :vartype id: str + :ivar name: The name of the resource. + :vartype name: str + :ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + :vartype type: str + :ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy + information. + :vartype system_data: ~azure.mgmt.mongocluster.models.SystemData + """ + + +class FirewallRule(ProxyResource): + """Represents a mongo cluster firewall rule. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar id: Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long + :vartype id: str + :ivar name: The name of the resource. + :vartype name: str + :ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + :vartype type: str + :ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy + information. + :vartype system_data: ~azure.mgmt.mongocluster.models.SystemData + :ivar properties: The resource-specific properties for this resource. + :vartype properties: ~azure.mgmt.mongocluster.models.FirewallRuleProperties + """ + + properties: Optional["_models.FirewallRuleProperties"] = rest_field(visibility=["read", "create"]) + """The resource-specific properties for this resource.""" + + @overload + def __init__( + self, + *, + properties: Optional["_models.FirewallRuleProperties"] = None, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class FirewallRuleProperties(_model_base.Model): + """The properties of a mongo cluster firewall rule. + + Readonly 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 provisioning_state: The provisioning state of the firewall rule. Known values are: + "Succeeded", "Failed", "Canceled", "InProgress", "Updating", and "Dropping". + :vartype provisioning_state: str or ~azure.mgmt.mongocluster.models.ProvisioningState + :ivar start_ip_address: The start IP address of the mongo cluster firewall rule. Must be IPv4 + format. Required. + :vartype start_ip_address: str + :ivar end_ip_address: The end IP address of the mongo cluster firewall rule. Must be IPv4 + format. Required. + :vartype end_ip_address: str + """ + + provisioning_state: Optional[Union[str, "_models.ProvisioningState"]] = rest_field( + name="provisioningState", visibility=["read"] + ) + """The provisioning state of the firewall rule. Known values are: \"Succeeded\", \"Failed\", + \"Canceled\", \"InProgress\", \"Updating\", and \"Dropping\".""" + start_ip_address: str = rest_field(name="startIpAddress") + """The start IP address of the mongo cluster firewall rule. Must be IPv4 format. Required.""" + end_ip_address: str = rest_field(name="endIpAddress") + """The end IP address of the mongo cluster firewall rule. Must be IPv4 format. Required.""" + + @overload + def __init__( + self, + *, + start_ip_address: str, + end_ip_address: str, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ListConnectionStringsResult(_model_base.Model): + """The connection strings for the given mongo cluster. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar connection_strings: An array that contains the connection strings for a mongo cluster. + :vartype connection_strings: list[~azure.mgmt.mongocluster.models.ConnectionString] + """ + + connection_strings: Optional[List["_models.ConnectionString"]] = rest_field( + name="connectionStrings", visibility=["read"] + ) + """An array that contains the connection strings for a mongo cluster.""" + + +class TrackedResource(Resource): + """The resource model definition for an Azure Resource Manager tracked top level resource which + has 'tags' and a 'location'. + + Readonly 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 id: Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long + :vartype id: str + :ivar name: The name of the resource. + :vartype name: str + :ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + :vartype type: str + :ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy + information. + :vartype system_data: ~azure.mgmt.mongocluster.models.SystemData + :ivar location: The geo-location where the resource lives. Required. + :vartype location: str + :ivar tags: Resource tags. + :vartype tags: dict[str, str] + """ + + location: str = rest_field(visibility=["read", "create"]) + """The geo-location where the resource lives. Required.""" + tags: Optional[Dict[str, str]] = rest_field() + """Resource tags.""" + + @overload + def __init__( + self, + *, + location: str, + tags: Optional[Dict[str, str]] = None, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MongoCluster(TrackedResource): + """Represents a mongo cluster resource. + + Readonly 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 id: Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long + :vartype id: str + :ivar name: The name of the resource. + :vartype name: str + :ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + :vartype type: str + :ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy + information. + :vartype system_data: ~azure.mgmt.mongocluster.models.SystemData + :ivar location: The geo-location where the resource lives. Required. + :vartype location: str + :ivar tags: Resource tags. + :vartype tags: dict[str, str] + :ivar properties: The resource-specific properties for this resource. + :vartype properties: ~azure.mgmt.mongocluster.models.MongoClusterProperties + """ + + properties: Optional["_models.MongoClusterProperties"] = rest_field(visibility=["read", "create"]) + """The resource-specific properties for this resource.""" + + @overload + def __init__( + self, + *, + location: str, + tags: Optional[Dict[str, str]] = None, + properties: Optional["_models.MongoClusterProperties"] = None, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MongoClusterProperties(_model_base.Model): # pylint: disable=too-many-instance-attributes + """The properties of a mongo cluster. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar create_mode: The mode to create a mongo cluster. Known values are: "Default", + "PointInTimeRestore", "GeoReplica", and "Replica". + :vartype create_mode: str or ~azure.mgmt.mongocluster.models.CreateMode + :ivar restore_parameters: The parameters to create a point-in-time restore mongo cluster. + :vartype restore_parameters: ~azure.mgmt.mongocluster.models.MongoClusterRestoreParameters + :ivar replica_parameters: The parameters to create a replica mongo cluster. + :vartype replica_parameters: ~azure.mgmt.mongocluster.models.MongoClusterReplicaParameters + :ivar administrator_login: The administrator's login for the mongo cluster. + :vartype administrator_login: str + :ivar administrator_login_password: The password of the administrator login. + :vartype administrator_login_password: str + :ivar server_version: The Mongo DB server version. Defaults to the latest available version if + not specified. + :vartype server_version: str + :ivar connection_string: The default mongo connection string for the cluster. + :vartype connection_string: str + :ivar earliest_restore_time: Earliest restore timestamp in UTC ISO8601 format. + :vartype earliest_restore_time: str + :ivar provisioning_state: The provisioning state of the mongo cluster. Known values are: + "Succeeded", "Failed", "Canceled", "InProgress", "Updating", and "Dropping". + :vartype provisioning_state: str or ~azure.mgmt.mongocluster.models.ProvisioningState + :ivar cluster_status: The status of the mongo cluster. Known values are: "Ready", + "Provisioning", "Updating", "Starting", "Stopping", "Stopped", and "Dropping". + :vartype cluster_status: str or ~azure.mgmt.mongocluster.models.MongoClusterStatus + :ivar public_network_access: Whether or not public endpoint access is allowed for this mongo + cluster. Known values are: "Enabled" and "Disabled". + :vartype public_network_access: str or ~azure.mgmt.mongocluster.models.PublicNetworkAccess + :ivar node_group_specs: The list of node group specs in the cluster. + :vartype node_group_specs: list[~azure.mgmt.mongocluster.models.NodeGroupSpec] + :ivar private_endpoint_connections: List of private endpoint connections. + :vartype private_endpoint_connections: + list[~azure.mgmt.mongocluster.models.PrivateEndpointConnection] + :ivar preview_features: List of private endpoint connections. + :vartype preview_features: list[str] + :ivar replica: The replication properties for the mongo cluster. + :vartype replica: ~azure.mgmt.mongocluster.models.ReplicationProperties + :ivar infrastructure_version: The infrastructure version the cluster is provisioned on. + :vartype infrastructure_version: str + """ + + create_mode: Optional[Union[str, "_models.CreateMode"]] = rest_field(name="createMode", visibility=["create"]) + """The mode to create a mongo cluster. Known values are: \"Default\", \"PointInTimeRestore\", + \"GeoReplica\", and \"Replica\".""" + restore_parameters: Optional["_models.MongoClusterRestoreParameters"] = rest_field( + name="restoreParameters", visibility=["create"] + ) + """The parameters to create a point-in-time restore mongo cluster.""" + replica_parameters: Optional["_models.MongoClusterReplicaParameters"] = rest_field( + name="replicaParameters", visibility=["create"] + ) + """The parameters to create a replica mongo cluster.""" + administrator_login: Optional[str] = rest_field(name="administratorLogin", visibility=["read", "create", "update"]) + """The administrator's login for the mongo cluster.""" + administrator_login_password: Optional[str] = rest_field( + name="administratorLoginPassword", visibility=["create", "update"] + ) + """The password of the administrator login.""" + server_version: Optional[str] = rest_field(name="serverVersion") + """The Mongo DB server version. Defaults to the latest available version if not specified.""" + connection_string: Optional[str] = rest_field(name="connectionString", visibility=["read"]) + """The default mongo connection string for the cluster.""" + earliest_restore_time: Optional[str] = rest_field(name="earliestRestoreTime", visibility=["read"]) + """Earliest restore timestamp in UTC ISO8601 format.""" + provisioning_state: Optional[Union[str, "_models.ProvisioningState"]] = rest_field( + name="provisioningState", visibility=["read"] + ) + """The provisioning state of the mongo cluster. Known values are: \"Succeeded\", \"Failed\", + \"Canceled\", \"InProgress\", \"Updating\", and \"Dropping\".""" + cluster_status: Optional[Union[str, "_models.MongoClusterStatus"]] = rest_field( + name="clusterStatus", visibility=["read"] + ) + """The status of the mongo cluster. Known values are: \"Ready\", \"Provisioning\", \"Updating\", + \"Starting\", \"Stopping\", \"Stopped\", and \"Dropping\".""" + public_network_access: Optional[Union[str, "_models.PublicNetworkAccess"]] = rest_field(name="publicNetworkAccess") + """Whether or not public endpoint access is allowed for this mongo cluster. Known values are: + \"Enabled\" and \"Disabled\".""" + node_group_specs: Optional[List["_models.NodeGroupSpec"]] = rest_field(name="nodeGroupSpecs") + """The list of node group specs in the cluster.""" + private_endpoint_connections: Optional[List["_models.PrivateEndpointConnection"]] = rest_field( + name="privateEndpointConnections", visibility=["read"] + ) + """List of private endpoint connections.""" + preview_features: Optional[List[str]] = rest_field(name="previewFeatures") + """List of private endpoint connections.""" + replica: Optional["_models.ReplicationProperties"] = rest_field(visibility=["read"]) + """The replication properties for the mongo cluster.""" + infrastructure_version: Optional[str] = rest_field(name="infrastructureVersion", visibility=["read"]) + """The infrastructure version the cluster is provisioned on.""" + + @overload + def __init__( + self, + *, + create_mode: Optional[Union[str, "_models.CreateMode"]] = None, + restore_parameters: Optional["_models.MongoClusterRestoreParameters"] = None, + replica_parameters: Optional["_models.MongoClusterReplicaParameters"] = None, + administrator_login: Optional[str] = None, + administrator_login_password: Optional[str] = None, + server_version: Optional[str] = None, + public_network_access: Optional[Union[str, "_models.PublicNetworkAccess"]] = None, + node_group_specs: Optional[List["_models.NodeGroupSpec"]] = None, + preview_features: Optional[List[str]] = None, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MongoClusterReplicaParameters(_model_base.Model): + """Parameters used for replica operations. + + All required parameters must be populated in order to send to server. + + :ivar source_resource_id: The id of the replication source cluster. Required. + :vartype source_resource_id: str + :ivar location: Description of the connection string. Required. + :vartype location: str + """ + + source_resource_id: str = rest_field(name="sourceResourceId") + """The id of the replication source cluster. Required.""" + location: str = rest_field() + """Description of the connection string. Required.""" + + @overload + def __init__( + self, + *, + source_resource_id: str, + location: str, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MongoClusterRestoreParameters(_model_base.Model): + """Parameters used for restore operations. + + :ivar point_in_time_u_t_c: UTC point in time to restore a mongo cluster. + :vartype point_in_time_u_t_c: ~datetime.datetime + :ivar source_resource_id: Resource ID to locate the source cluster to restore. + :vartype source_resource_id: str + """ + + point_in_time_u_t_c: Optional[datetime.datetime] = rest_field(name="pointInTimeUTC", format="rfc3339") + """UTC point in time to restore a mongo cluster.""" + source_resource_id: Optional[str] = rest_field(name="sourceResourceId") + """Resource ID to locate the source cluster to restore.""" + + @overload + def __init__( + self, + *, + point_in_time_u_t_c: Optional[datetime.datetime] = None, + source_resource_id: Optional[str] = None, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MongoClusterUpdate(_model_base.Model): + """The type used for update operations of the MongoCluster. + + :ivar tags: Resource tags. + :vartype tags: dict[str, str] + :ivar properties: + :vartype properties: ~azure.mgmt.mongocluster.models.MongoClusterUpdateProperties + """ + + tags: Optional[Dict[str, str]] = rest_field() + """Resource tags.""" + properties: Optional["_models.MongoClusterUpdateProperties"] = rest_field() + + @overload + def __init__( + self, + *, + tags: Optional[Dict[str, str]] = None, + properties: Optional["_models.MongoClusterUpdateProperties"] = None, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MongoClusterUpdateProperties(_model_base.Model): + """The updatable properties of the MongoCluster. + + :ivar administrator_login: The administrator's login for the mongo cluster. + :vartype administrator_login: str + :ivar administrator_login_password: The password of the administrator login. + :vartype administrator_login_password: str + :ivar server_version: The Mongo DB server version. Defaults to the latest available version if + not specified. + :vartype server_version: str + :ivar public_network_access: Whether or not public endpoint access is allowed for this mongo + cluster. Known values are: "Enabled" and "Disabled". + :vartype public_network_access: str or ~azure.mgmt.mongocluster.models.PublicNetworkAccess + :ivar node_group_specs: The list of node group specs in the cluster. + :vartype node_group_specs: list[~azure.mgmt.mongocluster.models.NodeGroupSpec] + :ivar preview_features: List of private endpoint connections. + :vartype preview_features: list[str] + """ + + administrator_login: Optional[str] = rest_field(name="administratorLogin", visibility=["read", "create", "update"]) + """The administrator's login for the mongo cluster.""" + administrator_login_password: Optional[str] = rest_field( + name="administratorLoginPassword", visibility=["create", "update"] + ) + """The password of the administrator login.""" + server_version: Optional[str] = rest_field(name="serverVersion") + """The Mongo DB server version. Defaults to the latest available version if not specified.""" + public_network_access: Optional[Union[str, "_models.PublicNetworkAccess"]] = rest_field(name="publicNetworkAccess") + """Whether or not public endpoint access is allowed for this mongo cluster. Known values are: + \"Enabled\" and \"Disabled\".""" + node_group_specs: Optional[List["_models.NodeGroupSpec"]] = rest_field(name="nodeGroupSpecs") + """The list of node group specs in the cluster.""" + preview_features: Optional[List[str]] = rest_field(name="previewFeatures") + """List of private endpoint connections.""" + + @overload + def __init__( + self, + *, + administrator_login: Optional[str] = None, + administrator_login_password: Optional[str] = None, + server_version: Optional[str] = None, + public_network_access: Optional[Union[str, "_models.PublicNetworkAccess"]] = None, + node_group_specs: Optional[List["_models.NodeGroupSpec"]] = None, + preview_features: Optional[List[str]] = None, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class NodeGroupSpec(_model_base.Model): + """Specification for a node group. + + :ivar sku: The resource sku for the node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + :vartype sku: str + :ivar disk_size_g_b: The disk storage size for the node group in GB. Example values: 128, 256, + 512, 1024. + :vartype disk_size_g_b: int + :ivar enable_ha: Whether high availability is enabled on the node group. + :vartype enable_ha: bool + :ivar kind: The node type deployed in the node group. "Shard" + :vartype kind: str or ~azure.mgmt.mongocluster.models.NodeKind + :ivar node_count: The number of nodes in the node group. + :vartype node_count: int + """ + + sku: Optional[str] = rest_field() + """The resource sku for the node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'.""" + disk_size_g_b: Optional[int] = rest_field(name="diskSizeGB") + """The disk storage size for the node group in GB. Example values: 128, 256, 512, 1024.""" + enable_ha: Optional[bool] = rest_field(name="enableHa") + """Whether high availability is enabled on the node group.""" + kind: Optional[Union[str, "_models.NodeKind"]] = rest_field() + """The node type deployed in the node group. \"Shard\"""" + node_count: Optional[int] = rest_field(name="nodeCount") + """The number of nodes in the node group.""" + + @overload + def __init__( + self, + *, + sku: Optional[str] = None, + disk_size_g_b: Optional[int] = None, + enable_ha: Optional[bool] = None, + kind: Optional[Union[str, "_models.NodeKind"]] = None, + node_count: Optional[int] = None, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Operation(_model_base.Model): + """Details of a REST API operation, returned from the Resource Provider Operations API. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar name: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: + "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action". + :vartype name: str + :ivar is_data_action: Whether the operation applies to data-plane. This is "true" for + data-plane operations and "false" for Azure Resource Manager/control-plane operations. + :vartype is_data_action: bool + :ivar display: Localized display information for this particular operation. + :vartype display: ~azure.mgmt.mongocluster.models.OperationDisplay + :ivar origin: The intended executor of the operation; as in Resource Based Access Control + (RBAC) and audit logs UX. Default value is "user,system". Known values are: "user", "system", + and "user,system". + :vartype origin: str or ~azure.mgmt.mongocluster.models.Origin + :ivar action_type: Extensible enum. Indicates the action type. "Internal" refers to actions + that are for internal only APIs. "Internal" + :vartype action_type: str or ~azure.mgmt.mongocluster.models.ActionType + """ + + name: Optional[str] = rest_field(visibility=["read"]) + """The name of the operation, as per Resource-Based Access Control (RBAC). Examples: + \"Microsoft.Compute/virtualMachines/write\", + \"Microsoft.Compute/virtualMachines/capture/action\".""" + is_data_action: Optional[bool] = rest_field(name="isDataAction", visibility=["read"]) + """Whether the operation applies to data-plane. This is \"true\" for data-plane operations and + \"false\" for Azure Resource Manager/control-plane operations.""" + display: Optional["_models.OperationDisplay"] = rest_field() + """Localized display information for this particular operation.""" + origin: Optional[Union[str, "_models.Origin"]] = rest_field(visibility=["read"]) + """The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit + logs UX. Default value is \"user,system\". Known values are: \"user\", \"system\", and + \"user,system\".""" + action_type: Optional[Union[str, "_models.ActionType"]] = rest_field(name="actionType") + """Extensible enum. Indicates the action type. \"Internal\" refers to actions that are for + internal only APIs. \"Internal\"""" + + @overload + def __init__( + self, + *, + display: Optional["_models.OperationDisplay"] = None, + action_type: Optional[Union[str, "_models.ActionType"]] = None, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class OperationDisplay(_model_base.Model): + """Localized display information for and operation. + + :ivar provider: The localized friendly form of the resource provider name, e.g. "Microsoft + Monitoring Insights" or "Microsoft Compute". + :vartype provider: str + :ivar resource: The localized friendly name of the resource type related to this operation. + E.g. "Virtual Machines" or "Job Schedule Collections". + :vartype resource: str + :ivar operation: The concise, localized friendly name for the operation; suitable for + dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". + :vartype operation: str + :ivar description: The short, localized friendly description of the operation; suitable for + tool tips and detailed views. + :vartype description: str + """ + + provider: Optional[str] = rest_field() + """The localized friendly form of the resource provider name, e.g. \"Microsoft Monitoring + Insights\" or \"Microsoft Compute\".""" + resource: Optional[str] = rest_field() + """The localized friendly name of the resource type related to this operation. E.g. \"Virtual + Machines\" or \"Job Schedule Collections\".""" + operation: Optional[str] = rest_field() + """The concise, localized friendly name for the operation; suitable for dropdowns. E.g. \"Create + or Update Virtual Machine\", \"Restart Virtual Machine\".""" + description: Optional[str] = rest_field() + """The short, localized friendly description of the operation; suitable for tool tips and detailed + views.""" + + @overload + def __init__( + self, + *, + provider: Optional[str] = None, + resource: Optional[str] = None, + operation: Optional[str] = None, + description: Optional[str] = None, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PrivateEndpoint(_model_base.Model): + """The private endpoint resource. + + :ivar id: The resource identifier for private endpoint. + :vartype id: str + """ + + id: Optional[str] = rest_field() + """The resource identifier for private endpoint.""" + + @overload + def __init__( + self, + *, + id: Optional[str] = None, # pylint: disable=redefined-builtin + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PrivateEndpointConnection(ProxyResource): + """The private endpoint connection resource. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar id: Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long + :vartype id: str + :ivar name: The name of the resource. + :vartype name: str + :ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + :vartype type: str + :ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy + information. + :vartype system_data: ~azure.mgmt.mongocluster.models.SystemData + :ivar properties: The private endpoint connection properties. + :vartype properties: ~azure.mgmt.mongocluster.models.PrivateEndpointConnectionProperties + """ + + properties: Optional["_models.PrivateEndpointConnectionProperties"] = rest_field() + """The private endpoint connection properties.""" + + @overload + def __init__( + self, + *, + properties: Optional["_models.PrivateEndpointConnectionProperties"] = None, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PrivateEndpointConnectionProperties(_model_base.Model): + """Properties of he private endpoint connection resource. + + Readonly 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 group_ids: The group identifiers for the private endpoint resource. + :vartype group_ids: list[str] + :ivar private_endpoint: The private endpoint resource. + :vartype private_endpoint: ~azure.mgmt.mongocluster.models.PrivateEndpoint + :ivar private_link_service_connection_state: A collection of information about the state of the + connection between service consumer and provider. Required. + :vartype private_link_service_connection_state: + ~azure.mgmt.mongocluster.models.PrivateLinkServiceConnectionState + :ivar provisioning_state: The provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", and "Deleting". + :vartype provisioning_state: str or + ~azure.mgmt.mongocluster.models.PrivateEndpointConnectionProvisioningState + """ + + group_ids: Optional[List[str]] = rest_field(name="groupIds", visibility=["read"]) + """The group identifiers for the private endpoint resource.""" + private_endpoint: Optional["_models.PrivateEndpoint"] = rest_field(name="privateEndpoint") + """The private endpoint resource.""" + private_link_service_connection_state: "_models.PrivateLinkServiceConnectionState" = rest_field( + name="privateLinkServiceConnectionState" + ) + """A collection of information about the state of the connection between service consumer and + provider. Required.""" + provisioning_state: Optional[Union[str, "_models.PrivateEndpointConnectionProvisioningState"]] = rest_field( + name="provisioningState" + ) + """The provisioning state of the private endpoint connection resource. Known values are: + \"Succeeded\", \"Failed\", \"Canceled\", \"Creating\", and \"Deleting\".""" + + @overload + def __init__( + self, + *, + private_link_service_connection_state: "_models.PrivateLinkServiceConnectionState", + private_endpoint: Optional["_models.PrivateEndpoint"] = None, + provisioning_state: Optional[Union[str, "_models.PrivateEndpointConnectionProvisioningState"]] = None, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PrivateEndpointConnectionResource(ProxyResource): + """Concrete proxy resource types can be created by aliasing this type using a specific property + type. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar id: Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long + :vartype id: str + :ivar name: The name of the resource. + :vartype name: str + :ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + :vartype type: str + :ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy + information. + :vartype system_data: ~azure.mgmt.mongocluster.models.SystemData + :ivar properties: The resource-specific properties for this resource. + :vartype properties: ~azure.mgmt.mongocluster.models.PrivateEndpointConnectionProperties + """ + + properties: Optional["_models.PrivateEndpointConnectionProperties"] = rest_field(visibility=["read", "create"]) + """The resource-specific properties for this resource.""" + + @overload + def __init__( + self, + *, + properties: Optional["_models.PrivateEndpointConnectionProperties"] = None, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PrivateLinkResource(ProxyResource): + """Concrete proxy resource types can be created by aliasing this type using a specific property + type. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar id: Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long + :vartype id: str + :ivar name: The name of the resource. + :vartype name: str + :ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + :vartype type: str + :ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy + information. + :vartype system_data: ~azure.mgmt.mongocluster.models.SystemData + :ivar properties: The resource-specific properties for this resource. + :vartype properties: ~azure.mgmt.mongocluster.models.PrivateLinkResourceProperties + """ + + properties: Optional["_models.PrivateLinkResourceProperties"] = rest_field(visibility=["read", "create"]) + """The resource-specific properties for this resource.""" + + @overload + def __init__( + self, + *, + properties: Optional["_models.PrivateLinkResourceProperties"] = None, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PrivateLinkResourceProperties(_model_base.Model): + """Properties of a private link resource. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar group_id: The private link resource group id. + :vartype group_id: str + :ivar required_members: The private link resource required member names. + :vartype required_members: list[str] + :ivar required_zone_names: The private link resource private link DNS zone name. + :vartype required_zone_names: list[str] + """ + + group_id: Optional[str] = rest_field(name="groupId", visibility=["read"]) + """The private link resource group id.""" + required_members: Optional[List[str]] = rest_field(name="requiredMembers", visibility=["read"]) + """The private link resource required member names.""" + required_zone_names: Optional[List[str]] = rest_field(name="requiredZoneNames") + """The private link resource private link DNS zone name.""" + + @overload + def __init__( + self, + *, + required_zone_names: Optional[List[str]] = None, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PrivateLinkServiceConnectionState(_model_base.Model): + """A collection of information about the state of the connection between service consumer and + provider. + + :ivar status: Indicates whether the connection has been Approved/Rejected/Removed by the owner + of the service. Known values are: "Pending", "Approved", and "Rejected". + :vartype status: str or ~azure.mgmt.mongocluster.models.PrivateEndpointServiceConnectionStatus + :ivar description: The reason for approval/rejection of the connection. + :vartype description: str + :ivar actions_required: A message indicating if changes on the service provider require any + updates on the consumer. + :vartype actions_required: str + """ + + status: Optional[Union[str, "_models.PrivateEndpointServiceConnectionStatus"]] = rest_field() + """Indicates whether the connection has been Approved/Rejected/Removed by the owner of the + service. Known values are: \"Pending\", \"Approved\", and \"Rejected\".""" + description: Optional[str] = rest_field() + """The reason for approval/rejection of the connection.""" + actions_required: Optional[str] = rest_field(name="actionsRequired") + """A message indicating if changes on the service provider require any updates on the consumer.""" + + @overload + def __init__( + self, + *, + status: Optional[Union[str, "_models.PrivateEndpointServiceConnectionStatus"]] = None, + description: Optional[str] = None, + actions_required: Optional[str] = None, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PromoteReplicaRequest(_model_base.Model): + """Promote replica request properties. + + All required parameters must be populated in order to send to server. + + :ivar promote_option: The promote option to apply to the operation. Required. "Forced" + :vartype promote_option: str or ~azure.mgmt.mongocluster.models.PromoteOption + :ivar mode: The mode to apply to the promote operation. Value is optional and defalt value is + 'Switchover'. "Switchover" + :vartype mode: str or ~azure.mgmt.mongocluster.models.PromoteMode + """ + + promote_option: Union[str, "_models.PromoteOption"] = rest_field(name="promoteOption") + """The promote option to apply to the operation. Required. \"Forced\"""" + mode: Optional[Union[str, "_models.PromoteMode"]] = rest_field() + """The mode to apply to the promote operation. Value is optional and defalt value is 'Switchover'. + \"Switchover\"""" + + @overload + def __init__( + self, + *, + promote_option: Union[str, "_models.PromoteOption"], + mode: Optional[Union[str, "_models.PromoteMode"]] = None, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Replica(ProxyResource): + """Represents a mongo cluster replica. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar id: Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long + :vartype id: str + :ivar name: The name of the resource. + :vartype name: str + :ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + :vartype type: str + :ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy + information. + :vartype system_data: ~azure.mgmt.mongocluster.models.SystemData + :ivar properties: The resource-specific properties for this resource. + :vartype properties: ~azure.mgmt.mongocluster.models.MongoClusterProperties + """ + + properties: Optional["_models.MongoClusterProperties"] = rest_field(visibility=["read", "create"]) + """The resource-specific properties for this resource.""" + + @overload + def __init__( + self, + *, + properties: Optional["_models.MongoClusterProperties"] = None, + ): ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ReplicationProperties(_model_base.Model): + """Replica properties of the mongo cluster. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar source_resource_id: The resource id the source cluster for the replica cluster. + :vartype source_resource_id: str + :ivar role: The replication role of the cluster. Known values are: "Primary", "AsyncReplica", + and "GeoAsyncReplica". + :vartype role: str or ~azure.mgmt.mongocluster.models.ReplicationRole + :ivar state: The replication link state of the replica cluster. Known values are: "Active", + "Catchup", "Provisioning", "Updating", "Broken", and "Reconfiguring". + :vartype state: str or ~azure.mgmt.mongocluster.models.ReplicationState + """ + + source_resource_id: Optional[str] = rest_field(name="sourceResourceId", visibility=["read"]) + """The resource id the source cluster for the replica cluster.""" + role: Optional[Union[str, "_models.ReplicationRole"]] = rest_field(visibility=["read"]) + """The replication role of the cluster. Known values are: \"Primary\", \"AsyncReplica\", and + \"GeoAsyncReplica\".""" + state: Optional[Union[str, "_models.ReplicationState"]] = rest_field(visibility=["read"]) + """The replication link state of the replica cluster. Known values are: \"Active\", \"Catchup\", + \"Provisioning\", \"Updating\", \"Broken\", and \"Reconfiguring\".""" + + +class SystemData(_model_base.Model): + """Metadata pertaining to creation and last modification of the resource. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar created_by: The identity that created the resource. + :vartype created_by: str + :ivar created_by_type: The type of identity that created the resource. Known values are: + "User", "Application", "ManagedIdentity", and "Key". + :vartype created_by_type: str or ~azure.mgmt.mongocluster.models.CreatedByType + :ivar created_at: The type of identity that created the resource. + :vartype created_at: ~datetime.date + :ivar last_modified_by: The identity that last modified the resource. + :vartype last_modified_by: str + :ivar last_modified_by_type: The type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + :vartype last_modified_by_type: str or ~azure.mgmt.mongocluster.models.CreatedByType + :ivar last_modified_at: The timestamp of resource last modification (UTC). + :vartype last_modified_at: ~datetime.date + """ + + created_by: Optional[str] = rest_field(name="createdBy", visibility=["read"]) + """The identity that created the resource.""" + created_by_type: Optional[Union[str, "_models.CreatedByType"]] = rest_field( + name="createdByType", visibility=["read"] + ) + """The type of identity that created the resource. Known values are: \"User\", \"Application\", + \"ManagedIdentity\", and \"Key\".""" + created_at: Optional[datetime.date] = rest_field(name="createdAt", visibility=["read"]) + """The type of identity that created the resource.""" + last_modified_by: Optional[str] = rest_field(name="lastModifiedBy", visibility=["read"]) + """The identity that last modified the resource.""" + last_modified_by_type: Optional[Union[str, "_models.CreatedByType"]] = rest_field( + name="lastModifiedByType", visibility=["read"] + ) + """The type of identity that last modified the resource. Known values are: \"User\", + \"Application\", \"ManagedIdentity\", and \"Key\".""" + last_modified_at: Optional[datetime.date] = rest_field(name="lastModifiedAt", visibility=["read"]) + """The timestamp of resource last modification (UTC).""" diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/_patch.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/_patch.py new file mode 100644 index 0000000000000..f7dd32510333d --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""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/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/operations/__init__.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/operations/__init__.py new file mode 100644 index 0000000000000..c2fa532ddd595 --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/operations/__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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import Operations +from ._operations import MongoClustersOperations +from ._operations import FirewallRulesOperations +from ._operations import PrivateEndpointConnectionsOperations +from ._operations import PrivateLinksOperations +from ._operations import ReplicasOperations + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "Operations", + "MongoClustersOperations", + "FirewallRulesOperations", + "PrivateEndpointConnectionsOperations", + "PrivateLinksOperations", + "ReplicasOperations", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/operations/_operations.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/operations/_operations.py new file mode 100644 index 0000000000000..bdb4b565e399b --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/operations/_operations.py @@ -0,0 +1,6608 @@ +# pylint: disable=too-many-lines,too-many-statements +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from io import IOBase +import json +import sys +from typing import Any, Callable, Dict, IO, Iterable, List, Optional, Type, TypeVar, Union, cast, overload +import urllib.parse + +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.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 .._model_base import SdkJSONEncoder, _deserialize +from .._serialization import Serializer +from .._validation import api_version_validation + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object + +_SERIALIZER = Serializer() +_SERIALIZER.client_side_validation = False + + +def build_operations_list_request(**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", "2024-06-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/providers/Microsoft.DocumentDB/operations" + + # 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_mongo_clusters_get_request( + resource_group_name: str, mongo_cluster_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", "2024-06-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}" # pylint: disable=line-too-long + path_format_arguments = { + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + "resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"), + "mongoClusterName": _SERIALIZER.url("mongo_cluster_name", mongo_cluster_name, "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_mongo_clusters_create_or_update_request( # pylint: disable=name-too-long + resource_group_name: str, mongo_cluster_name: str, subscription_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-06-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}" # pylint: disable=line-too-long + path_format_arguments = { + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + "resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"), + "mongoClusterName": _SERIALIZER.url("mongo_cluster_name", mongo_cluster_name, "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_mongo_clusters_update_request( + resource_group_name: str, mongo_cluster_name: str, subscription_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-06-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}" # pylint: disable=line-too-long + path_format_arguments = { + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + "resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"), + "mongoClusterName": _SERIALIZER.url("mongo_cluster_name", mongo_cluster_name, "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="PATCH", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_mongo_clusters_delete_request( + resource_group_name: str, mongo_cluster_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", "2024-06-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}" # pylint: disable=line-too-long + path_format_arguments = { + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + "resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"), + "mongoClusterName": _SERIALIZER.url("mongo_cluster_name", mongo_cluster_name, "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_mongo_clusters_list_by_resource_group_request( # pylint: disable=name-too-long + resource_group_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", "2024-06-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters" + path_format_arguments = { + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + "resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "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_mongo_clusters_list_request(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", "2024-06-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/mongoClusters" + path_format_arguments = { + "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_mongo_clusters_list_connection_strings_request( # pylint: disable=name-too-long + resource_group_name: str, mongo_cluster_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", "2024-06-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/listConnectionStrings" # pylint: disable=line-too-long + path_format_arguments = { + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + "resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"), + "mongoClusterName": _SERIALIZER.url("mongo_cluster_name", mongo_cluster_name, "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_mongo_clusters_check_name_availability_request( # pylint: disable=name-too-long + location: str, subscription_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-06-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/checkMongoClusterNameAvailability" # pylint: disable=line-too-long + path_format_arguments = { + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + "location": _SERIALIZER.url("location", location, "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_mongo_clusters_promote_request( + resource_group_name: str, mongo_cluster_name: str, subscription_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-06-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/promote" # pylint: disable=line-too-long + path_format_arguments = { + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + "resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"), + "mongoClusterName": _SERIALIZER.url("mongo_cluster_name", mongo_cluster_name, "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_firewall_rules_get_request( + resource_group_name: str, mongo_cluster_name: str, firewall_rule_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", "2024-06-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules/{firewallRuleName}" # pylint: disable=line-too-long + path_format_arguments = { + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + "resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"), + "mongoClusterName": _SERIALIZER.url("mongo_cluster_name", mongo_cluster_name, "str"), + "firewallRuleName": _SERIALIZER.url("firewall_rule_name", firewall_rule_name, "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_firewall_rules_create_or_update_request( # pylint: disable=name-too-long + resource_group_name: str, mongo_cluster_name: str, firewall_rule_name: str, subscription_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-06-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules/{firewallRuleName}" # pylint: disable=line-too-long + path_format_arguments = { + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + "resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"), + "mongoClusterName": _SERIALIZER.url("mongo_cluster_name", mongo_cluster_name, "str"), + "firewallRuleName": _SERIALIZER.url("firewall_rule_name", firewall_rule_name, "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_firewall_rules_delete_request( + resource_group_name: str, mongo_cluster_name: str, firewall_rule_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", "2024-06-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules/{firewallRuleName}" # pylint: disable=line-too-long + path_format_arguments = { + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + "resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"), + "mongoClusterName": _SERIALIZER.url("mongo_cluster_name", mongo_cluster_name, "str"), + "firewallRuleName": _SERIALIZER.url("firewall_rule_name", firewall_rule_name, "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_firewall_rules_list_by_mongo_cluster_request( # pylint: disable=name-too-long + resource_group_name: str, mongo_cluster_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", "2024-06-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules" # pylint: disable=line-too-long + path_format_arguments = { + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + "resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"), + "mongoClusterName": _SERIALIZER.url("mongo_cluster_name", mongo_cluster_name, "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_private_endpoint_connections_list_by_mongo_cluster_request( # pylint: disable=name-too-long + resource_group_name: str, mongo_cluster_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", "2024-06-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/privateEndpointConnections" # pylint: disable=line-too-long + path_format_arguments = { + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + "resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"), + "mongoClusterName": _SERIALIZER.url("mongo_cluster_name", mongo_cluster_name, "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_private_endpoint_connections_get_request( # pylint: disable=name-too-long + resource_group_name: str, + mongo_cluster_name: str, + private_endpoint_connection_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", "2024-06-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/privateEndpointConnections/{privateEndpointConnectionName}" # pylint: disable=line-too-long + path_format_arguments = { + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + "resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"), + "mongoClusterName": _SERIALIZER.url("mongo_cluster_name", mongo_cluster_name, "str"), + "privateEndpointConnectionName": _SERIALIZER.url( + "private_endpoint_connection_name", private_endpoint_connection_name, "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_private_endpoint_connections_create_request( # pylint: disable=name-too-long + resource_group_name: str, + mongo_cluster_name: str, + private_endpoint_connection_name: str, + subscription_id: str, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-06-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/privateEndpointConnections/{privateEndpointConnectionName}" # pylint: disable=line-too-long + path_format_arguments = { + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + "resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"), + "mongoClusterName": _SERIALIZER.url("mongo_cluster_name", mongo_cluster_name, "str"), + "privateEndpointConnectionName": _SERIALIZER.url( + "private_endpoint_connection_name", private_endpoint_connection_name, "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_private_endpoint_connections_delete_request( # pylint: disable=name-too-long + resource_group_name: str, + mongo_cluster_name: str, + private_endpoint_connection_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", "2024-06-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/privateEndpointConnections/{privateEndpointConnectionName}" # pylint: disable=line-too-long + path_format_arguments = { + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + "resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"), + "mongoClusterName": _SERIALIZER.url("mongo_cluster_name", mongo_cluster_name, "str"), + "privateEndpointConnectionName": _SERIALIZER.url( + "private_endpoint_connection_name", private_endpoint_connection_name, "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_private_links_list_by_mongo_cluster_request( # pylint: disable=name-too-long + resource_group_name: str, mongo_cluster_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", "2024-06-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/privateLinkResources" # pylint: disable=line-too-long + path_format_arguments = { + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + "resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"), + "mongoClusterName": _SERIALIZER.url("mongo_cluster_name", mongo_cluster_name, "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_replicas_list_by_mongo_cluster_request( # pylint: disable=name-too-long + resource_group_name: str, mongo_cluster_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", "2024-06-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/replicas" # pylint: disable=line-too-long + path_format_arguments = { + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + "resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"), + "mongoClusterName": _SERIALIZER.url("mongo_cluster_name", mongo_cluster_name, "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) + + +class Operations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.mgmt.mongocluster.MongoClusterMgmtClient`'s + :attr:`operations` attribute. + """ + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={"2024-03-01-preview": ["api_version", "accept"]}, + ) + def list(self, **kwargs: Any) -> Iterable["_models.Operation"]: + # pylint: disable=line-too-long + """List the operations for the provider. + + :return: An iterator like instance of Operation + :rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.mongocluster.models.Operation] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "actionType": "str", # Optional. Extensible enum. Indicates the action type. + "Internal" refers to actions that are for internal only APIs. "Internal" + "display": { + "description": "str", # Optional. The short, localized friendly + description of the operation; suitable for tool tips and detailed views. + "operation": "str", # Optional. The concise, localized friendly name + for the operation; suitable for dropdowns. E.g. "Create or Update Virtual + Machine", "Restart Virtual Machine". + "provider": "str", # Optional. The localized friendly form of the + resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft + Compute". + "resource": "str" # Optional. The localized friendly name of the + resource type related to this operation. E.g. "Virtual Machines" or "Job + Schedule Collections". + }, + "isDataAction": bool, # Optional. Whether the operation applies to + data-plane. This is "true" for data-plane operations and "false" for Azure + Resource Manager/control-plane operations. + "name": "str", # Optional. The name of the operation, as per Resource-Based + Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", + "Microsoft.Compute/virtualMachines/capture/action". + "origin": "str" # Optional. The intended executor of the operation; as in + Resource Based Access Control (RBAC) and audit logs UX. Default value is + "user,system". Known values are: "user", "system", and "user,system". + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.Operation]] = kwargs.pop("cls", None) + + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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_operations_list_request( + api_version=self._config.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) + + return _request + + def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.Operation], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") 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]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + +class MongoClustersOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.mgmt.mongocluster.MongoClusterMgmtClient`'s + :attr:`mongo_clusters` attribute. + """ + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "accept", + ] + }, + ) + def get(self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any) -> _models.MongoCluster: + # pylint: disable=line-too-long + """Gets information about a mongo cluster. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :return: MongoCluster. The MongoCluster is compatible with MutableMapping + :rtype: ~azure.mgmt.mongocluster.models.MongoCluster + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.MongoCluster] = kwargs.pop("cls", None) + + _request = build_mongo_clusters_get_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + subscription_id=self._config.subscription_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = kwargs.pop("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]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.MongoCluster, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @api_version_validation( + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "content_type", + "accept", + ] + }, + ) + def _create_or_update_initial( + self, + resource_group_name: str, + mongo_cluster_name: str, + resource: Union[_models.MongoCluster, JSON, IO[bytes]], + **kwargs: Any + ) -> JSON: + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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 = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[JSON] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(resource, (IOBase, bytes)): + _content = resource + else: + _content = json.dumps(resource, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_mongo_clusters_create_or_update_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + subscription_id=self._config.subscription_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + 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, 201]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + response_headers = {} + if response.status_code == 200: + deserialized = _deserialize(JSON, response.json()) + + if response.status_code == 201: + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + + deserialized = _deserialize(JSON, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "content_type", + "accept", + ] + }, + ) + def begin_create_or_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + resource: _models.MongoCluster, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.MongoCluster]: + # pylint: disable=line-too-long + """Create or update a mongo cluster. Update overwrites all properties for the resource. To only + modify some of the properties, use PATCH. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param resource: Resource create parameters. Required. + :type resource: ~azure.mgmt.mongocluster.models.MongoCluster + :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 MongoCluster. The MongoCluster is compatible + with MutableMapping + :rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.MongoCluster] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + + # response body for status code(s): 200, 201 + response == { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "content_type", + "accept", + ] + }, + ) + def begin_create_or_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + resource: JSON, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.MongoCluster]: + # pylint: disable=line-too-long + """Create or update a mongo cluster. Update overwrites all properties for the resource. To only + modify some of the properties, use PATCH. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param resource: Resource create parameters. Required. + :type resource: JSON + :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 MongoCluster. The MongoCluster is compatible + with MutableMapping + :rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.MongoCluster] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "content_type", + "accept", + ] + }, + ) + def begin_create_or_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.MongoCluster]: + # pylint: disable=line-too-long + """Create or update a mongo cluster. Update overwrites all properties for the resource. To only + modify some of the properties, use PATCH. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param resource: Resource create parameters. Required. + :type resource: 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 MongoCluster. The MongoCluster is compatible + with MutableMapping + :rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.MongoCluster] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @distributed_trace + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "content_type", + "accept", + ] + }, + ) + def begin_create_or_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + resource: Union[_models.MongoCluster, JSON, IO[bytes]], + **kwargs: Any + ) -> LROPoller[_models.MongoCluster]: + # pylint: disable=line-too-long + """Create or update a mongo cluster. Update overwrites all properties for the resource. To only + modify some of the properties, use PATCH. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param resource: Resource create parameters. Is one of the following types: MongoCluster, JSON, + IO[bytes] Required. + :type resource: ~azure.mgmt.mongocluster.models.MongoCluster or JSON or IO[bytes] + :return: An instance of LROPoller that returns MongoCluster. The MongoCluster is compatible + with MutableMapping + :rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.MongoCluster] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + + # response body for status code(s): 200, 201 + response == { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.MongoCluster] = 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, + mongo_cluster_name=mongo_cluster_name, + resource=resource, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + response = pipeline_response.http_response + deserialized = _deserialize(_models.MongoCluster, response.json()) + 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.MongoCluster].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.MongoCluster]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @api_version_validation( + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "content_type", + "accept", + ] + }, + ) + def _update_initial( + self, + resource_group_name: str, + mongo_cluster_name: str, + properties: Union[_models.MongoClusterUpdate, JSON, IO[bytes]], + **kwargs: Any + ) -> Optional[JSON]: + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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 = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[Optional[JSON]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(properties, (IOBase, bytes)): + _content = properties + else: + _content = json.dumps(properties, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_mongo_clusters_update_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + subscription_id=self._config.subscription_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + 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, 202]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + deserialized = None + response_headers = {} + if response.status_code == 200: + deserialized = _deserialize(JSON, response.json()) + + if response.status_code == 202: + response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "content_type", + "accept", + ] + }, + ) + def begin_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + properties: _models.MongoClusterUpdate, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.MongoCluster]: + # pylint: disable=line-too-long + """Updates an existing mongo cluster. The request body can contain one to many of the properties + present in the normal mongo cluster definition. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param properties: The resource properties to be updated. Required. + :type properties: ~azure.mgmt.mongocluster.models.MongoClusterUpdate + :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 MongoCluster. The MongoCluster is compatible + with MutableMapping + :rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.MongoCluster] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + properties = { + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "tags": { + "str": "str" # Optional. Resource tags. + } + } + + # response body for status code(s): 200, 202 + response == { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "content_type", + "accept", + ] + }, + ) + def begin_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + properties: JSON, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.MongoCluster]: + # pylint: disable=line-too-long + """Updates an existing mongo cluster. The request body can contain one to many of the properties + present in the normal mongo cluster definition. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param properties: The resource properties to be updated. Required. + :type properties: JSON + :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 MongoCluster. The MongoCluster is compatible + with MutableMapping + :rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.MongoCluster] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 202 + response == { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "content_type", + "accept", + ] + }, + ) + def begin_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + properties: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.MongoCluster]: + # pylint: disable=line-too-long + """Updates an existing mongo cluster. The request body can contain one to many of the properties + present in the normal mongo cluster definition. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param properties: The resource properties to be updated. Required. + :type properties: 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 MongoCluster. The MongoCluster is compatible + with MutableMapping + :rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.MongoCluster] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 202 + response == { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @distributed_trace + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "content_type", + "accept", + ] + }, + ) + def begin_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + properties: Union[_models.MongoClusterUpdate, JSON, IO[bytes]], + **kwargs: Any + ) -> LROPoller[_models.MongoCluster]: + # pylint: disable=line-too-long + """Updates an existing mongo cluster. The request body can contain one to many of the properties + present in the normal mongo cluster definition. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param properties: The resource properties to be updated. Is one of the following types: + MongoClusterUpdate, JSON, IO[bytes] Required. + :type properties: ~azure.mgmt.mongocluster.models.MongoClusterUpdate or JSON or IO[bytes] + :return: An instance of LROPoller that returns MongoCluster. The MongoCluster is compatible + with MutableMapping + :rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.MongoCluster] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + properties = { + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "tags": { + "str": "str" # Optional. Resource tags. + } + } + + # response body for status code(s): 200, 202 + response == { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.MongoCluster] = 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._update_initial( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + properties=properties, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + response = pipeline_response.http_response + deserialized = _deserialize(_models.MongoCluster, response.json()) + 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.MongoCluster].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.MongoCluster]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @api_version_validation( + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "accept", + ] + }, + ) # pylint: disable=inconsistent-return-statements + def _delete_initial( # pylint: disable=inconsistent-return-statements + self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any + ) -> None: + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_mongo_clusters_delete_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + subscription_id=self._config.subscription_id, + api_version=self._config.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 [202, 204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, 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("int", response.headers.get("Retry-After")) + + if cls: + return cls(pipeline_response, None, response_headers) # type: ignore + + @distributed_trace + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "accept", + ] + }, + ) + def begin_delete(self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any) -> LROPoller[None]: + """Deletes a mongo cluster. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :return: An instance of LROPoller that returns None + :rtype: ~azure.core.polling.LROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + 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( # type: ignore + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + 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 + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={"2024-03-01-preview": ["api_version", "subscription_id", "resource_group_name", "accept"]}, + ) + def list_by_resource_group(self, resource_group_name: str, **kwargs: Any) -> Iterable["_models.MongoCluster"]: + # pylint: disable=line-too-long + """List all the mongo clusters in a given resource group. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :return: An iterator like instance of MongoCluster + :rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.mongocluster.models.MongoCluster] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.MongoCluster]] = kwargs.pop("cls", None) + + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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_mongo_clusters_list_by_resource_group_request( + resource_group_name=resource_group_name, + subscription_id=self._config.subscription_id, + api_version=self._config.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) + + return _request + + def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.MongoCluster], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") 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]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + @distributed_trace + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={"2024-03-01-preview": ["api_version", "subscription_id", "accept"]}, + ) + def list(self, **kwargs: Any) -> Iterable["_models.MongoCluster"]: + # pylint: disable=line-too-long + """List all the mongo clusters in a given subscription. + + :return: An iterator like instance of MongoCluster + :rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.mongocluster.models.MongoCluster] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "location": "str", # The geo-location where the resource lives. Required. + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "tags": { + "str": "str" # Optional. Resource tags. + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.MongoCluster]] = kwargs.pop("cls", None) + + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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_mongo_clusters_list_request( + subscription_id=self._config.subscription_id, + api_version=self._config.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) + + return _request + + def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.MongoCluster], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") 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]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + @distributed_trace + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "accept", + ] + }, + ) + def list_connection_strings( + self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any + ) -> _models.ListConnectionStringsResult: + """List mongo cluster connection strings. This includes the default connection string using + SCRAM-SHA-256, as well as other connection strings supported by the cluster. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :return: ListConnectionStringsResult. The ListConnectionStringsResult is compatible with + MutableMapping + :rtype: ~azure.mgmt.mongocluster.models.ListConnectionStringsResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "connectionStrings": [ + { + "connectionString": "str", # Optional. Value of the + connection string. + "description": "str" # Optional. Description of the + connection string. + } + ] + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.ListConnectionStringsResult] = kwargs.pop("cls", None) + + _request = build_mongo_clusters_list_connection_strings_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + subscription_id=self._config.subscription_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = kwargs.pop("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]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.ListConnectionStringsResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": ["api_version", "subscription_id", "location", "content_type", "accept"] + }, + ) + def check_name_availability( + self, + location: str, + body: _models.CheckNameAvailabilityRequest, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.CheckNameAvailabilityResponse: + # pylint: disable=line-too-long + """Check if mongo cluster name is available for use. + + :param location: The location name. Required. + :type location: str + :param body: The CheckAvailability request. Required. + :type body: ~azure.mgmt.mongocluster.models.CheckNameAvailabilityRequest + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: CheckNameAvailabilityResponse. The CheckNameAvailabilityResponse is compatible with + MutableMapping + :rtype: ~azure.mgmt.mongocluster.models.CheckNameAvailabilityResponse + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "name": "str", # Optional. The name of the resource for which availability + needs to be checked. + "type": "str" # Optional. The resource type. + } + + # response body for status code(s): 200 + response == { + "message": "str", # Optional. Detailed reason why the given name is not + available. + "nameAvailable": bool, # Optional. Indicates if the resource name is + available. + "reason": "str" # Optional. The reason why the given name is not available. + Known values are: "Invalid" and "AlreadyExists". + } + """ + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": ["api_version", "subscription_id", "location", "content_type", "accept"] + }, + ) + def check_name_availability( + self, location: str, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.CheckNameAvailabilityResponse: + # pylint: disable=line-too-long + """Check if mongo cluster name is available for use. + + :param location: The location name. Required. + :type location: str + :param body: The CheckAvailability request. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: CheckNameAvailabilityResponse. The CheckNameAvailabilityResponse is compatible with + MutableMapping + :rtype: ~azure.mgmt.mongocluster.models.CheckNameAvailabilityResponse + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "message": "str", # Optional. Detailed reason why the given name is not + available. + "nameAvailable": bool, # Optional. Indicates if the resource name is + available. + "reason": "str" # Optional. The reason why the given name is not available. + Known values are: "Invalid" and "AlreadyExists". + } + """ + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": ["api_version", "subscription_id", "location", "content_type", "accept"] + }, + ) + def check_name_availability( + self, location: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.CheckNameAvailabilityResponse: + # pylint: disable=line-too-long + """Check if mongo cluster name is available for use. + + :param location: The location name. Required. + :type location: str + :param body: The CheckAvailability request. Required. + :type body: 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: CheckNameAvailabilityResponse. The CheckNameAvailabilityResponse is compatible with + MutableMapping + :rtype: ~azure.mgmt.mongocluster.models.CheckNameAvailabilityResponse + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "message": "str", # Optional. Detailed reason why the given name is not + available. + "nameAvailable": bool, # Optional. Indicates if the resource name is + available. + "reason": "str" # Optional. The reason why the given name is not available. + Known values are: "Invalid" and "AlreadyExists". + } + """ + + @distributed_trace + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": ["api_version", "subscription_id", "location", "content_type", "accept"] + }, + ) + def check_name_availability( + self, location: str, body: Union[_models.CheckNameAvailabilityRequest, JSON, IO[bytes]], **kwargs: Any + ) -> _models.CheckNameAvailabilityResponse: + # pylint: disable=line-too-long + """Check if mongo cluster name is available for use. + + :param location: The location name. Required. + :type location: str + :param body: The CheckAvailability request. Is one of the following types: + CheckNameAvailabilityRequest, JSON, IO[bytes] Required. + :type body: ~azure.mgmt.mongocluster.models.CheckNameAvailabilityRequest or JSON or IO[bytes] + :return: CheckNameAvailabilityResponse. The CheckNameAvailabilityResponse is compatible with + MutableMapping + :rtype: ~azure.mgmt.mongocluster.models.CheckNameAvailabilityResponse + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "name": "str", # Optional. The name of the resource for which availability + needs to be checked. + "type": "str" # Optional. The resource type. + } + + # response body for status code(s): 200 + response == { + "message": "str", # Optional. Detailed reason why the given name is not + available. + "nameAvailable": bool, # Optional. Indicates if the resource name is + available. + "reason": "str" # Optional. The reason why the given name is not available. + Known values are: "Invalid" and "AlreadyExists". + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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 = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.CheckNameAvailabilityResponse] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_mongo_clusters_check_name_availability_request( + location=location, + subscription_id=self._config.subscription_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = kwargs.pop("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]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.CheckNameAvailabilityResponse, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def promote( # pylint: disable=inconsistent-return-statements + self, + resource_group_name: str, + mongo_cluster_name: str, + body: _models.PromoteReplicaRequest, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Promotes a replica mongo cluster to a primary role. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param body: The content of the action request. Required. + :type body: ~azure.mgmt.mongocluster.models.PromoteReplicaRequest + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "promoteOption": "str", # The promote option to apply to the operation. + Required. "Forced" + "mode": "str" # Optional. The mode to apply to the promote operation. Value + is optional and defalt value is 'Switchover'. "Switchover" + } + """ + + @overload + def promote( # pylint: disable=inconsistent-return-statements + self, + resource_group_name: str, + mongo_cluster_name: str, + body: JSON, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Promotes a replica mongo cluster to a primary role. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param body: The content of the action request. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def promote( # pylint: disable=inconsistent-return-statements + self, + resource_group_name: str, + mongo_cluster_name: str, + body: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Promotes a replica mongo cluster to a primary role. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param body: The content of the action request. Required. + :type body: 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: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def promote( # pylint: disable=inconsistent-return-statements + self, + resource_group_name: str, + mongo_cluster_name: str, + body: Union[_models.PromoteReplicaRequest, JSON, IO[bytes]], + **kwargs: Any + ) -> None: + # pylint: disable=line-too-long + """Promotes a replica mongo cluster to a primary role. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param body: The content of the action request. Is one of the following types: + PromoteReplicaRequest, JSON, IO[bytes] Required. + :type body: ~azure.mgmt.mongocluster.models.PromoteReplicaRequest or JSON or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "promoteOption": "str", # The promote option to apply to the operation. + Required. "Forced" + "mode": "str" # Optional. The mode to apply to the promote operation. Value + is optional and defalt value is 'Switchover'. "Switchover" + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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 = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_mongo_clusters_promote_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + subscription_id=self._config.subscription_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + 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]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + +class FirewallRulesOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.mgmt.mongocluster.MongoClusterMgmtClient`'s + :attr:`firewall_rules` attribute. + """ + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "firewall_rule_name", + "accept", + ] + }, + ) + def get( + self, resource_group_name: str, mongo_cluster_name: str, firewall_rule_name: str, **kwargs: Any + ) -> _models.FirewallRule: + # pylint: disable=line-too-long + """Gets information about a mongo cluster firewall rule. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :type firewall_rule_name: str + :return: FirewallRule. The FirewallRule is compatible with MutableMapping + :rtype: ~azure.mgmt.mongocluster.models.FirewallRule + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "endIpAddress": "str", # The end IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "startIpAddress": "str", # The start IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "provisioningState": "str" # Optional. The provisioning state of the + firewall rule. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.FirewallRule] = kwargs.pop("cls", None) + + _request = build_firewall_rules_get_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + firewall_rule_name=firewall_rule_name, + subscription_id=self._config.subscription_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = kwargs.pop("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]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.FirewallRule, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @api_version_validation( + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "firewall_rule_name", + "content_type", + "accept", + ] + }, + ) + def _create_or_update_initial( + self, + resource_group_name: str, + mongo_cluster_name: str, + firewall_rule_name: str, + resource: Union[_models.FirewallRule, JSON, IO[bytes]], + **kwargs: Any + ) -> Optional[JSON]: + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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 = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[Optional[JSON]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(resource, (IOBase, bytes)): + _content = resource + else: + _content = json.dumps(resource, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_firewall_rules_create_or_update_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + firewall_rule_name=firewall_rule_name, + subscription_id=self._config.subscription_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + 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, 201, 202]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + deserialized = None + response_headers = {} + if response.status_code == 200: + deserialized = _deserialize(JSON, response.json()) + + if response.status_code == 201: + deserialized = _deserialize(JSON, response.json()) + + if response.status_code == 202: + response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "firewall_rule_name", + "content_type", + "accept", + ] + }, + ) + def begin_create_or_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + firewall_rule_name: str, + resource: _models.FirewallRule, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.FirewallRule]: + # pylint: disable=line-too-long + """Creates a new firewall rule or updates an existing firewall rule on a mongo cluster. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :type firewall_rule_name: str + :param resource: Resource create parameters. Required. + :type resource: ~azure.mgmt.mongocluster.models.FirewallRule + :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 FirewallRule. The FirewallRule is compatible + with MutableMapping + :rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.FirewallRule] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "endIpAddress": "str", # The end IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "startIpAddress": "str", # The start IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "provisioningState": "str" # Optional. The provisioning state of the + firewall rule. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + + # response body for status code(s): 200, 201 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "endIpAddress": "str", # The end IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "startIpAddress": "str", # The start IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "provisioningState": "str" # Optional. The provisioning state of the + firewall rule. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "firewall_rule_name", + "content_type", + "accept", + ] + }, + ) + def begin_create_or_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + firewall_rule_name: str, + resource: JSON, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.FirewallRule]: + # pylint: disable=line-too-long + """Creates a new firewall rule or updates an existing firewall rule on a mongo cluster. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :type firewall_rule_name: str + :param resource: Resource create parameters. Required. + :type resource: JSON + :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 FirewallRule. The FirewallRule is compatible + with MutableMapping + :rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.FirewallRule] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "endIpAddress": "str", # The end IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "startIpAddress": "str", # The start IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "provisioningState": "str" # Optional. The provisioning state of the + firewall rule. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "firewall_rule_name", + "content_type", + "accept", + ] + }, + ) + def begin_create_or_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + firewall_rule_name: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.FirewallRule]: + # pylint: disable=line-too-long + """Creates a new firewall rule or updates an existing firewall rule on a mongo cluster. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :type firewall_rule_name: str + :param resource: Resource create parameters. Required. + :type resource: 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 FirewallRule. The FirewallRule is compatible + with MutableMapping + :rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.FirewallRule] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "endIpAddress": "str", # The end IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "startIpAddress": "str", # The start IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "provisioningState": "str" # Optional. The provisioning state of the + firewall rule. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @distributed_trace + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "firewall_rule_name", + "content_type", + "accept", + ] + }, + ) + def begin_create_or_update( + self, + resource_group_name: str, + mongo_cluster_name: str, + firewall_rule_name: str, + resource: Union[_models.FirewallRule, JSON, IO[bytes]], + **kwargs: Any + ) -> LROPoller[_models.FirewallRule]: + # pylint: disable=line-too-long + """Creates a new firewall rule or updates an existing firewall rule on a mongo cluster. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :type firewall_rule_name: str + :param resource: Resource create parameters. Is one of the following types: FirewallRule, JSON, + IO[bytes] Required. + :type resource: ~azure.mgmt.mongocluster.models.FirewallRule or JSON or IO[bytes] + :return: An instance of LROPoller that returns FirewallRule. The FirewallRule is compatible + with MutableMapping + :rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.FirewallRule] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "endIpAddress": "str", # The end IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "startIpAddress": "str", # The start IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "provisioningState": "str" # Optional. The provisioning state of the + firewall rule. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + + # response body for status code(s): 200, 201 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "endIpAddress": "str", # The end IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "startIpAddress": "str", # The start IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "provisioningState": "str" # Optional. The provisioning state of the + firewall rule. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + 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._create_or_update_initial( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + firewall_rule_name=firewall_rule_name, + resource=resource, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + response = pipeline_response.http_response + deserialized = _deserialize(_models.FirewallRule, response.json()) + 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.FirewallRule].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.FirewallRule]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @api_version_validation( + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "firewall_rule_name", + "accept", + ] + }, + ) # pylint: disable=inconsistent-return-statements + def _delete_initial( # pylint: disable=inconsistent-return-statements + self, resource_group_name: str, mongo_cluster_name: str, firewall_rule_name: str, **kwargs: Any + ) -> None: + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_firewall_rules_delete_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + firewall_rule_name=firewall_rule_name, + subscription_id=self._config.subscription_id, + api_version=self._config.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 [202, 204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, 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("int", response.headers.get("Retry-After")) + + if cls: + return cls(pipeline_response, None, response_headers) # type: ignore + + @distributed_trace + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "firewall_rule_name", + "accept", + ] + }, + ) + def begin_delete( + self, resource_group_name: str, mongo_cluster_name: str, firewall_rule_name: str, **kwargs: Any + ) -> LROPoller[None]: + """Deletes a mongo cluster firewall rule. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :type firewall_rule_name: str + :return: An instance of LROPoller that returns None + :rtype: ~azure.core.polling.LROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + 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( # type: ignore + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + firewall_rule_name=firewall_rule_name, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + 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 + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "accept", + ] + }, + ) + def list_by_mongo_cluster( + self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any + ) -> Iterable["_models.FirewallRule"]: + # pylint: disable=line-too-long + """List all the firewall rules in a given mongo cluster. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :return: An iterator like instance of FirewallRule + :rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.mongocluster.models.FirewallRule] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "endIpAddress": "str", # The end IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "startIpAddress": "str", # The start IP address of the mongo cluster + firewall rule. Must be IPv4 format. Required. + "provisioningState": "str" # Optional. The provisioning state of the + firewall rule. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.FirewallRule]] = kwargs.pop("cls", None) + + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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_firewall_rules_list_by_mongo_cluster_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + subscription_id=self._config.subscription_id, + api_version=self._config.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) + + return _request + + def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.FirewallRule], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") 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]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + +class PrivateEndpointConnectionsOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.mgmt.mongocluster.MongoClusterMgmtClient`'s + :attr:`private_endpoint_connections` attribute. + """ + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "accept", + ] + }, + ) + def list_by_mongo_cluster( + self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any + ) -> Iterable["_models.PrivateEndpointConnectionResource"]: + # pylint: disable=line-too-long + """List existing private connections. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :return: An iterator like instance of PrivateEndpointConnectionResource + :rtype: + ~azure.core.paging.ItemPaged[~azure.mgmt.mongocluster.models.PrivateEndpointConnectionResource] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # Optional. A message indicating + if changes on the service provider require any updates on the consumer. + "description": "str", # Optional. The reason for + approval/rejection of the connection. + "status": "str" # Optional. Indicates whether the connection + has been Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group identifiers for the private + endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource identifier for private + endpoint. + }, + "provisioningState": "str" # Optional. The provisioning state of the + private endpoint connection resource. Known values are: "Succeeded", + "Failed", "Canceled", "Creating", and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.PrivateEndpointConnectionResource]] = kwargs.pop("cls", None) + + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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_private_endpoint_connections_list_by_mongo_cluster_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + subscription_id=self._config.subscription_id, + api_version=self._config.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) + + return _request + + def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.PrivateEndpointConnectionResource], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") 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]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + @distributed_trace + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "private_endpoint_connection_name", + "accept", + ] + }, + ) + def get( + self, resource_group_name: str, mongo_cluster_name: str, private_endpoint_connection_name: str, **kwargs: Any + ) -> _models.PrivateEndpointConnectionResource: + # pylint: disable=line-too-long + """Get a specific private connection. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param private_endpoint_connection_name: The name of the private endpoint connection associated + with the Azure resource. Required. + :type private_endpoint_connection_name: str + :return: PrivateEndpointConnectionResource. The PrivateEndpointConnectionResource is compatible + with MutableMapping + :rtype: ~azure.mgmt.mongocluster.models.PrivateEndpointConnectionResource + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # Optional. A message indicating + if changes on the service provider require any updates on the consumer. + "description": "str", # Optional. The reason for + approval/rejection of the connection. + "status": "str" # Optional. Indicates whether the connection + has been Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group identifiers for the private + endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource identifier for private + endpoint. + }, + "provisioningState": "str" # Optional. The provisioning state of the + private endpoint connection resource. Known values are: "Succeeded", + "Failed", "Canceled", "Creating", and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.PrivateEndpointConnectionResource] = kwargs.pop("cls", None) + + _request = build_private_endpoint_connections_get_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + private_endpoint_connection_name=private_endpoint_connection_name, + subscription_id=self._config.subscription_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = kwargs.pop("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]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.PrivateEndpointConnectionResource, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @api_version_validation( + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "private_endpoint_connection_name", + "content_type", + "accept", + ] + }, + ) + def _create_initial( + self, + resource_group_name: str, + mongo_cluster_name: str, + private_endpoint_connection_name: str, + resource: Union[_models.PrivateEndpointConnectionResource, JSON, IO[bytes]], + **kwargs: Any + ) -> Optional[JSON]: + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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 = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[Optional[JSON]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(resource, (IOBase, bytes)): + _content = resource + else: + _content = json.dumps(resource, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_private_endpoint_connections_create_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + private_endpoint_connection_name=private_endpoint_connection_name, + subscription_id=self._config.subscription_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + 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, 201, 202]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + deserialized = None + response_headers = {} + if response.status_code == 200: + deserialized = _deserialize(JSON, response.json()) + + if response.status_code == 201: + deserialized = _deserialize(JSON, response.json()) + + if response.status_code == 202: + response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "private_endpoint_connection_name", + "content_type", + "accept", + ] + }, + ) + def begin_create( + self, + resource_group_name: str, + mongo_cluster_name: str, + private_endpoint_connection_name: str, + resource: _models.PrivateEndpointConnectionResource, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.PrivateEndpointConnectionResource]: + # pylint: disable=line-too-long + """Create a Private endpoint connection. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param private_endpoint_connection_name: The name of the private endpoint connection associated + with the Azure resource. Required. + :type private_endpoint_connection_name: str + :param resource: Resource create parameters. Required. + :type resource: ~azure.mgmt.mongocluster.models.PrivateEndpointConnectionResource + :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 PrivateEndpointConnectionResource. The + PrivateEndpointConnectionResource is compatible with MutableMapping + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.PrivateEndpointConnectionResource] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # Optional. A message indicating + if changes on the service provider require any updates on the consumer. + "description": "str", # Optional. The reason for + approval/rejection of the connection. + "status": "str" # Optional. Indicates whether the connection + has been Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group identifiers for the private + endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource identifier for private + endpoint. + }, + "provisioningState": "str" # Optional. The provisioning state of the + private endpoint connection resource. Known values are: "Succeeded", + "Failed", "Canceled", "Creating", and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + + # response body for status code(s): 200, 201 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # Optional. A message indicating + if changes on the service provider require any updates on the consumer. + "description": "str", # Optional. The reason for + approval/rejection of the connection. + "status": "str" # Optional. Indicates whether the connection + has been Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group identifiers for the private + endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource identifier for private + endpoint. + }, + "provisioningState": "str" # Optional. The provisioning state of the + private endpoint connection resource. Known values are: "Succeeded", + "Failed", "Canceled", "Creating", and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "private_endpoint_connection_name", + "content_type", + "accept", + ] + }, + ) + def begin_create( + self, + resource_group_name: str, + mongo_cluster_name: str, + private_endpoint_connection_name: str, + resource: JSON, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.PrivateEndpointConnectionResource]: + # pylint: disable=line-too-long + """Create a Private endpoint connection. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param private_endpoint_connection_name: The name of the private endpoint connection associated + with the Azure resource. Required. + :type private_endpoint_connection_name: str + :param resource: Resource create parameters. Required. + :type resource: JSON + :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 PrivateEndpointConnectionResource. The + PrivateEndpointConnectionResource is compatible with MutableMapping + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.PrivateEndpointConnectionResource] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # Optional. A message indicating + if changes on the service provider require any updates on the consumer. + "description": "str", # Optional. The reason for + approval/rejection of the connection. + "status": "str" # Optional. Indicates whether the connection + has been Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group identifiers for the private + endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource identifier for private + endpoint. + }, + "provisioningState": "str" # Optional. The provisioning state of the + private endpoint connection resource. Known values are: "Succeeded", + "Failed", "Canceled", "Creating", and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @overload + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "private_endpoint_connection_name", + "content_type", + "accept", + ] + }, + ) + def begin_create( + self, + resource_group_name: str, + mongo_cluster_name: str, + private_endpoint_connection_name: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.PrivateEndpointConnectionResource]: + # pylint: disable=line-too-long + """Create a Private endpoint connection. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param private_endpoint_connection_name: The name of the private endpoint connection associated + with the Azure resource. Required. + :type private_endpoint_connection_name: str + :param resource: Resource create parameters. Required. + :type resource: 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 PrivateEndpointConnectionResource. The + PrivateEndpointConnectionResource is compatible with MutableMapping + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.PrivateEndpointConnectionResource] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # Optional. A message indicating + if changes on the service provider require any updates on the consumer. + "description": "str", # Optional. The reason for + approval/rejection of the connection. + "status": "str" # Optional. Indicates whether the connection + has been Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group identifiers for the private + endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource identifier for private + endpoint. + }, + "provisioningState": "str" # Optional. The provisioning state of the + private endpoint connection resource. Known values are: "Succeeded", + "Failed", "Canceled", "Creating", and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + + @distributed_trace + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "private_endpoint_connection_name", + "content_type", + "accept", + ] + }, + ) + def begin_create( + self, + resource_group_name: str, + mongo_cluster_name: str, + private_endpoint_connection_name: str, + resource: Union[_models.PrivateEndpointConnectionResource, JSON, IO[bytes]], + **kwargs: Any + ) -> LROPoller[_models.PrivateEndpointConnectionResource]: + # pylint: disable=line-too-long + """Create a Private endpoint connection. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param private_endpoint_connection_name: The name of the private endpoint connection associated + with the Azure resource. Required. + :type private_endpoint_connection_name: str + :param resource: Resource create parameters. Is one of the following types: + PrivateEndpointConnectionResource, JSON, IO[bytes] Required. + :type resource: ~azure.mgmt.mongocluster.models.PrivateEndpointConnectionResource or JSON or + IO[bytes] + :return: An instance of LROPoller that returns PrivateEndpointConnectionResource. The + PrivateEndpointConnectionResource is compatible with MutableMapping + :rtype: + ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.PrivateEndpointConnectionResource] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + resource = { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # Optional. A message indicating + if changes on the service provider require any updates on the consumer. + "description": "str", # Optional. The reason for + approval/rejection of the connection. + "status": "str" # Optional. Indicates whether the connection + has been Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group identifiers for the private + endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource identifier for private + endpoint. + }, + "provisioningState": "str" # Optional. The provisioning state of the + private endpoint connection resource. Known values are: "Succeeded", + "Failed", "Canceled", "Creating", and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + + # response body for status code(s): 200, 201 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # Optional. A message indicating + if changes on the service provider require any updates on the consumer. + "description": "str", # Optional. The reason for + approval/rejection of the connection. + "status": "str" # Optional. Indicates whether the connection + has been Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group identifiers for the private + endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource identifier for private + endpoint. + }, + "provisioningState": "str" # Optional. The provisioning state of the + private endpoint connection resource. Known values are: "Succeeded", + "Failed", "Canceled", "Creating", and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + 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._create_initial( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + private_endpoint_connection_name=private_endpoint_connection_name, + resource=resource, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + response = pipeline_response.http_response + deserialized = _deserialize(_models.PrivateEndpointConnectionResource, response.json()) + 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.PrivateEndpointConnectionResource].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.PrivateEndpointConnectionResource]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @api_version_validation( + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "private_endpoint_connection_name", + "accept", + ] + }, + ) # pylint: disable=inconsistent-return-statements + def _delete_initial( # pylint: disable=inconsistent-return-statements + self, resource_group_name: str, mongo_cluster_name: str, private_endpoint_connection_name: str, **kwargs: Any + ) -> None: + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_private_endpoint_connections_delete_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + private_endpoint_connection_name=private_endpoint_connection_name, + subscription_id=self._config.subscription_id, + api_version=self._config.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 [202, 204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, 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("int", response.headers.get("Retry-After")) + + if cls: + return cls(pipeline_response, None, response_headers) # type: ignore + + @distributed_trace + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "private_endpoint_connection_name", + "accept", + ] + }, + ) + def begin_delete( + self, resource_group_name: str, mongo_cluster_name: str, private_endpoint_connection_name: str, **kwargs: Any + ) -> LROPoller[None]: + """Delete the private endpoint connection. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :param private_endpoint_connection_name: The name of the private endpoint connection associated + with the Azure resource. Required. + :type private_endpoint_connection_name: str + :return: An instance of LROPoller that returns None + :rtype: ~azure.core.polling.LROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + 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( # type: ignore + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + private_endpoint_connection_name=private_endpoint_connection_name, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + 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 + + +class PrivateLinksOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.mgmt.mongocluster.MongoClusterMgmtClient`'s + :attr:`private_links` attribute. + """ + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace + @api_version_validation( + method_added_on="2024-03-01-preview", + params_added_on={ + "2024-03-01-preview": [ + "api_version", + "subscription_id", + "resource_group_name", + "mongo_cluster_name", + "accept", + ] + }, + ) + def list_by_mongo_cluster( + self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any + ) -> Iterable["_models.PrivateLinkResource"]: + # pylint: disable=line-too-long + """list private links on the given resource. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :return: An iterator like instance of PrivateLinkResource + :rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.mongocluster.models.PrivateLinkResource] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "groupId": "str", # Optional. The private link resource group id. + "requiredMembers": [ + "str" # Optional. The private link resource required member + names. + ], + "requiredZoneNames": [ + "str" # Optional. The private link resource private link DNS + zone name. + ] + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.PrivateLinkResource]] = kwargs.pop("cls", None) + + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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_private_links_list_by_mongo_cluster_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + subscription_id=self._config.subscription_id, + api_version=self._config.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) + + return _request + + def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.PrivateLinkResource], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") 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]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + +class ReplicasOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.mgmt.mongocluster.MongoClusterMgmtClient`'s + :attr:`replicas` attribute. + """ + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace + def list_by_mongo_cluster( + self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any + ) -> Iterable["_models.Replica"]: + # pylint: disable=line-too-long + """List all the replicas for the mongo cluster. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param mongo_cluster_name: The name of the mongo cluster. Required. + :type mongo_cluster_name: str + :return: An iterator like instance of Replica + :rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.mongocluster.models.Replica] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "id": "str", # Optional. Fully qualified resource ID for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "administratorLogin": "str", # Optional. The administrator's login + for the mongo cluster. + "administratorLoginPassword": "str", # Optional. The password of the + administrator login. + "clusterStatus": "str", # Optional. The status of the mongo cluster. + Known values are: "Ready", "Provisioning", "Updating", "Starting", + "Stopping", "Stopped", and "Dropping". + "connectionString": "str", # Optional. The default mongo connection + string for the cluster. + "createMode": "str", # Optional. The mode to create a mongo cluster. + Known values are: "Default", "PointInTimeRestore", "GeoReplica", and + "Replica". + "earliestRestoreTime": "str", # Optional. Earliest restore timestamp + in UTC ISO8601 format. + "infrastructureVersion": "str", # Optional. The infrastructure + version the cluster is provisioned on. + "nodeGroupSpecs": [ + { + "diskSizeGB": 0, # Optional. The disk storage size + for the node group in GB. Example values: 128, 256, 512, 1024. + "enableHa": bool, # Optional. Whether high + availability is enabled on the node group. + "kind": "str", # Optional. The node type deployed in + the node group. "Shard" + "nodeCount": 0, # Optional. The number of nodes in + the node group. + "sku": "str" # Optional. The resource sku for the + node group. This defines the size of CPU and memory that is + provisioned for each node. Example values: 'M30', 'M40'. + } + ], + "previewFeatures": [ + "str" # Optional. List of private endpoint connections. + ], + "privateEndpointConnections": [ + { + "id": "str", # Optional. Fully qualified resource ID + for the resource. Ex - + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. + "name": "str", # Optional. The name of the resource. + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "str", # + Optional. A message indicating if changes on the service + provider require any updates on the consumer. + "description": "str", # Optional. + The reason for approval/rejection of the connection. + "status": "str" # Optional. + Indicates whether the connection has been + Approved/Rejected/Removed by the owner of the service. Known + values are: "Pending", "Approved", and "Rejected". + }, + "groupIds": [ + "str" # Optional. The group + identifiers for the private endpoint resource. + ], + "privateEndpoint": { + "id": "str" # Optional. The resource + identifier for private endpoint. + }, + "provisioningState": "str" # Optional. The + provisioning state of the private endpoint connection resource. + Known values are: "Succeeded", "Failed", "Canceled", "Creating", + and "Deleting". + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The + type of identity that created the resource. + "createdBy": "str", # Optional. The identity + that created the resource. + "createdByType": "str", # Optional. The type + of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. + The timestamp of resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The + identity that last modified the resource. + "lastModifiedByType": "str" # Optional. The + type of identity that last modified the resource. Known values + are: "User", "Application", "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. + E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". + } + ], + "provisioningState": "str", # Optional. The provisioning state of + the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", + "InProgress", "Updating", and "Dropping". + "publicNetworkAccess": "str", # Optional. Whether or not public + endpoint access is allowed for this mongo cluster. Known values are: + "Enabled" and "Disabled". + "replica": { + "role": "str", # Optional. The replication role of the + cluster. Known values are: "Primary", "AsyncReplica", and + "GeoAsyncReplica". + "sourceResourceId": "str", # Optional. The resource id the + source cluster for the replica cluster. + "state": "str" # Optional. The replication link state of the + replica cluster. Known values are: "Active", "Catchup", "Provisioning", + "Updating", "Broken", and "Reconfiguring". + }, + "replicaParameters": { + "location": "str", # Description of the connection string. + Required. + "sourceResourceId": "str" # The id of the replication source + cluster. Required. + }, + "restoreParameters": { + "pointInTimeUTC": "2020-02-20 00:00:00", # Optional. UTC + point in time to restore a mongo cluster. + "sourceResourceId": "str" # Optional. Resource ID to locate + the source cluster to restore. + }, + "serverVersion": "str" # Optional. The Mongo DB server version. + Defaults to the latest available version if not specified. + }, + "systemData": { + "createdAt": "2020-02-20", # Optional. The type of identity that + created the resource. + "createdBy": "str", # Optional. The identity that created the + resource. + "createdByType": "str", # Optional. The type of identity that + created the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + "lastModifiedAt": "2020-02-20", # Optional. The timestamp of + resource last modification (UTC). + "lastModifiedBy": "str", # Optional. The identity that last modified + the resource. + "lastModifiedByType": "str" # Optional. The type of identity that + last modified the resource. Known values are: "User", "Application", + "ManagedIdentity", and "Key". + }, + "type": "str" # Optional. The type of the resource. E.g. + "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.Replica]] = kwargs.pop("cls", None) + + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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_replicas_list_by_mongo_cluster_request( + resource_group_name=resource_group_name, + mongo_cluster_name=mongo_cluster_name, + subscription_id=self._config.subscription_id, + api_version=self._config.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) + + return _request + + def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.Replica], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") 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]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + return pipeline_response + + return ItemPaged(get_next, extract_data) diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/operations/_patch.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/operations/_patch.py new file mode 100644 index 0000000000000..f7dd32510333d --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""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/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/py.typed b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/py.typed new file mode 100644 index 0000000000000..e5aff4f83af86 --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/dev_requirements.txt b/sdk/mongocluster/azure-mgmt-mongocluster/dev_requirements.txt new file mode 100644 index 0000000000000..05b9717a94f4c --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/dev_requirements.txt @@ -0,0 +1,5 @@ +-e ../../../tools/azure-sdk-tools +../../core/azure-core +../../identity/azure-identity +../../core/azure-mgmt-core +aiohttp \ No newline at end of file diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/sdk_packaging.toml b/sdk/mongocluster/azure-mgmt-mongocluster/sdk_packaging.toml new file mode 100644 index 0000000000000..dcfb9dcb79e76 --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/sdk_packaging.toml @@ -0,0 +1,11 @@ +[packaging] +package_name = "azure-mgmt-mongocluster" +package_nspkg = "azure-mgmt-nspkg" +package_pprint_name = "MyService Management" +package_doc_id = "" +is_stable = false +is_arm = true +need_msrestazure = false +need_azuremgmtcore = true +sample_link = "" +exclude_folders = "" diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/setup.py b/sdk/mongocluster/azure-mgmt-mongocluster/setup.py new file mode 100644 index 0000000000000..b272eda734312 --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/setup.py @@ -0,0 +1,82 @@ +#!/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-mongocluster" +PACKAGE_PPRINT_NAME = "MyService 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 :: 4 - Beta", + "Programming Language :: Python", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.8", + "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", + ] + ), + include_package_data=True, + package_data={ + "pytyped": ["py.typed"], + }, + install_requires=[ + "isodate>=0.6.1", + "azure-common>=1.1", + "azure-mgmt-core>=1.3.2", + ], + python_requires=">=3.8", +) diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/tsp-location.yaml b/sdk/mongocluster/azure-mgmt-mongocluster/tsp-location.yaml new file mode 100644 index 0000000000000..74e1ad1d367e0 --- /dev/null +++ b/sdk/mongocluster/azure-mgmt-mongocluster/tsp-location.yaml @@ -0,0 +1,4 @@ +directory: specification/mongocluster/DocumentDB.MongoCluster.Management +commit: 1e830c2bf5e944abb147e05549d83cfec632aebf +repo: Azure/azure-rest-api-specs +additionalDirectories: diff --git a/sdk/mongocluster/ci.yml b/sdk/mongocluster/ci.yml new file mode 100644 index 0000000000000..f8b3d9915e169 --- /dev/null +++ b/sdk/mongocluster/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/mongocluster/ + +pr: + branches: + include: + - main + - feature/* + - hotfix/* + - release/* + - restapi* + paths: + include: + - sdk/mongocluster/ + +extends: + template: ../../eng/pipelines/templates/stages/archetype-sdk-client.yml + parameters: + ServiceDirectory: mongocluster + TestProxy: true + Artifacts: + - name: azure-mgmt-mongocluster + safeName: azuremgmtmongocluster