diff --git a/sdk/portal/azure-mgmt-portal/README.md b/sdk/portal/azure-mgmt-portal/README.md index 0ec1a56eb268..380da7e33cad 100644 --- a/sdk/portal/azure-mgmt-portal/README.md +++ b/sdk/portal/azure-mgmt-portal/README.md @@ -1,28 +1,61 @@ # Microsoft Azure SDK for Python This is the Microsoft Azure Portal Management Client Library. -This package has been tested with Python 3.7+. +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_ -# Usage +## Getting started +### Prerequisites -To learn how to use this package, see the [quickstart guide](https://aka.ms/azsdk/python/mgmt) - -For docs and references, see [Python SDK References](https://docs.microsoft.com/python/api/overview/azure/) -Code samples for this package can be found at [Portal Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com. -Additional code samples for different Azure services are available at [Samples Repo](https://aka.ms/azsdk/python/mgmt/samples) +- Python 3.8+ is required to use this package. +- [Azure subscription](https://azure.microsoft.com/free/) +### Install the package -# Provide Feedback +```bash +pip install azure-mgmt-portal +pip install azure-identity +``` -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. +### 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.portal import Portal +import os +sub_id = os.getenv("AZURE_SUBSCRIPTION_ID") +client = Portal(credential=DefaultAzureCredential(), subscription_id=sub_id) +``` +## Examples +Code samples for this package can be found at: +- [Search Portal 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/portal/azure-mgmt-portal/_meta.json b/sdk/portal/azure-mgmt-portal/_meta.json index 0ba9c60d4d23..4c081d205939 100644 --- a/sdk/portal/azure-mgmt-portal/_meta.json +++ b/sdk/portal/azure-mgmt-portal/_meta.json @@ -1,11 +1,11 @@ { - "commit": "4522e1d3fb6dcb81bc63e3414d11dd7eaf08264b", + "commit": "b2a11d88e191a41f7d5c741d373f3574739535ff", "repository_url": "https://github.com/Azure/azure-rest-api-specs", - "autorest": "3.9.2", + "autorest": "3.10.2", "use": [ - "@autorest/python@6.2.1", - "@autorest/modelerfour@4.24.3" + "@autorest/python@6.27.4", + "@autorest/modelerfour@4.27.0" ], - "autorest_command": "autorest specification/portal/resource-manager/readme.md --generate-sample=True --include-x-ms-examples-original-file=True --python --python-sdks-folder=/home/vsts/work/1/azure-sdk-for-python/sdk --use=@autorest/python@6.2.1 --use=@autorest/modelerfour@4.24.3 --version=3.9.2 --version-tolerant=False", + "autorest_command": "autorest specification/portal/resource-manager/readme.md --generate-sample=True --generate-test=True --include-x-ms-examples-original-file=True --python --python-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-python/sdk --use=@autorest/python@6.27.4 --use=@autorest/modelerfour@4.27.0 --version=3.10.2 --version-tolerant=False", "readme": "specification/portal/resource-manager/readme.md" } \ No newline at end of file diff --git a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/__init__.py b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/__init__.py index a854c95a44b5..0679e883f910 100644 --- a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/__init__.py +++ b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/__init__.py @@ -5,15 +5,21 @@ # Code generated by Microsoft (R) AutoRest Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._portal import Portal +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._portal import Portal # type: ignore from ._version import VERSION __version__ = VERSION try: from ._patch import __all__ as _patch_all - from ._patch import * # type: ignore # pylint: disable=unused-wildcard-import + from ._patch import * except ImportError: _patch_all = [] from ._patch import patch_sdk as _patch_sdk @@ -21,6 +27,6 @@ __all__ = [ "Portal", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/_configuration.py b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/_configuration.py index 541c14eb8b9c..9ac202ba80f8 100644 --- a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/_configuration.py +++ b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/_configuration.py @@ -6,26 +6,18 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -import sys from typing import Any, TYPE_CHECKING -from azure.core.configuration import Configuration from azure.core.pipeline import policies from azure.mgmt.core.policies import ARMChallengeAuthenticationPolicy, ARMHttpLoggingPolicy from ._version import VERSION -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports -else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports - if TYPE_CHECKING: - # pylint: disable=unused-import,ungrouped-imports from azure.core.credentials import TokenCredential -class PortalConfiguration(Configuration): # pylint: disable=too-many-instance-attributes +class PortalConfiguration: # pylint: disable=too-many-instance-attributes """Configuration for Portal. Note that all parameters used to create this instance are saved as instance @@ -33,17 +25,15 @@ class PortalConfiguration(Configuration): # pylint: disable=too-many-instance-a :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials.TokenCredential - :param subscription_id: The Azure subscription ID. This is a GUID-formatted string (e.g. - 00000000-0000-0000-0000-000000000000). Required. + :param subscription_id: The ID of the target subscription. The value must be an UUID. Required. :type subscription_id: str - :keyword api_version: Api Version. Default value is "2020-09-01-preview". Note that overriding + :keyword api_version: Api Version. Default value is "2025-04-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: - super(PortalConfiguration, self).__init__(**kwargs) - api_version = kwargs.pop("api_version", "2020-09-01-preview") # type: Literal["2020-09-01-preview"] + api_version: str = kwargs.pop("api_version", "2025-04-01-preview") if credential is None: raise ValueError("Parameter 'credential' must not be None.") @@ -55,20 +45,18 @@ def __init__(self, credential: "TokenCredential", subscription_id: str, **kwargs self.api_version = api_version self.credential_scopes = kwargs.pop("credential_scopes", ["https://management.azure.com/.default"]) kwargs.setdefault("sdk_moniker", "mgmt-portal/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) self._configure(**kwargs) - def _configure( - self, **kwargs # type: Any - ): - # type: (...) -> None + 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.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**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( diff --git a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/_portal.py b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/_portal.py index 1c085a2caa1d..353be2f3f5e1 100644 --- a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/_portal.py +++ b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/_portal.py @@ -8,11 +8,14 @@ from copy import deepcopy from typing import Any, TYPE_CHECKING +from typing_extensions import Self +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 . import models +from . import models as _models from ._configuration import PortalConfiguration from ._serialization import Deserializer, Serializer from .operations import ( @@ -23,31 +26,29 @@ ) if TYPE_CHECKING: - # pylint: disable=unused-import,ungrouped-imports from azure.core.credentials import TokenCredential -class Portal: # pylint: disable=client-accepts-api-version-keyword +class Portal: """Allows creation and deletion of Azure Shared Dashboards. :ivar operations: Operations operations :vartype operations: azure.mgmt.portal.operations.Operations :ivar dashboards: DashboardsOperations operations :vartype dashboards: azure.mgmt.portal.operations.DashboardsOperations - :ivar tenant_configurations: TenantConfigurationsOperations operations - :vartype tenant_configurations: azure.mgmt.portal.operations.TenantConfigurationsOperations :ivar list_tenant_configuration_violations: ListTenantConfigurationViolationsOperations operations :vartype list_tenant_configuration_violations: azure.mgmt.portal.operations.ListTenantConfigurationViolationsOperations + :ivar tenant_configurations: TenantConfigurationsOperations operations + :vartype tenant_configurations: azure.mgmt.portal.operations.TenantConfigurationsOperations :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials.TokenCredential - :param subscription_id: The Azure subscription ID. This is a GUID-formatted string (e.g. - 00000000-0000-0000-0000-000000000000). Required. + :param subscription_id: The ID of the target subscription. The value must be an UUID. Required. :type subscription_id: str :param base_url: Service URL. Default value is "https://management.azure.com". :type base_url: str - :keyword api_version: Api Version. Default value is "2020-09-01-preview". Note that overriding + :keyword api_version: Api Version. Default value is "2025-04-01-preview". Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ @@ -60,22 +61,40 @@ def __init__( **kwargs: Any ) -> None: self._config = PortalConfiguration(credential=credential, subscription_id=subscription_id, **kwargs) - self._client = ARMPipelineClient(base_url=base_url, config=self._config, **kwargs) - - client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} + _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) + + client_models = {k: v for k, v in _models.__dict__.items() if isinstance(v, type)} self._serialize = Serializer(client_models) self._deserialize = Deserializer(client_models) self._serialize.client_side_validation = False self.operations = Operations(self._client, self._config, self._serialize, self._deserialize) self.dashboards = DashboardsOperations(self._client, self._config, self._serialize, self._deserialize) - self.tenant_configurations = TenantConfigurationsOperations( + self.list_tenant_configuration_violations = ListTenantConfigurationViolationsOperations( self._client, self._config, self._serialize, self._deserialize ) - self.list_tenant_configuration_violations = ListTenantConfigurationViolationsOperations( + self.tenant_configurations = TenantConfigurationsOperations( self._client, self._config, self._serialize, self._deserialize ) - def _send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse: + 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 @@ -95,17 +114,14 @@ def _send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse: request_copy = deepcopy(request) request_copy.url = self._client.format_url(request_copy.url) - return self._client.send_request(request_copy, **kwargs) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore - def close(self): - # type: () -> None + def close(self) -> None: self._client.close() - def __enter__(self): - # type: () -> Portal + def __enter__(self) -> Self: self._client.__enter__() return self - def __exit__(self, *exc_details): - # type: (Any) -> None + def __exit__(self, *exc_details: Any) -> None: self._client.__exit__(*exc_details) diff --git a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/_serialization.py b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/_serialization.py index 7c1dedb5133d..b24ab2885450 100644 --- a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/_serialization.py +++ b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/_serialization.py @@ -1,3 +1,4 @@ +# pylint: disable=too-many-lines # -------------------------------------------------------------------------- # # Copyright (c) Microsoft Corporation. All rights reserved. @@ -24,7 +25,7 @@ # # -------------------------------------------------------------------------- -# pylint: skip-file +# pyright: reportUnnecessaryTypeIgnoreComment=false from base64 import b64decode, b64encode import calendar @@ -37,23 +38,37 @@ import re import sys import codecs +from typing import ( + Dict, + Any, + cast, + Optional, + Union, + AnyStr, + IO, + Mapping, + Callable, + TypeVar, + MutableMapping, + Type, + List, +) try: from urllib import quote # type: ignore except ImportError: - from urllib.parse import quote # type: ignore + from urllib.parse import quote import xml.etree.ElementTree as ET -import isodate +import isodate # type: ignore -from typing import Dict, Any, cast, TYPE_CHECKING - -from azure.core.exceptions import DeserializationError, SerializationError, raise_with_traceback +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull _BOM = codecs.BOM_UTF8.decode(encoding="utf-8") -if TYPE_CHECKING: - from typing import Optional, Union, AnyStr, IO, Mapping +ModelType = TypeVar("ModelType", bound="Model") +JSON = MutableMapping[str, Any] class RawDeserializer: @@ -65,8 +80,7 @@ class RawDeserializer: CONTEXT_NAME = "deserialized_data" @classmethod - def deserialize_from_text(cls, data, content_type=None): - # type: (Optional[Union[AnyStr, IO]], Optional[str]) -> Any + 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. @@ -76,6 +90,8 @@ def deserialize_from_text(cls, data, content_type=None): :param data: Input, could be bytes or stream (will be decoded with UTF8) or text :type data: str or bytes or IO :param str content_type: The content type. + :return: The deserialized data. + :rtype: object """ if hasattr(data, "read"): # Assume a stream @@ -97,7 +113,7 @@ def deserialize_from_text(cls, data, content_type=None): try: return json.loads(data_as_str) except ValueError as err: - raise DeserializationError("JSON is invalid: {}".format(err), err) + raise DeserializationError("JSON is invalid: {}".format(err), err) from err elif "xml" in (content_type or []): try: @@ -109,7 +125,7 @@ def deserialize_from_text(cls, data, content_type=None): pass return ET.fromstring(data_as_str) # nosec - except ET.ParseError: + 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 @@ -128,17 +144,23 @@ def _json_attemp(data): # The function hack is because Py2.7 messes up with exception # context otherwise. _LOGGER.critical("Wasn't XML not JSON, failing") - raise_with_traceback(DeserializationError, "XML is invalid") + raise DeserializationError("XML is invalid") from err + elif content_type.startswith("text/"): + return data_as_str raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) @classmethod - def deserialize_from_http_generics(cls, body_bytes, headers): - # type: (Optional[Union[AnyStr, IO]], Mapping) -> Any + def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], headers: Mapping) -> Any: """Deserialize from HTTP response. Use bytes and headers to NOT use any requests/aiohttp or whatever specific implementation. Headers will tested for "content-type" + + :param bytes body_bytes: The body of the response. + :param dict headers: The headers of the response. + :returns: The deserialized data. + :rtype: object """ # Try to use content-type from headers if available content_type = None @@ -156,13 +178,6 @@ def deserialize_from_http_generics(cls, body_bytes, headers): return None -try: - basestring # type: ignore - unicode_str = unicode # type: ignore -except NameError: - basestring = str # type: ignore - unicode_str = str # type: ignore - _LOGGER = logging.getLogger(__name__) try: @@ -175,20 +190,35 @@ class UTC(datetime.tzinfo): """Time Zone info for handling UTC""" def utcoffset(self, dt): - """UTF offset for UTC is 0.""" + """UTF offset for UTC is 0. + + :param datetime.datetime dt: The datetime + :returns: The offset + :rtype: datetime.timedelta + """ return datetime.timedelta(0) def tzname(self, dt): - """Timestamp representation.""" + """Timestamp representation. + + :param datetime.datetime dt: The datetime + :returns: The timestamp representation + :rtype: str + """ return "Z" def dst(self, dt): - """No daylight saving for UTC.""" + """No daylight saving for UTC. + + :param datetime.datetime dt: The datetime + :returns: The daylight saving time + :rtype: datetime.timedelta + """ return datetime.timedelta(hours=1) try: - from datetime import timezone as _FixedOffset + from datetime import timezone as _FixedOffset # type: ignore except ImportError: # Python 2.7 class _FixedOffset(datetime.tzinfo): # type: ignore @@ -197,7 +227,7 @@ class _FixedOffset(datetime.tzinfo): # type: ignore :param datetime.timedelta offset: offset in timedelta format """ - def __init__(self, offset): + def __init__(self, offset) -> None: self.__offset = offset def utcoffset(self, dt): @@ -219,31 +249,33 @@ def __getinitargs__(self): try: from datetime import timezone - TZ_UTC = timezone.utc # type: ignore + 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: # pylint: disable=consider-using-dict-items if k not in self._attribute_map: _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) elif k in self._validation and self._validation[k].get("readonly", False): @@ -290,43 +329,57 @@ def __init__(self, **kwargs): else: setattr(self, k, kwargs[k]) - def __eq__(self, other): - """Compare objects by comparing all attributes.""" + def __eq__(self, other: Any) -> bool: + """Compare objects by comparing all attributes. + + :param object other: The object to compare + :returns: True if objects are equal + :rtype: bool + """ if isinstance(other, self.__class__): return self.__dict__ == other.__dict__ return False - def __ne__(self, other): - """Compare objects by comparing all attributes.""" + def __ne__(self, other: Any) -> bool: + """Compare objects by comparing all attributes. + + :param object other: The object to compare + :returns: True if objects are not equal + :rtype: bool + """ return not self.__eq__(other) - def __str__(self): + def __str__(self) -> str: return str(self.__dict__) @classmethod - def enable_additional_properties_sending(cls): + def enable_additional_properties_sending(cls) -> None: cls._attribute_map["additional_properties"] = {"key": "", "type": "{object}"} @classmethod - def is_xml_model(cls): + def is_xml_model(cls) -> bool: try: - cls._xml_map + cls._xml_map # type: ignore except AttributeError: return False return True @classmethod def _create_xml_node(cls): - """Create XML node.""" + """Create XML node. + + :returns: The XML node + :rtype: xml.etree.ElementTree.Element + """ try: - xml_map = cls._xml_map + 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=False, **kwargs): - """Return the JSON that would be sent to azure from this model. + 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)`. @@ -337,10 +390,17 @@ def serialize(self, keep_readonly=False, **kwargs): :rtype: dict """ serializer = Serializer(self._infer_class_models()) - return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, keep_readonly=keep_readonly, **kwargs + ) - def as_dict(self, keep_readonly=True, key_transformer=attribute_transformer, **kwargs): - """Return a dict that can be JSONify using json.dump. + 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: @@ -366,12 +426,15 @@ def my_key_transformer(key, attr_desc, value): If you want XML serialization, you can pass the kwargs is_xml=True. + :param bool keep_readonly: If you want to serialize the readonly attributes :param function key_transformer: A key transformer function. :returns: A dict JSON compatible object :rtype: dict """ serializer = Serializer(self._infer_class_models()) - return serializer._serialize(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs + ) @classmethod def _infer_class_models(cls): @@ -381,25 +444,31 @@ def _infer_class_models(cls): 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: + except Exception: # pylint: disable=broad-exception-caught # Assume it's not Autorest generated (tests?). Add ourselves as dependencies. client_models = {cls.__name__: cls} return client_models @classmethod - def deserialize(cls, data, content_type=None): + 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 + :rtype: ModelType """ deserializer = Deserializer(cls._infer_class_models()) - return deserializer(cls.__name__, data, content_type=content_type) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore @classmethod - def from_dict(cls, data, key_extractors=None, content_type=None): + 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 @@ -407,13 +476,15 @@ def from_dict(cls, data, key_extractors=None, content_type=None): and last_rest_key_case_insensitive_extractor) :param dict data: A dict using RestAPI structure + :param function key_extractors: A key extractor function. :param str content_type: JSON by default, set application/xml if XML. :returns: An instance of this model :raises: DeserializationError if something went wrong + :rtype: ModelType """ deserializer = Deserializer(cls._infer_class_models()) - deserializer.key_extractors = ( - [ + deserializer.key_extractors = ( # type: ignore + [ # type: ignore attribute_key_case_insensitive_extractor, rest_key_case_insensitive_extractor, last_rest_key_case_insensitive_extractor, @@ -421,7 +492,7 @@ def from_dict(cls, data, key_extractors=None, content_type=None): if key_extractors is None else key_extractors ) - return deserializer(cls.__name__, data, content_type=content_type) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore @classmethod def _flatten_subtype(cls, key, objects): @@ -429,21 +500,25 @@ def _flatten_subtype(cls, key, objects): return {} result = dict(cls._subtype_map[key]) for valuetype in cls._subtype_map[key].values(): - result.update(objects[valuetype]._flatten_subtype(key, objects)) + result.update(objects[valuetype]._flatten_subtype(key, objects)) # pylint: disable=protected-access return result @classmethod def _classify(cls, response, objects): """Check the class _subtype_map for any child classes. We want to ignore any inherited _subtype_maps. - Remove the polymorphic key from the initial data. + + :param dict response: The initial data + :param dict objects: The class objects + :returns: The class to be used + :rtype: class """ for subtype_key in cls.__dict__.get("_subtype_map", {}).keys(): subtype_value = None if not isinstance(response, ET.Element): rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1] - subtype_value = response.pop(rest_api_response_key, None) or response.pop(subtype_key, None) + subtype_value = response.get(rest_api_response_key, None) or response.get(subtype_key, None) else: subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response) if subtype_value: @@ -453,7 +528,7 @@ def _classify(cls, response, objects): return cls flatten_mapping_type = cls._flatten_subtype(subtype_key, objects) try: - return objects[flatten_mapping_type[subtype_value]] + return objects[flatten_mapping_type[subtype_value]] # type: ignore except KeyError: _LOGGER.warning( "Subtype value %s has no mapping, use base class %s.", @@ -482,11 +557,13 @@ def _decode_attribute_map_key(key): inside the received data. :param str key: A key string from the generated code + :returns: The decoded key + :rtype: str """ return key.replace("\\.", ".") -class Serializer(object): +class Serializer: # pylint: disable=too-many-public-methods """Request object model serializer.""" basic_types = {str: "str", int: "int", bool: "bool", float: "float"} @@ -521,7 +598,7 @@ class Serializer(object): "multiple": lambda x, y: x % y != 0, } - def __init__(self, classes=None): + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: self.serialize_type = { "iso-8601": Serializer.serialize_iso, "rfc-1123": Serializer.serialize_rfc, @@ -537,17 +614,20 @@ def __init__(self, classes=None): "[]": self.serialize_iter, "{}": self.serialize_dict, } - self.dependencies = dict(classes) if classes else {} + 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): + def _serialize( # pylint: disable=too-many-nested-blocks, too-many-branches, too-many-statements, too-many-locals + self, target_obj, data_type=None, **kwargs + ): """Serialize data into a string according to type. - :param target_obj: The data to be serialized. + :param object target_obj: The data to be serialized. :param str data_type: The type to be serialized from. :rtype: str, dict :raises: SerializationError if serialization fails. + :returns: The serialized data. """ key_transformer = kwargs.get("key_transformer", self.key_transformer) keep_readonly = kwargs.get("keep_readonly", False) @@ -573,12 +653,14 @@ def _serialize(self, target_obj, data_type=None, **kwargs): serialized = {} if is_xml_model_serialization: - serialized = target_obj._create_xml_node() + serialized = target_obj._create_xml_node() # pylint: disable=protected-access try: - attributes = target_obj._attribute_map + attributes = target_obj._attribute_map # pylint: disable=protected-access for attr, attr_desc in attributes.items(): attr_name = attr - if not keep_readonly and target_obj._validation.get(attr_name, {}).get("readonly", False): + if not keep_readonly and target_obj._validation.get( # pylint: disable=protected-access + attr_name, {} + ).get("readonly", False): continue if attr_name == "additional_properties" and attr_desc["key"] == "": @@ -605,62 +687,63 @@ def _serialize(self, target_obj, data_type=None, **kwargs): 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) + 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 + serialized.text = new_attr # type: ignore continue if isinstance(new_attr, list): - serialized.extend(new_attr) + 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 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) + 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 = unicode_str(new_attr) - serialized.append(local_node) + local_node.text = str(new_attr) + serialized.append(local_node) # type: ignore else: # JSON - for k in reversed(keys): - unflattened = {k: new_attr} - new_attr = unflattened + for k in reversed(keys): # type: ignore + new_attr = {k: new_attr} _new_attr = new_attr _serialized = serialized - for k in keys: + for k in keys: # type: ignore if k not in _serialized: - _serialized.update(_new_attr) - _new_attr = _new_attr[k] + _serialized.update(_new_attr) # type: ignore + _new_attr = _new_attr[k] # type: ignore _serialized = _serialized[k] - except ValueError: - continue + 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_with_traceback(SerializationError, msg, err) - else: - return serialized + raise SerializationError(msg) from err + return serialized def body(self, data, data_type, **kwargs): """Serialize data intended for a request body. - :param data: The data to be serialized. + :param object data: The data to be serialized. :param str data_type: The type to be serialized from. :rtype: dict :raises: SerializationError if serialization fails. :raises: ValueError if data is None + :returns: The serialized request body """ # Just in case this is a dict - internal_data_type = data_type.strip("[]{}") - internal_data_type = self.dependencies.get(internal_data_type, None) + 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: @@ -675,7 +758,7 @@ def body(self, data, data_type, **kwargs): # We're not able to deal with additional properties for now. deserializer.additional_properties_detection = False if is_xml_model_serialization: - deserializer.key_extractors = [ + deserializer.key_extractors = [ # type: ignore attribute_key_case_insensitive_extractor, ] else: @@ -684,18 +767,20 @@ def body(self, data, data_type, **kwargs): attribute_key_case_insensitive_extractor, last_rest_key_case_insensitive_extractor, ] - data = deserializer._deserialize(data_type, data) + data = deserializer._deserialize(data_type, data) # pylint: disable=protected-access except DeserializationError as err: - raise_with_traceback(SerializationError, "Unable to build a model: " + str(err), 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 name: The name of the URL path parameter. + :param object data: The data to be serialized. :param str data_type: The type to be serialized from. :rtype: str + :returns: The serialized URL path :raises: TypeError if serialization fails. :raises: ValueError if data is None """ @@ -706,30 +791,30 @@ def url(self, name, data, data_type, **kwargs): 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 + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return output def query(self, name, data, data_type, **kwargs): """Serialize data intended for a URL query. - :param data: The data to be serialized. + :param str name: The name of the query parameter. + :param object data: The data to be serialized. :param str data_type: The type to be serialized from. - :rtype: str + :rtype: str, list :raises: TypeError if serialization fails. :raises: ValueError if data is None + :returns: The serialized query parameter """ try: # Treat the list aside, since we don't want to encode the div separator if data_type.startswith("["): internal_data_type = data_type[1:-1] - data = [self.serialize_data(d, internal_data_type, **kwargs) if d is not None else "" for d in data] - if not kwargs.get("skip_quote", False): - data = [quote(str(d), safe="") for d in data] - return str(self.serialize_iter(data, internal_data_type, **kwargs)) + 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) @@ -739,19 +824,20 @@ def query(self, name, data, data_type, **kwargs): output = str(output) else: output = quote(str(output), safe="") - except SerializationError: - raise TypeError("{} must be type {}.".format(name, data_type)) - else: - return str(output) + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return str(output) def header(self, name, data, data_type, **kwargs): """Serialize data intended for a request header. - :param data: The data to be serialized. + :param str name: The name of the header. + :param object data: The data to be serialized. :param str data_type: The type to be serialized from. :rtype: str :raises: TypeError if serialization fails. :raises: ValueError if data is None + :returns: The serialized header """ try: if data_type in ["[str]"]: @@ -760,30 +846,31 @@ def header(self, name, data, data_type, **kwargs): 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) + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return str(output) def serialize_data(self, data, data_type, **kwargs): """Serialize generic data according to supplied data type. - :param data: The data to be serialized. + :param object 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. + :returns: The serialized data. + :rtype: str, int, float, bool, dict, list """ if data is None: raise ValueError("No value for given attribute") try: + if data is CoreNull: + return None if data_type in self.basic_types.values(): return self.serialize_basic(data, data_type, **kwargs) - elif data_type in self.serialize_type: + if data_type in self.serialize_type: return self.serialize_type[data_type](data, **kwargs) # If dependencies is empty, try with current data class @@ -798,12 +885,11 @@ def serialize_data(self, data, data_type, **kwargs): except (ValueError, TypeError) as err: msg = "Unable to serialize value: {!r} as type: {!r}." - raise_with_traceback(SerializationError, msg.format(data, data_type), err) - else: - return self._serialize(data, **kwargs) + raise SerializationError(msg.format(data, data_type)) from err + return self._serialize(data, **kwargs) @classmethod - def _get_custom_serializers(cls, data_type, **kwargs): + def _get_custom_serializers(cls, data_type, **kwargs): # pylint: disable=inconsistent-return-statements custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type) if custom_serializer: return custom_serializer @@ -819,23 +905,26 @@ def serialize_basic(cls, data, data_type, **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 obj data: Object to be serialized. :param str data_type: Type of object in the iterable. + :rtype: str, int, float, bool + :return: serialized object """ custom_serializer = cls._get_custom_serializers(data_type, **kwargs) if custom_serializer: return custom_serializer(data) if data_type == "str": return cls.serialize_unicode(data) - return eval(data_type)(data) # nosec + return eval(data_type)(data) # nosec # pylint: disable=eval-used @classmethod def serialize_unicode(cls, data): """Special handling for serializing unicode strings in Py2. Encode to UTF-8 if unicode, otherwise handle as a str. - :param data: Object to be serialized. + :param str data: Object to be serialized. :rtype: str + :return: serialized object """ try: # If I received an enum, return its value return data.value @@ -843,14 +932,13 @@ def serialize_unicode(cls, data): pass try: - if isinstance(data, unicode): + 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) + return str(data) def serialize_iter(self, data, iter_type, div=None, **kwargs): """Serialize iterable. @@ -860,13 +948,13 @@ def serialize_iter(self, data, iter_type, div=None, **kwargs): 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 list data: 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'. + Defaults to False. :rtype: list, str + :return: serialized iterable """ if isinstance(data, str): raise SerializationError("Refuse str type as a valid iter type.") @@ -878,9 +966,14 @@ def serialize_iter(self, data, iter_type, div=None, **kwargs): for d in data: try: serialized.append(self.serialize_data(d, iter_type, **kwargs)) - except ValueError: + 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) @@ -916,16 +1009,17 @@ def serialize_dict(self, attr, dict_type, **kwargs): :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 + :return: serialized dictionary """ serialization_ctxt = kwargs.get("serialization_ctxt", {}) serialized = {} for key, value in attr.items(): try: serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs) - except ValueError: + except ValueError as err: + if isinstance(err, SerializationError): + raise serialized[self.serialize_unicode(key)] = None if "xml" in serialization_ctxt: @@ -940,7 +1034,7 @@ def serialize_dict(self, attr, dict_type, **kwargs): return serialized - def serialize_object(self, attr, **kwargs): + def serialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements """Serialize a generic object. This will be handled as a dictionary. If object passed in is not a basic type (str, int, float, dict, list) it will simply be @@ -948,6 +1042,7 @@ def serialize_object(self, attr, **kwargs): :param dict attr: Object to be serialized. :rtype: dict or str + :return: serialized object """ if attr is None: return None @@ -958,7 +1053,7 @@ def serialize_object(self, attr, **kwargs): 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 unicode_str: + if obj_type is str: return self.serialize_unicode(attr) if obj_type is datetime.datetime: return self.serialize_iso(attr) @@ -972,7 +1067,7 @@ def serialize_object(self, attr, **kwargs): 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): + if obj_type in self.dependencies.values() or isinstance(attr, Model): return self._serialize(attr) if obj_type == dict: @@ -1001,58 +1096,63 @@ def serialize_enum(attr, enum_obj=None): except AttributeError: result = attr try: - enum_obj(result) + enum_obj(result) # type: ignore return result - except ValueError: - for enum_value in enum_obj: + except ValueError as exc: + for enum_value in enum_obj: # type: ignore if enum_value.value.lower() == str(attr).lower(): return enum_value.value error = "{!r} is not valid value for enum {!r}" - raise SerializationError(error.format(attr, enum_obj)) + raise SerializationError(error.format(attr, enum_obj)) from exc @staticmethod - def serialize_bytearray(attr, **kwargs): + def serialize_bytearray(attr, **kwargs): # pylint: disable=unused-argument """Serialize bytearray into base-64 string. - :param attr: Object to be serialized. + :param str attr: Object to be serialized. :rtype: str + :return: serialized base64 """ return b64encode(attr).decode() @staticmethod - def serialize_base64(attr, **kwargs): + def serialize_base64(attr, **kwargs): # pylint: disable=unused-argument """Serialize str into base-64 string. - :param attr: Object to be serialized. + :param str attr: Object to be serialized. :rtype: str + :return: serialized base64 """ encoded = b64encode(attr).decode("ascii") return encoded.strip("=").replace("+", "-").replace("/", "_") @staticmethod - def serialize_decimal(attr, **kwargs): + def serialize_decimal(attr, **kwargs): # pylint: disable=unused-argument """Serialize Decimal object to float. - :param attr: Object to be serialized. + :param decimal attr: Object to be serialized. :rtype: float + :return: serialized decimal """ return float(attr) @staticmethod - def serialize_long(attr, **kwargs): + def serialize_long(attr, **kwargs): # pylint: disable=unused-argument """Serialize long (Py2) or int (Py3). - :param attr: Object to be serialized. + :param int attr: Object to be serialized. :rtype: int/long + :return: serialized long """ return _long_type(attr) @staticmethod - def serialize_date(attr, **kwargs): + def serialize_date(attr, **kwargs): # pylint: disable=unused-argument """Serialize Date object into ISO-8601 formatted string. :param Date attr: Object to be serialized. :rtype: str + :return: serialized date """ if isinstance(attr, str): attr = isodate.parse_date(attr) @@ -1060,11 +1160,12 @@ def serialize_date(attr, **kwargs): return t @staticmethod - def serialize_time(attr, **kwargs): + def serialize_time(attr, **kwargs): # pylint: disable=unused-argument """Serialize Time object into ISO-8601 formatted string. :param datetime.time attr: Object to be serialized. :rtype: str + :return: serialized time """ if isinstance(attr, str): attr = isodate.parse_time(attr) @@ -1074,30 +1175,32 @@ def serialize_time(attr, **kwargs): return t @staticmethod - def serialize_duration(attr, **kwargs): + def serialize_duration(attr, **kwargs): # pylint: disable=unused-argument """Serialize TimeDelta object into ISO-8601 formatted string. :param TimeDelta attr: Object to be serialized. :rtype: str + :return: serialized duration """ if isinstance(attr, str): attr = isodate.parse_duration(attr) return isodate.duration_isoformat(attr) @staticmethod - def serialize_rfc(attr, **kwargs): + def serialize_rfc(attr, **kwargs): # pylint: disable=unused-argument """Serialize Datetime object into RFC-1123 formatted string. :param Datetime attr: Object to be serialized. :rtype: str :raises: TypeError if format invalid. + :return: serialized rfc """ try: if not attr.tzinfo: _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") utc = attr.utctimetuple() - except AttributeError: - raise TypeError("RFC1123 object must be valid Datetime object.") + except AttributeError as exc: + raise TypeError("RFC1123 object must be valid Datetime object.") from exc return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format( Serializer.days[utc.tm_wday], @@ -1110,12 +1213,13 @@ def serialize_rfc(attr, **kwargs): ) @staticmethod - def serialize_iso(attr, **kwargs): + def serialize_iso(attr, **kwargs): # pylint: disable=unused-argument """Serialize Datetime object into ISO-8601 formatted string. :param Datetime attr: Object to be serialized. :rtype: str :raises: SerializationError if format invalid. + :return: serialized iso """ if isinstance(attr, str): attr = isodate.parse_datetime(attr) @@ -1135,19 +1239,20 @@ def serialize_iso(attr, **kwargs): return date + microseconds + "Z" except (ValueError, OverflowError) as err: msg = "Unable to serialize datetime object." - raise_with_traceback(SerializationError, msg, err) + raise SerializationError(msg) from err except AttributeError as err: msg = "ISO-8601 object must be valid Datetime object." - raise_with_traceback(TypeError, msg, err) + raise TypeError(msg) from err @staticmethod - def serialize_unix(attr, **kwargs): + def serialize_unix(attr, **kwargs): # pylint: disable=unused-argument """Serialize Datetime object into IntTime format. This is represented as seconds. :param Datetime attr: Object to be serialized. :rtype: int :raises: SerializationError if format invalid + :return: serialied unix """ if isinstance(attr, int): return attr @@ -1155,16 +1260,17 @@ def serialize_unix(attr, **kwargs): 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.") + except AttributeError as exc: + raise TypeError("Unix time object must be valid Datetime object.") from exc -def rest_key_extractor(attr, attr_desc, data): +def rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument key = attr_desc["key"] working_data = data while "." in key: - dict_keys = _FLATTEN.split(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 @@ -1173,14 +1279,15 @@ def rest_key_extractor(attr, attr_desc, 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 - # https://github.com/Azure/msrest-for-python/issues/197 return None key = ".".join(dict_keys[1:]) return working_data.get(key) -def rest_key_case_insensitive_extractor(attr, attr_desc, data): +def rest_key_case_insensitive_extractor( # pylint: disable=unused-argument, inconsistent-return-statements + attr, attr_desc, data +): key = attr_desc["key"] working_data = data @@ -1194,7 +1301,6 @@ def rest_key_case_insensitive_extractor(attr, attr_desc, 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 - # https://github.com/Azure/msrest-for-python/issues/197 return None key = ".".join(dict_keys[1:]) @@ -1202,17 +1308,29 @@ def rest_key_case_insensitive_extractor(attr, attr_desc, 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.""" +def last_rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + """Extract the attribute in "data" based on the last part of the JSON path key. + + :param str attr: The attribute to extract + :param dict attr_desc: The attribute description + :param dict data: The data to extract from + :rtype: object + :returns: The extracted attribute + """ key = attr_desc["key"] dict_keys = _FLATTEN.split(key) return attribute_key_extractor(dict_keys[-1], None, data) -def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): +def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): # pylint: disable=unused-argument """Extract the attribute in "data" based on the last part of the JSON path key. This is the case insensitive version of "last_rest_key_extractor" + :param str attr: The attribute to extract + :param dict attr_desc: The attribute description + :param dict data: The data to extract from + :rtype: object + :returns: The extracted attribute """ key = attr_desc["key"] dict_keys = _FLATTEN.split(key) @@ -1245,11 +1363,11 @@ def _extract_name_from_internal_type(internal_type): 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) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) return xml_name -def xml_key_extractor(attr, attr_desc, data): +def xml_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument,too-many-return-statements if isinstance(data, dict): return None @@ -1269,7 +1387,7 @@ def xml_key_extractor(attr, attr_desc, data): # 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) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) # If it's an attribute, that's simple if xml_desc.get("attr", False): @@ -1301,22 +1419,21 @@ def xml_key_extractor(attr, attr_desc, data): if is_iter_type: if is_wrapped: return None # is_wrapped no node, we want None - else: - return [] # not wrapped, assume empty list + 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 - ) + # 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( # pylint: disable=line-too-long + xml_name ) - return list(children[0]) # Might be empty list and that's ok. + ) + 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: @@ -1324,7 +1441,7 @@ def xml_key_extractor(attr, attr_desc, data): return children[0] -class Deserializer(object): +class Deserializer: """Response object model deserializer. :param dict classes: Class type dictionary for deserializing complex types. @@ -1333,9 +1450,9 @@ class Deserializer(object): 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}]?") + valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") - def __init__(self, classes=None): + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: self.deserialize_type = { "iso-8601": Deserializer.deserialize_iso, "rfc-1123": Deserializer.deserialize_rfc, @@ -1355,7 +1472,7 @@ def __init__(self, classes=None): "duration": (isodate.Duration, datetime.timedelta), "iso-8601": (datetime.datetime), } - self.dependencies = dict(classes) if classes else {} + 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 @@ -1373,11 +1490,12 @@ def __call__(self, target_obj, response_data, content_type=None): :param str content_type: Swagger "produces" if available. :raises: DeserializationError if deserialization fails. :return: Deserialized object. + :rtype: object """ data = self._unpack_content(response_data, content_type) return self._deserialize(target_obj, data) - def _deserialize(self, target_obj, data): + def _deserialize(self, target_obj, data): # pylint: disable=inconsistent-return-statements """Call the deserializer on a model. Data needs to be already deserialized as JSON or XML ElementTree @@ -1386,12 +1504,13 @@ def _deserialize(self, target_obj, data): :param object data: Object to deserialize. :raises: DeserializationError if deserialization fails. :return: Deserialized object. + :rtype: object """ # This is already a model, go recursive just in case if hasattr(data, "_attribute_map"): constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")] try: - for attr, mapconfig in data._attribute_map.items(): + for attr, mapconfig in data._attribute_map.items(): # pylint: disable=protected-access if attr in constants: continue value = getattr(data, attr) @@ -1408,15 +1527,15 @@ def _deserialize(self, target_obj, data): response, class_name = self._classify_target(target_obj, data) - if isinstance(response, basestring): + if isinstance(response, str): return self.deserialize_data(data, response) - elif isinstance(response, type) and issubclass(response, Enum): + if isinstance(response, type) and issubclass(response, Enum): return self.deserialize_enum(data, response) - if data is None: + if data is None or data is CoreNull: return data try: - attributes = response._attribute_map + attributes = response._attribute_map # type: ignore # pylint: disable=protected-access d_attrs = {} for attr, attr_desc in attributes.items(): # Check empty string. If it's not empty, someone has a real "additionalProperties"... @@ -1444,11 +1563,10 @@ def _deserialize(self, target_obj, data): 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 - raise_with_traceback(DeserializationError, msg, err) - else: - additional_properties = self._build_additional_properties(attributes, data) - return self._instantiate_model(response, d_attrs, additional_properties) + msg = "Unable to deserialize to object: " + class_name # type: ignore + raise DeserializationError(msg) from err + additional_properties = self._build_additional_properties(attributes, data) + return self._instantiate_model(response, d_attrs, additional_properties) def _build_additional_properties(self, attribute_map, data): if not self.additional_properties_detection: @@ -1474,22 +1592,24 @@ def _classify_target(self, target, data): 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 deseralize. + :param str/dict data: The response data to deserialize. + :return: The classified target object and its class name. + :rtype: tuple """ if target is None: return None, None - if isinstance(target, basestring): + if isinstance(target, str): try: target = self.dependencies[target] except KeyError: return target, target try: - target = target._classify(data, self.dependencies) + target = target._classify(data, self.dependencies) # type: ignore # pylint: disable=protected-access except AttributeError: pass # Target is not a Model, no classify - return target, target.__class__.__name__ + return target, target.__class__.__name__ # type: ignore def failsafe_deserialize(self, target_obj, data, content_type=None): """Ignores any errors encountered in deserialization, @@ -1499,12 +1619,14 @@ def failsafe_deserialize(self, target_obj, data, content_type=None): a deserialization error. :param str target_obj: The target object type to deserialize to. - :param str/dict data: The response data to deseralize. + :param str/dict data: The response data to deserialize. :param str content_type: Swagger "produces" if available. + :return: Deserialized object. + :rtype: object """ try: return self(target_obj, data, content_type=content_type) - except: + except: # pylint: disable=bare-except _LOGGER.debug( "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True ) @@ -1522,10 +1644,12 @@ def _unpack_content(raw_data, content_type=None): 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. + :param obj raw_data: Data to be processed. + :param str content_type: How to parse if raw_data is a string/bytes. :raises JSONDecodeError: If JSON is requested and parsing is impossible. :raises UnicodeDecodeError: If bytes is not UTF8 + :rtype: object + :return: Unpacked content. """ # Assume this is enough to detect a Pipeline Response without importing it context = getattr(raw_data, "context", {}) @@ -1542,31 +1666,42 @@ def _unpack_content(raw_data, content_type=None): if hasattr(raw_data, "_content_consumed"): return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) - if isinstance(raw_data, (basestring, bytes)) or hasattr(raw_data, "read"): - return RawDeserializer.deserialize_from_text(raw_data, content_type) + 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. + :param Response response: The response model class. + :param dict attrs: The deserialized response attributes. + :param dict additional_properties: Additional properties to be set. + :rtype: Response + :return: The instantiated response model. """ if callable(response): subtype = getattr(response, "_subtype_map", {}) try: - readonly = [k for k, v in response._validation.items() if v.get("readonly")] - const = [k for k, v in response._validation.items() if v.get("constant")] + readonly = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("readonly") + ] + const = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("constant") + ] kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const} response_obj = response(**kwargs) for attr in readonly: setattr(response_obj, attr, attrs.get(attr)) if additional_properties: - response_obj.additional_properties = additional_properties + response_obj.additional_properties = additional_properties # type: ignore return response_obj except TypeError as err: - msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) - raise DeserializationError(msg + str(err)) + msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore + raise DeserializationError(msg + str(err)) from err else: try: for attr, value in attrs.items(): @@ -1575,15 +1710,16 @@ def _instantiate_model(self, response, attrs, additional_properties=None): except Exception as exp: msg = "Unable to populate response model. " msg += "Type: {}, Error: {}".format(type(response), exp) - raise DeserializationError(msg) + raise DeserializationError(msg) from exp - def deserialize_data(self, data, data_type): + def deserialize_data(self, data, data_type): # pylint: disable=too-many-return-statements """Process data for deserialization according to data type. :param str data: The response string to be deserialized. :param str data_type: The type to deserialize to. :raises: DeserializationError if deserialization fails. :return: Deserialized object. + :rtype: object """ if data is None: return data @@ -1597,7 +1733,11 @@ def deserialize_data(self, data, data_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"{}"] + is_a_text_parsing_type = lambda x: x not in [ # pylint: disable=unnecessary-lambda-assignment + "object", + "[]", + r"{}", + ] if isinstance(data, ET.Element) and is_a_text_parsing_type(data_type) and not data.text: return None data_val = self.deserialize_type[data_type](data) @@ -1616,15 +1756,15 @@ def deserialize_data(self, data, data_type): except (ValueError, TypeError, AttributeError) as err: msg = "Unable to deserialize response data." msg += " Data: {}, {}".format(data, data_type) - raise_with_traceback(DeserializationError, msg, err) - else: - return self._deserialize(obj_type, data) + raise DeserializationError(msg) from err + return self._deserialize(obj_type, data) def deserialize_iter(self, attr, iter_type): """Deserialize an iterable. :param list attr: Iterable to be deserialized. :param str iter_type: The type of object in the iterable. + :return: Deserialized iterable. :rtype: list """ if attr is None: @@ -1641,6 +1781,7 @@ def deserialize_dict(self, attr, dict_type): :param dict/list attr: Dictionary to be deserialized. Also accepts a list of key, value pairs. :param str dict_type: The object type of the items in the dictionary. + :return: Deserialized dictionary. :rtype: dict """ if isinstance(attr, list): @@ -1651,11 +1792,12 @@ def deserialize_dict(self, attr, dict_type): 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): + def deserialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements """Deserialize a generic object. This will be handled as a dictionary. :param dict attr: Dictionary to be deserialized. + :return: Deserialized object. :rtype: dict :raises: TypeError if non-builtin datatype encountered. """ @@ -1664,7 +1806,7 @@ def deserialize_object(self, attr, **kwargs): if isinstance(attr, ET.Element): # Do no recurse on XML, just return the tree as-is return attr - if isinstance(attr, basestring): + if isinstance(attr, str): return self.deserialize_basic(attr, "str") obj_type = type(attr) if obj_type in self.basic_types: @@ -1690,11 +1832,10 @@ def deserialize_object(self, attr, **kwargs): pass return deserialized - else: - error = "Cannot deserialize generic object with type: " - raise TypeError(error + str(obj_type)) + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) - def deserialize_basic(self, attr, data_type): + def deserialize_basic(self, attr, data_type): # pylint: disable=too-many-return-statements """Deserialize basic builtin data type from string. Will attempt to convert to str, int, float and bool. This function will also accept '1', '0', 'true' and 'false' as @@ -1702,6 +1843,7 @@ def deserialize_basic(self, attr, data_type): :param str attr: response string to be deserialized. :param str data_type: deserialization data type. + :return: Deserialized basic type. :rtype: str, int, float or bool :raises: TypeError if string format is not valid. """ @@ -1713,24 +1855,23 @@ def deserialize_basic(self, attr, data_type): 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 + # 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, basestring): + if isinstance(attr, str): if attr.lower() in ["true", "1"]: return True - elif attr.lower() in ["false", "0"]: + if attr.lower() in ["false", "0"]: return False raise TypeError("Invalid boolean value: {}".format(attr)) if data_type == "str": return self.deserialize_unicode(attr) - return eval(data_type)(attr) # nosec + return eval(data_type)(attr) # nosec # pylint: disable=eval-used @staticmethod def deserialize_unicode(data): @@ -1738,6 +1879,7 @@ def deserialize_unicode(data): as a string. :param str data: response string to be deserialized. + :return: Deserialized string. :rtype: str or unicode """ # We might be here because we have an enum modeled as string, @@ -1747,12 +1889,11 @@ def deserialize_unicode(data): # Consider this is real string try: - if isinstance(data, unicode): + if isinstance(data, unicode): # type: ignore return data except NameError: return str(data) - else: - return str(data) + return str(data) @staticmethod def deserialize_enum(data, enum_obj): @@ -1764,6 +1905,7 @@ def deserialize_enum(data, enum_obj): :param str data: Response string to be deserialized. If this value is None or invalid it will be returned as-is. :param Enum enum_obj: Enum object to deserialize to. + :return: Deserialized enum object. :rtype: Enum """ if isinstance(data, enum_obj) or data is None: @@ -1772,12 +1914,11 @@ def deserialize_enum(data, enum_obj): data = data.value if isinstance(data, int): # Workaround. We might consider remove it in the future. - # https://github.com/Azure/azure-rest-api-specs/issues/141 try: return list(enum_obj.__members__.values())[data] - except IndexError: + except IndexError as exc: error = "{!r} is not a valid index for enum {!r}" - raise DeserializationError(error.format(data, enum_obj)) + raise DeserializationError(error.format(data, enum_obj)) from exc try: return enum_obj(str(data)) except ValueError: @@ -1793,25 +1934,27 @@ def deserialize_bytearray(attr): """Deserialize string into bytearray. :param str attr: response string to be deserialized. + :return: Deserialized bytearray :rtype: bytearray :raises: TypeError if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text - return bytearray(b64decode(attr)) + return bytearray(b64decode(attr)) # type: ignore @staticmethod def deserialize_base64(attr): """Deserialize base64 encoded string into string. :param str attr: response string to be deserialized. + :return: Deserialized base64 string :rtype: bytearray :raises: TypeError if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text - padding = "=" * (3 - (len(attr) + 3) % 4) - attr = attr + padding + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore encoded = attr.replace("-", "+").replace("_", "/") return b64decode(encoded) @@ -1820,34 +1963,37 @@ def deserialize_decimal(attr): """Deserialize string into Decimal object. :param str attr: response string to be deserialized. - :rtype: Decimal + :return: Deserialized decimal :raises: DeserializationError if string format invalid. + :rtype: decimal """ if isinstance(attr, ET.Element): attr = attr.text try: - return decimal.Decimal(attr) + return decimal.Decimal(str(attr)) # type: ignore except decimal.DecimalException as err: msg = "Invalid decimal {}".format(attr) - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err @staticmethod def deserialize_long(attr): """Deserialize string into long (Py2) or int (Py3). :param str attr: response string to be deserialized. + :return: Deserialized int :rtype: long or int :raises: ValueError if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text - return _long_type(attr) + return _long_type(attr) # type: ignore @staticmethod def deserialize_duration(attr): """Deserialize ISO-8601 formatted string into TimeDelta object. :param str attr: response string to be deserialized. + :return: Deserialized duration :rtype: TimeDelta :raises: DeserializationError if string format invalid. """ @@ -1857,36 +2003,37 @@ def deserialize_duration(attr): duration = isodate.parse_duration(attr) except (ValueError, OverflowError, AttributeError) as err: msg = "Cannot deserialize duration object." - raise_with_traceback(DeserializationError, msg, err) - else: - return duration + raise DeserializationError(msg) from err + return duration @staticmethod def deserialize_date(attr): """Deserialize ISO-8601 formatted string into Date object. :param str attr: response string to be deserialized. + :return: Deserialized date :rtype: Date :raises: DeserializationError if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text - if re.search(r"[^\W\d_]", attr, re.I + re.U): + 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=None, defaultday=None) + return isodate.parse_date(attr, defaultmonth=0, defaultday=0) @staticmethod def deserialize_time(attr): """Deserialize ISO-8601 formatted string into time object. :param str attr: response string to be deserialized. + :return: Deserialized time :rtype: datetime.time :raises: DeserializationError if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text - if re.search(r"[^\W\d_]", attr, re.I + re.U): + 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) @@ -1895,13 +2042,14 @@ def deserialize_rfc(attr): """Deserialize RFC-1123 formatted string into Datetime object. :param str attr: response string to be deserialized. + :return: Deserialized RFC datetime :rtype: Datetime :raises: DeserializationError if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text try: - parsed_date = email.utils.parsedate_tz(attr) + 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)) ) @@ -1909,22 +2057,22 @@ def deserialize_rfc(attr): date_obj = date_obj.astimezone(tz=TZ_UTC) except ValueError as err: msg = "Cannot deserialize to rfc datetime object." - raise_with_traceback(DeserializationError, msg, err) - else: - return date_obj + raise DeserializationError(msg) from err + return date_obj @staticmethod def deserialize_iso(attr): """Deserialize ISO-8601 formatted string into Datetime object. :param str attr: response string to be deserialized. + :return: Deserialized ISO datetime :rtype: Datetime :raises: DeserializationError if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text try: - attr = attr.upper() + attr = attr.upper() # type: ignore match = Deserializer.valid_date.match(attr) if not match: raise ValueError("Invalid datetime string: " + attr) @@ -1946,9 +2094,8 @@ def deserialize_iso(attr): raise OverflowError("Hit max or min date") except (ValueError, OverflowError, AttributeError) as err: msg = "Cannot deserialize datetime object." - raise_with_traceback(DeserializationError, msg, err) - else: - return date_obj + raise DeserializationError(msg) from err + return date_obj @staticmethod def deserialize_unix(attr): @@ -1956,15 +2103,16 @@ def deserialize_unix(attr): This is represented as seconds. :param int attr: Object to be serialized. + :return: Deserialized datetime :rtype: Datetime :raises: DeserializationError if format invalid """ if isinstance(attr, ET.Element): - attr = int(attr.text) + 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_with_traceback(DeserializationError, msg, err) - else: - return date_obj + raise DeserializationError(msg) from err + return date_obj diff --git a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/_vendor.py b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/_vendor.py deleted file mode 100644 index 9aad73fc743e..000000000000 --- a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/_vendor.py +++ /dev/null @@ -1,27 +0,0 @@ -# -------------------------------------------------------------------------- -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for license information. -# Code generated by Microsoft (R) AutoRest Code Generator. -# Changes may cause incorrect behavior and will be lost if the code is regenerated. -# -------------------------------------------------------------------------- - -from azure.core.pipeline.transport import HttpRequest - - -def _convert_request(request, files=None): - data = request.content if not files else None - request = HttpRequest(method=request.method, url=request.url, headers=request.headers, data=data) - if files: - request.set_formdata_body(files) - return request - - -def _format_url_section(template, **kwargs): - components = template.split("/") - while components: - try: - return template.format(**kwargs) - except KeyError as key: - formatted_components = template.split("/") - components = [c for c in formatted_components if "{}".format(key.args[0]) not in c] - template = "/".join(components) diff --git a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/_version.py b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/_version.py index 653b73a4a199..e5754a47ce68 100644 --- a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/_version.py +++ b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/_version.py @@ -6,4 +6,4 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -VERSION = "1.1.0b1" +VERSION = "1.0.0b1" diff --git a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/__init__.py b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/__init__.py index a2562ccfe27e..71a683b73dce 100644 --- a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/__init__.py +++ b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/__init__.py @@ -5,12 +5,18 @@ # Code generated by Microsoft (R) AutoRest Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._portal import Portal +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._portal import Portal # type: ignore try: from ._patch import __all__ as _patch_all - from ._patch import * # type: ignore # pylint: disable=unused-wildcard-import + from ._patch import * except ImportError: _patch_all = [] from ._patch import patch_sdk as _patch_sdk @@ -18,6 +24,6 @@ __all__ = [ "Portal", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/_configuration.py b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/_configuration.py index 5b423c462294..2545f783d7bd 100644 --- a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/_configuration.py +++ b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/_configuration.py @@ -6,26 +6,18 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -import sys from typing import Any, TYPE_CHECKING -from azure.core.configuration import Configuration from azure.core.pipeline import policies from azure.mgmt.core.policies import ARMHttpLoggingPolicy, AsyncARMChallengeAuthenticationPolicy from .._version import VERSION -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports -else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports - if TYPE_CHECKING: - # pylint: disable=unused-import,ungrouped-imports from azure.core.credentials_async import AsyncTokenCredential -class PortalConfiguration(Configuration): # pylint: disable=too-many-instance-attributes +class PortalConfiguration: # pylint: disable=too-many-instance-attributes """Configuration for Portal. Note that all parameters used to create this instance are saved as instance @@ -33,17 +25,15 @@ class PortalConfiguration(Configuration): # pylint: disable=too-many-instance-a :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials_async.AsyncTokenCredential - :param subscription_id: The Azure subscription ID. This is a GUID-formatted string (e.g. - 00000000-0000-0000-0000-000000000000). Required. + :param subscription_id: The ID of the target subscription. The value must be an UUID. Required. :type subscription_id: str - :keyword api_version: Api Version. Default value is "2020-09-01-preview". Note that overriding + :keyword api_version: Api Version. Default value is "2025-04-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: - super(PortalConfiguration, self).__init__(**kwargs) - api_version = kwargs.pop("api_version", "2020-09-01-preview") # type: Literal["2020-09-01-preview"] + api_version: str = kwargs.pop("api_version", "2025-04-01-preview") if credential is None: raise ValueError("Parameter 'credential' must not be None.") @@ -55,6 +45,7 @@ def __init__(self, credential: "AsyncTokenCredential", subscription_id: str, **k self.api_version = api_version self.credential_scopes = kwargs.pop("credential_scopes", ["https://management.azure.com/.default"]) kwargs.setdefault("sdk_moniker", "mgmt-portal/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) self._configure(**kwargs) def _configure(self, **kwargs: Any) -> None: @@ -63,9 +54,9 @@ def _configure(self, **kwargs: Any) -> None: 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.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**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( diff --git a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/_portal.py b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/_portal.py index f0da1177b196..43f066154858 100644 --- a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/_portal.py +++ b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/_portal.py @@ -8,11 +8,14 @@ from copy import deepcopy from typing import Any, Awaitable, TYPE_CHECKING +from typing_extensions import Self +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 .. import models +from .. import models as _models from .._serialization import Deserializer, Serializer from ._configuration import PortalConfiguration from .operations import ( @@ -23,31 +26,29 @@ ) if TYPE_CHECKING: - # pylint: disable=unused-import,ungrouped-imports from azure.core.credentials_async import AsyncTokenCredential -class Portal: # pylint: disable=client-accepts-api-version-keyword +class Portal: """Allows creation and deletion of Azure Shared Dashboards. :ivar operations: Operations operations :vartype operations: azure.mgmt.portal.aio.operations.Operations :ivar dashboards: DashboardsOperations operations :vartype dashboards: azure.mgmt.portal.aio.operations.DashboardsOperations - :ivar tenant_configurations: TenantConfigurationsOperations operations - :vartype tenant_configurations: azure.mgmt.portal.aio.operations.TenantConfigurationsOperations :ivar list_tenant_configuration_violations: ListTenantConfigurationViolationsOperations operations :vartype list_tenant_configuration_violations: azure.mgmt.portal.aio.operations.ListTenantConfigurationViolationsOperations + :ivar tenant_configurations: TenantConfigurationsOperations operations + :vartype tenant_configurations: azure.mgmt.portal.aio.operations.TenantConfigurationsOperations :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials_async.AsyncTokenCredential - :param subscription_id: The Azure subscription ID. This is a GUID-formatted string (e.g. - 00000000-0000-0000-0000-000000000000). Required. + :param subscription_id: The ID of the target subscription. The value must be an UUID. Required. :type subscription_id: str :param base_url: Service URL. Default value is "https://management.azure.com". :type base_url: str - :keyword api_version: Api Version. Default value is "2020-09-01-preview". Note that overriding + :keyword api_version: Api Version. Default value is "2025-04-01-preview". Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ @@ -60,22 +61,42 @@ def __init__( **kwargs: Any ) -> None: self._config = PortalConfiguration(credential=credential, subscription_id=subscription_id, **kwargs) - self._client = AsyncARMPipelineClient(base_url=base_url, config=self._config, **kwargs) - - client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} + _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) + + client_models = {k: v for k, v in _models.__dict__.items() if isinstance(v, type)} self._serialize = Serializer(client_models) self._deserialize = Deserializer(client_models) self._serialize.client_side_validation = False self.operations = Operations(self._client, self._config, self._serialize, self._deserialize) self.dashboards = DashboardsOperations(self._client, self._config, self._serialize, self._deserialize) - self.tenant_configurations = TenantConfigurationsOperations( + self.list_tenant_configuration_violations = ListTenantConfigurationViolationsOperations( self._client, self._config, self._serialize, self._deserialize ) - self.list_tenant_configuration_violations = ListTenantConfigurationViolationsOperations( + self.tenant_configurations = TenantConfigurationsOperations( self._client, self._config, self._serialize, self._deserialize ) - def _send_request(self, request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHttpResponse]: + 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 @@ -95,14 +116,14 @@ def _send_request(self, request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncH request_copy = deepcopy(request) request_copy.url = self._client.format_url(request_copy.url) - return self._client.send_request(request_copy, **kwargs) + 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) -> "Portal": + async def __aenter__(self) -> Self: await self._client.__aenter__() return self - async def __aexit__(self, *exc_details) -> None: + async def __aexit__(self, *exc_details: Any) -> None: await self._client.__aexit__(*exc_details) diff --git a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/operations/__init__.py b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/operations/__init__.py index 87b80f74044e..44dd6865ba6c 100644 --- a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/operations/__init__.py +++ b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/operations/__init__.py @@ -5,21 +5,27 @@ # Code generated by Microsoft (R) AutoRest Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._operations import Operations -from ._dashboards_operations import DashboardsOperations -from ._tenant_configurations_operations import TenantConfigurationsOperations -from ._list_tenant_configuration_violations_operations import ListTenantConfigurationViolationsOperations +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._operations import Operations # type: ignore +from ._dashboards_operations import DashboardsOperations # type: ignore +from ._list_tenant_configuration_violations_operations import ListTenantConfigurationViolationsOperations # type: ignore +from ._tenant_configurations_operations import TenantConfigurationsOperations # type: ignore from ._patch import __all__ as _patch_all -from ._patch import * # type: ignore # pylint: disable=unused-wildcard-import +from ._patch import * from ._patch import patch_sdk as _patch_sdk __all__ = [ "Operations", "DashboardsOperations", - "TenantConfigurationsOperations", "ListTenantConfigurationViolationsOperations", + "TenantConfigurationsOperations", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/operations/_dashboards_operations.py b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/operations/_dashboards_operations.py index 48b2feec9bc6..069f4d2067e9 100644 --- a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/operations/_dashboards_operations.py +++ b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/operations/_dashboards_operations.py @@ -1,4 +1,3 @@ -# pylint: disable=too-many-lines # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -6,6 +5,7 @@ # Code generated by Microsoft (R) AutoRest Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +from io import IOBase import sys from typing import Any, AsyncIterable, Callable, Dict, IO, Optional, TypeVar, Union, overload import urllib.parse @@ -20,15 +20,13 @@ map_error, ) from azure.core.pipeline import PipelineResponse -from azure.core.pipeline.transport import AsyncHttpResponse -from azure.core.rest import HttpRequest +from azure.core.rest import AsyncHttpResponse, HttpRequest from azure.core.tracing.decorator import distributed_trace from azure.core.tracing.decorator_async import distributed_trace_async from azure.core.utils import case_insensitive_dict from azure.mgmt.core.exceptions import ARMErrorFormat from ... import models as _models -from ..._vendor import _convert_request from ...operations._dashboards_operations import ( build_create_or_update_request, build_delete_request, @@ -38,10 +36,10 @@ build_update_request, ) -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports + from typing import MutableMapping # type: ignore T = TypeVar("T") ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] @@ -65,82 +63,99 @@ def __init__(self, *args, **kwargs) -> None: 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") - @overload - async def create_or_update( - self, - resource_group_name: str, - dashboard_name: str, - dashboard: _models.Dashboard, - *, - content_type: str = "application/json", - **kwargs: Any - ) -> _models.Dashboard: - """Creates or updates a Dashboard. + @distributed_trace + def list_by_subscription(self, **kwargs: Any) -> AsyncIterable["_models.Dashboard"]: + """Gets all the dashboards within a subscription. - :param resource_group_name: The name of the resource group. Required. - :type resource_group_name: str - :param dashboard_name: The name of the dashboard. Required. - :type dashboard_name: str - :param dashboard: The parameters required to create or update a dashboard. Required. - :type dashboard: ~azure.mgmt.portal.models.Dashboard - :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. - Default value is "application/json". - :paramtype content_type: str - :keyword callable cls: A custom type or function that will be passed the direct response - :return: Dashboard or the result of cls(response) - :rtype: ~azure.mgmt.portal.models.Dashboard + :return: An iterator like instance of either Dashboard or the result of cls(response) + :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.portal.models.Dashboard] :raises ~azure.core.exceptions.HttpResponseError: """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - @overload - async def create_or_update( - self, - resource_group_name: str, - dashboard_name: str, - dashboard: IO, - *, - content_type: str = "application/json", - **kwargs: Any - ) -> _models.Dashboard: - """Creates or updates a Dashboard. + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DashboardListResult] = kwargs.pop("cls", None) - :param resource_group_name: The name of the resource group. Required. - :type resource_group_name: str - :param dashboard_name: The name of the dashboard. Required. - :type dashboard_name: str - :param dashboard: The parameters required to create or update a dashboard. Required. - :type dashboard: IO - :keyword content_type: Body Parameter content-type. Content type parameter for binary body. - Default value is "application/json". - :paramtype content_type: str - :keyword callable cls: A custom type or function that will be passed the direct response - :return: Dashboard or the result of cls(response) - :rtype: ~azure.mgmt.portal.models.Dashboard - :raises ~azure.core.exceptions.HttpResponseError: - """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) - @distributed_trace_async - async def create_or_update( - self, resource_group_name: str, dashboard_name: str, dashboard: Union[_models.Dashboard, IO], **kwargs: Any - ) -> _models.Dashboard: - """Creates or updates a Dashboard. + def prepare_request(next_link=None): + if not next_link: + + _request = build_list_by_subscription_request( + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request + + async def extract_data(pipeline_response): + deserialized = self._deserialize("DashboardListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + @distributed_trace + def list_by_resource_group(self, resource_group_name: str, **kwargs: Any) -> AsyncIterable["_models.Dashboard"]: + """Gets all the Dashboards within a resource group. - :param resource_group_name: The name of the resource group. Required. + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. :type resource_group_name: str - :param dashboard_name: The name of the dashboard. Required. - :type dashboard_name: str - :param dashboard: The parameters required to create or update a dashboard. Is either a model - type or a IO type. Required. - :type dashboard: ~azure.mgmt.portal.models.Dashboard or IO - :keyword content_type: Body Parameter content-type. Known values are: 'application/json'. - Default value is None. - :paramtype content_type: str - :keyword callable cls: A custom type or function that will be passed the direct response - :return: Dashboard or the result of cls(response) - :rtype: ~azure.mgmt.portal.models.Dashboard + :return: An iterator like instance of either Dashboard or the result of cls(response) + :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.portal.models.Dashboard] :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DashboardListResult] = kwargs.pop("cls", None) + + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -148,78 +163,74 @@ async def create_or_update( } error_map.update(kwargs.pop("error_map", {}) or {}) - _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) - _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] - cls = kwargs.pop("cls", None) # type: ClsType[_models.Dashboard] - - content_type = content_type or "application/json" - _json = None - _content = None - if isinstance(dashboard, (IO, bytes)): - _content = dashboard - else: - _json = self._serialize.body(dashboard, "Dashboard") - - request = build_create_or_update_request( - resource_group_name=resource_group_name, - dashboard_name=dashboard_name, - subscription_id=self._config.subscription_id, - api_version=api_version, - content_type=content_type, - json=_json, - content=_content, - template_url=self.create_or_update.metadata["url"], - headers=_headers, - params=_params, - ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore + def prepare_request(next_link=None): + if not next_link: - pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs - ) + _request = build_list_by_resource_group_request( + resource_group_name=resource_group_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) - response = pipeline_response.http_response + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request - if response.status_code not in [200, 201]: - map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) - raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + async def extract_data(pipeline_response): + deserialized = self._deserialize("DashboardListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, AsyncList(list_of_elem) - if response.status_code == 200: - deserialized = self._deserialize("Dashboard", pipeline_response) + async def get_next(next_link=None): + _request = prepare_request(next_link) - if response.status_code == 201: - deserialized = self._deserialize("Dashboard", pipeline_response) + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response - if cls: - return cls(pipeline_response, deserialized, {}) + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) - return deserialized + return pipeline_response - create_or_update.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}"} # type: ignore + return AsyncItemPaged(get_next, extract_data) @distributed_trace_async - async def delete( # pylint: disable=inconsistent-return-statements - self, resource_group_name: str, dashboard_name: str, **kwargs: Any - ) -> None: - """Deletes the Dashboard. + async def get(self, resource_group_name: str, dashboard_name: str, **kwargs: Any) -> _models.Dashboard: + """Gets the Dashboard. - :param resource_group_name: The name of the resource group. Required. + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. :type resource_group_name: str :param dashboard_name: The name of the dashboard. Required. :type dashboard_name: str - :keyword callable cls: A custom type or function that will be passed the direct response - :return: None or the result of cls(response) - :rtype: None + :return: Dashboard or the result of cls(response) + :rtype: ~azure.mgmt.portal.models.Dashboard :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -230,53 +241,115 @@ async def delete( # pylint: disable=inconsistent-return-statements _headers = kwargs.pop("headers", {}) or {} _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - cls = kwargs.pop("cls", None) # type: ClsType[None] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.Dashboard] = kwargs.pop("cls", None) - request = build_delete_request( + _request = build_get_request( resource_group_name=resource_group_name, dashboard_name=dashboard_name, subscription_id=self._config.subscription_id, api_version=api_version, - template_url=self.delete.metadata["url"], headers=_headers, params=_params, ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore + _request.url = self._client.format_url(_request.url) - pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs + _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, 204]: + if response.status_code not in [200]: map_error(status_code=response.status_code, response=response, error_map=error_map) error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + deserialized = self._deserialize("Dashboard", pipeline_response.http_response) + if cls: - return cls(pipeline_response, None, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def create_or_update( + self, + resource_group_name: str, + dashboard_name: str, + resource: _models.Dashboard, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.Dashboard: + """Creates or updates a Dashboard. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param dashboard_name: The name of the dashboard. Required. + :type dashboard_name: str + :param resource: The parameters required to create or update a dashboard. Required. + :type resource: ~azure.mgmt.portal.models.Dashboard + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: Dashboard or the result of cls(response) + :rtype: ~azure.mgmt.portal.models.Dashboard + :raises ~azure.core.exceptions.HttpResponseError: + """ - delete.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}"} # type: ignore + @overload + async def create_or_update( + self, + resource_group_name: str, + dashboard_name: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.Dashboard: + """Creates or updates a Dashboard. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param dashboard_name: The name of the dashboard. Required. + :type dashboard_name: str + :param resource: The parameters required to create or update a dashboard. 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: Dashboard or the result of cls(response) + :rtype: ~azure.mgmt.portal.models.Dashboard + :raises ~azure.core.exceptions.HttpResponseError: + """ @distributed_trace_async - async def get(self, resource_group_name: str, dashboard_name: str, **kwargs: Any) -> Optional[_models.Dashboard]: - """Gets the Dashboard. + async def create_or_update( + self, + resource_group_name: str, + dashboard_name: str, + resource: Union[_models.Dashboard, IO[bytes]], + **kwargs: Any + ) -> _models.Dashboard: + """Creates or updates a Dashboard. - :param resource_group_name: The name of the resource group. Required. + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. :type resource_group_name: str :param dashboard_name: The name of the dashboard. Required. :type dashboard_name: str - :keyword callable cls: A custom type or function that will be passed the direct response - :return: Dashboard or None or the result of cls(response) - :rtype: ~azure.mgmt.portal.models.Dashboard or None + :param resource: The parameters required to create or update a dashboard. Is either a Dashboard + type or a IO[bytes] type. Required. + :type resource: ~azure.mgmt.portal.models.Dashboard or IO[bytes] + :return: Dashboard or the result of cls(response) + :rtype: ~azure.mgmt.portal.models.Dashboard :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -284,72 +357,77 @@ async def get(self, resource_group_name: str, dashboard_name: str, **kwargs: Any } error_map.update(kwargs.pop("error_map", {}) or {}) - _headers = kwargs.pop("headers", {}) or {} + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - cls = kwargs.pop("cls", None) # type: ClsType[Optional[_models.Dashboard]] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.Dashboard] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(resource, (IOBase, bytes)): + _content = resource + else: + _json = self._serialize.body(resource, "Dashboard") - request = build_get_request( + _request = build_create_or_update_request( resource_group_name=resource_group_name, dashboard_name=dashboard_name, subscription_id=self._config.subscription_id, api_version=api_version, - template_url=self.get.metadata["url"], + content_type=content_type, + json=_json, + content=_content, headers=_headers, params=_params, ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore + _request.url = self._client.format_url(_request.url) - pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs + _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, 404]: + if response.status_code not in [200, 201]: map_error(status_code=response.status_code, response=response, error_map=error_map) error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) - deserialized = None - if response.status_code == 200: - deserialized = self._deserialize("Dashboard", pipeline_response) + deserialized = self._deserialize("Dashboard", pipeline_response.http_response) if cls: - return cls(pipeline_response, deserialized, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore - return deserialized - - get.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}"} # type: ignore + return deserialized # type: ignore @overload async def update( self, resource_group_name: str, dashboard_name: str, - dashboard: _models.PatchableDashboard, + properties: _models.PatchableDashboard, *, content_type: str = "application/json", **kwargs: Any - ) -> Optional[_models.Dashboard]: + ) -> _models.Dashboard: """Updates an existing Dashboard. - :param resource_group_name: The name of the resource group. Required. + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. :type resource_group_name: str :param dashboard_name: The name of the dashboard. Required. :type dashboard_name: str - :param dashboard: The updatable fields of a Dashboard. Required. - :type dashboard: ~azure.mgmt.portal.models.PatchableDashboard + :param properties: The updatable fields of a Dashboard. Required. + :type properties: ~azure.mgmt.portal.models.PatchableDashboard :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword callable cls: A custom type or function that will be passed the direct response - :return: Dashboard or None or the result of cls(response) - :rtype: ~azure.mgmt.portal.models.Dashboard or None + :return: Dashboard or the result of cls(response) + :rtype: ~azure.mgmt.portal.models.Dashboard :raises ~azure.core.exceptions.HttpResponseError: """ @@ -358,25 +436,25 @@ async def update( self, resource_group_name: str, dashboard_name: str, - dashboard: IO, + properties: IO[bytes], *, content_type: str = "application/json", **kwargs: Any - ) -> Optional[_models.Dashboard]: + ) -> _models.Dashboard: """Updates an existing Dashboard. - :param resource_group_name: The name of the resource group. Required. + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. :type resource_group_name: str :param dashboard_name: The name of the dashboard. Required. :type dashboard_name: str - :param dashboard: The updatable fields of a Dashboard. Required. - :type dashboard: IO + :param properties: The updatable fields of a Dashboard. 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 - :keyword callable cls: A custom type or function that will be passed the direct response - :return: Dashboard or None or the result of cls(response) - :rtype: ~azure.mgmt.portal.models.Dashboard or None + :return: Dashboard or the result of cls(response) + :rtype: ~azure.mgmt.portal.models.Dashboard :raises ~azure.core.exceptions.HttpResponseError: """ @@ -385,27 +463,24 @@ async def update( self, resource_group_name: str, dashboard_name: str, - dashboard: Union[_models.PatchableDashboard, IO], + properties: Union[_models.PatchableDashboard, IO[bytes]], **kwargs: Any - ) -> Optional[_models.Dashboard]: + ) -> _models.Dashboard: """Updates an existing Dashboard. - :param resource_group_name: The name of the resource group. Required. + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. :type resource_group_name: str :param dashboard_name: The name of the dashboard. Required. :type dashboard_name: str - :param dashboard: The updatable fields of a Dashboard. Is either a model type or a IO type. - Required. - :type dashboard: ~azure.mgmt.portal.models.PatchableDashboard or IO - :keyword content_type: Body Parameter content-type. Known values are: 'application/json'. - Default value is None. - :paramtype content_type: str - :keyword callable cls: A custom type or function that will be passed the direct response - :return: Dashboard or None or the result of cls(response) - :rtype: ~azure.mgmt.portal.models.Dashboard or None + :param properties: The updatable fields of a Dashboard. Is either a PatchableDashboard type or + a IO[bytes] type. Required. + :type properties: ~azure.mgmt.portal.models.PatchableDashboard or IO[bytes] + :return: Dashboard or the result of cls(response) + :rtype: ~azure.mgmt.portal.models.Dashboard :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -416,21 +491,19 @@ async def update( _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] - cls = kwargs.pop("cls", None) # type: ClsType[Optional[_models.Dashboard]] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.Dashboard] = kwargs.pop("cls", None) content_type = content_type or "application/json" _json = None _content = None - if isinstance(dashboard, (IO, bytes)): - _content = dashboard + if isinstance(properties, (IOBase, bytes)): + _content = properties else: - _json = self._serialize.body(dashboard, "PatchableDashboard") + _json = self._serialize.body(properties, "PatchableDashboard") - request = build_update_request( + _request = build_update_request( resource_group_name=resource_group_name, dashboard_name=dashboard_name, subscription_id=self._config.subscription_id, @@ -438,55 +511,44 @@ async def update( content_type=content_type, json=_json, content=_content, - template_url=self.update.metadata["url"], headers=_headers, params=_params, ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore + _request.url = self._client.format_url(_request.url) - pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs + _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, 404]: + if response.status_code not in [200]: map_error(status_code=response.status_code, response=response, error_map=error_map) error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) - deserialized = None - if response.status_code == 200: - deserialized = self._deserialize("Dashboard", pipeline_response) + deserialized = self._deserialize("Dashboard", pipeline_response.http_response) if cls: - return cls(pipeline_response, deserialized, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore - return deserialized + return deserialized # type: ignore - update.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}"} # type: ignore - - @distributed_trace - def list_by_resource_group(self, resource_group_name: str, **kwargs: Any) -> AsyncIterable["_models.Dashboard"]: - """Gets all the Dashboards within a resource group. + @distributed_trace_async + async def delete(self, resource_group_name: str, dashboard_name: str, **kwargs: Any) -> None: + """Deletes the Dashboard. - :param resource_group_name: The name of the resource group. Required. + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. :type resource_group_name: str - :keyword callable cls: A custom type or function that will be passed the direct response - :return: An iterator like instance of either Dashboard or the result of cls(response) - :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.portal.models.Dashboard] + :param dashboard_name: The name of the dashboard. Required. + :type dashboard_name: str + :return: None or the result of cls(response) + :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - _headers = kwargs.pop("headers", {}) or {} - _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - cls = kwargs.pop("cls", None) # type: ClsType[_models.DashboardListResult] - - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -494,142 +556,33 @@ def list_by_resource_group(self, resource_group_name: str, **kwargs: Any) -> Asy } error_map.update(kwargs.pop("error_map", {}) or {}) - def prepare_request(next_link=None): - if not next_link: - - request = build_list_by_resource_group_request( - resource_group_name=resource_group_name, - subscription_id=self._config.subscription_id, - api_version=api_version, - template_url=self.list_by_resource_group.metadata["url"], - headers=_headers, - params=_params, - ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore - - 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 = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore - request.method = "GET" - return request - - async def extract_data(pipeline_response): - deserialized = self._deserialize("DashboardListResult", pipeline_response) - list_of_elem = deserialized.value - if cls: - list_of_elem = cls(list_of_elem) - return deserialized.next_link or None, AsyncList(list_of_elem) - - async def get_next(next_link=None): - request = prepare_request(next_link) - - pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs - ) - response = pipeline_response.http_response - - if response.status_code not in [200]: - map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) - raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) - - return pipeline_response - - return AsyncItemPaged(get_next, extract_data) - - list_by_resource_group.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards"} # type: ignore - - @distributed_trace - def list_by_subscription(self, **kwargs: Any) -> AsyncIterable["_models.Dashboard"]: - """Gets all the dashboards within a subscription. - - :keyword callable cls: A custom type or function that will be passed the direct response - :return: An iterator like instance of either Dashboard or the result of cls(response) - :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.portal.models.Dashboard] - :raises ~azure.core.exceptions.HttpResponseError: - """ _headers = kwargs.pop("headers", {}) or {} _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - cls = kwargs.pop("cls", None) # type: ClsType[_models.DashboardListResult] - - error_map = { - 401: ClientAuthenticationError, - 404: ResourceNotFoundError, - 409: ResourceExistsError, - 304: ResourceNotModifiedError, - } - error_map.update(kwargs.pop("error_map", {}) or {}) - - def prepare_request(next_link=None): - if not next_link: - - request = build_list_by_subscription_request( - subscription_id=self._config.subscription_id, - api_version=api_version, - template_url=self.list_by_subscription.metadata["url"], - headers=_headers, - params=_params, - ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore - - 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 = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore - request.method = "GET" - return request - - async def extract_data(pipeline_response): - deserialized = self._deserialize("DashboardListResult", pipeline_response) - list_of_elem = deserialized.value - if cls: - list_of_elem = cls(list_of_elem) - return deserialized.next_link or None, AsyncList(list_of_elem) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) - async def get_next(next_link=None): - request = prepare_request(next_link) - - pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs - ) - response = pipeline_response.http_response + _request = build_delete_request( + resource_group_name=resource_group_name, + dashboard_name=dashboard_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) - if response.status_code not in [200]: - map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) - raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) - return pipeline_response + response = pipeline_response.http_response - return AsyncItemPaged(get_next, extract_data) + if response.status_code not in [200, 204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) - list_by_subscription.metadata = {"url": "/subscriptions/{subscriptionId}/providers/Microsoft.Portal/dashboards"} # type: ignore + if cls: + return cls(pipeline_response, None, {}) # type: ignore diff --git a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/operations/_list_tenant_configuration_violations_operations.py b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/operations/_list_tenant_configuration_violations_operations.py index 54db4063adc2..5cb28b87178c 100644 --- a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/operations/_list_tenant_configuration_violations_operations.py +++ b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/operations/_list_tenant_configuration_violations_operations.py @@ -1,4 +1,3 @@ -# pylint: disable=too-many-lines # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -20,25 +19,23 @@ map_error, ) from azure.core.pipeline import PipelineResponse -from azure.core.pipeline.transport import AsyncHttpResponse -from azure.core.rest import HttpRequest +from azure.core.rest import AsyncHttpResponse, HttpRequest from azure.core.tracing.decorator import distributed_trace from azure.core.utils import case_insensitive_dict from azure.mgmt.core.exceptions import ARMErrorFormat from ... import models as _models -from ..._vendor import _convert_request from ...operations._list_tenant_configuration_violations_operations import build_list_request -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports + from typing import MutableMapping # type: ignore T = TypeVar("T") ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] -class ListTenantConfigurationViolationsOperations: +class ListTenantConfigurationViolationsOperations: # pylint: disable=name-too-long """ .. warning:: **DO NOT** instantiate this class directly. @@ -61,7 +58,6 @@ def __init__(self, *args, **kwargs) -> None: def list(self, **kwargs: Any) -> AsyncIterable["_models.Violation"]: """Gets list of items that violate tenant's configuration. - :keyword callable cls: A custom type or function that will be passed the direct response :return: An iterator like instance of either Violation or the result of cls(response) :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.portal.models.Violation] :raises ~azure.core.exceptions.HttpResponseError: @@ -69,12 +65,10 @@ def list(self, **kwargs: Any) -> AsyncIterable["_models.Violation"]: _headers = kwargs.pop("headers", {}) or {} _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - cls = kwargs.pop("cls", None) # type: ClsType[_models.ViolationsList] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.ViolationsList] = kwargs.pop("cls", None) - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -85,14 +79,12 @@ def list(self, **kwargs: Any) -> AsyncIterable["_models.Violation"]: def prepare_request(next_link=None): if not next_link: - request = build_list_request( + _request = build_list_request( api_version=api_version, - template_url=self.list.metadata["url"], headers=_headers, params=_params, ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore + _request.url = self._client.format_url(_request.url) else: # make call to next link with the client's api-version @@ -104,26 +96,26 @@ def prepare_request(next_link=None): } ) _next_request_params["api-version"] = self._config.api_version - request = HttpRequest( + _request = HttpRequest( "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore - request.method = "GET" - return request + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request async def extract_data(pipeline_response): deserialized = self._deserialize("ViolationsList", pipeline_response) list_of_elem = deserialized.value if cls: - list_of_elem = cls(list_of_elem) + list_of_elem = cls(list_of_elem) # type: ignore return deserialized.next_link or None, AsyncList(list_of_elem) async def get_next(next_link=None): - request = prepare_request(next_link) + _request = prepare_request(next_link) - pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response @@ -135,5 +127,3 @@ async def get_next(next_link=None): return pipeline_response return AsyncItemPaged(get_next, extract_data) - - list.metadata = {"url": "/providers/Microsoft.Portal/listTenantConfigurationViolations"} # type: ignore diff --git a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/operations/_operations.py b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/operations/_operations.py index 2ce502de0c94..d184ad1eccc6 100644 --- a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/operations/_operations.py +++ b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/operations/_operations.py @@ -1,4 +1,3 @@ -# pylint: disable=too-many-lines # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -20,20 +19,18 @@ map_error, ) from azure.core.pipeline import PipelineResponse -from azure.core.pipeline.transport import AsyncHttpResponse -from azure.core.rest import HttpRequest +from azure.core.rest import AsyncHttpResponse, HttpRequest from azure.core.tracing.decorator import distributed_trace from azure.core.utils import case_insensitive_dict from azure.mgmt.core.exceptions import ARMErrorFormat from ... import models as _models -from ..._vendor import _convert_request from ...operations._operations import build_list_request -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports + from typing import MutableMapping # type: ignore T = TypeVar("T") ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] @@ -58,25 +55,20 @@ def __init__(self, *args, **kwargs) -> None: self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") @distributed_trace - def list(self, **kwargs: Any) -> AsyncIterable["_models.ResourceProviderOperation"]: - """The Microsoft Portal operations API. - - :keyword callable cls: A custom type or function that will be passed the direct response - :return: An iterator like instance of either ResourceProviderOperation or the result of - cls(response) - :rtype: - ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.portal.models.ResourceProviderOperation] + def list(self, **kwargs: Any) -> AsyncIterable["_models.Operation"]: + """List the operations for the provider. + + :return: An iterator like instance of either Operation or the result of cls(response) + :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.portal.models.Operation] :raises ~azure.core.exceptions.HttpResponseError: """ _headers = kwargs.pop("headers", {}) or {} _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - cls = kwargs.pop("cls", None) # type: ClsType[_models.ResourceProviderOperationList] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.OperationListResult] = kwargs.pop("cls", None) - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -87,14 +79,12 @@ def list(self, **kwargs: Any) -> AsyncIterable["_models.ResourceProviderOperatio def prepare_request(next_link=None): if not next_link: - request = build_list_request( + _request = build_list_request( api_version=api_version, - template_url=self.list.metadata["url"], headers=_headers, params=_params, ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore + _request.url = self._client.format_url(_request.url) else: # make call to next link with the client's api-version @@ -106,26 +96,26 @@ def prepare_request(next_link=None): } ) _next_request_params["api-version"] = self._config.api_version - request = HttpRequest( + _request = HttpRequest( "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore - request.method = "GET" - return request + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request async def extract_data(pipeline_response): - deserialized = self._deserialize("ResourceProviderOperationList", pipeline_response) + deserialized = self._deserialize("OperationListResult", pipeline_response) list_of_elem = deserialized.value if cls: - list_of_elem = cls(list_of_elem) + list_of_elem = cls(list_of_elem) # type: ignore return deserialized.next_link or None, AsyncList(list_of_elem) async def get_next(next_link=None): - request = prepare_request(next_link) + _request = prepare_request(next_link) - pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response @@ -137,5 +127,3 @@ async def get_next(next_link=None): return pipeline_response return AsyncItemPaged(get_next, extract_data) - - list.metadata = {"url": "/providers/Microsoft.Portal/operations"} # type: ignore diff --git a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/operations/_tenant_configurations_operations.py b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/operations/_tenant_configurations_operations.py index 6882276c3b18..079675ce8173 100644 --- a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/operations/_tenant_configurations_operations.py +++ b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/aio/operations/_tenant_configurations_operations.py @@ -1,4 +1,3 @@ -# pylint: disable=too-many-lines # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -6,6 +5,7 @@ # Code generated by Microsoft (R) AutoRest Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +from io import IOBase import sys from typing import Any, AsyncIterable, Callable, Dict, IO, Optional, TypeVar, Union, overload import urllib.parse @@ -20,15 +20,13 @@ map_error, ) from azure.core.pipeline import PipelineResponse -from azure.core.pipeline.transport import AsyncHttpResponse -from azure.core.rest import HttpRequest +from azure.core.rest import AsyncHttpResponse, HttpRequest from azure.core.tracing.decorator import distributed_trace from azure.core.tracing.decorator_async import distributed_trace_async from azure.core.utils import case_insensitive_dict from azure.mgmt.core.exceptions import ARMErrorFormat from ... import models as _models -from ..._vendor import _convert_request from ...operations._tenant_configurations_operations import ( build_create_request, build_delete_request, @@ -36,10 +34,10 @@ build_list_request, ) -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports + from typing import MutableMapping # type: ignore T = TypeVar("T") ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] @@ -67,7 +65,6 @@ def __init__(self, *args, **kwargs) -> None: def list(self, **kwargs: Any) -> AsyncIterable["_models.Configuration"]: """Gets list of the tenant configurations. - :keyword callable cls: A custom type or function that will be passed the direct response :return: An iterator like instance of either Configuration or the result of cls(response) :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.portal.models.Configuration] :raises ~azure.core.exceptions.HttpResponseError: @@ -75,12 +72,10 @@ def list(self, **kwargs: Any) -> AsyncIterable["_models.Configuration"]: _headers = kwargs.pop("headers", {}) or {} _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - cls = kwargs.pop("cls", None) # type: ClsType[_models.ConfigurationList] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.ConfigurationListResult] = kwargs.pop("cls", None) - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -91,14 +86,12 @@ def list(self, **kwargs: Any) -> AsyncIterable["_models.Configuration"]: def prepare_request(next_link=None): if not next_link: - request = build_list_request( + _request = build_list_request( api_version=api_version, - template_url=self.list.metadata["url"], headers=_headers, params=_params, ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore + _request.url = self._client.format_url(_request.url) else: # make call to next link with the client's api-version @@ -110,26 +103,26 @@ def prepare_request(next_link=None): } ) _next_request_params["api-version"] = self._config.api_version - request = HttpRequest( + _request = HttpRequest( "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore - request.method = "GET" - return request + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request async def extract_data(pipeline_response): - deserialized = self._deserialize("ConfigurationList", pipeline_response) + deserialized = self._deserialize("ConfigurationListResult", pipeline_response) list_of_elem = deserialized.value if cls: - list_of_elem = cls(list_of_elem) + list_of_elem = cls(list_of_elem) # type: ignore return deserialized.next_link or None, AsyncList(list_of_elem) async def get_next(next_link=None): - request = prepare_request(next_link) + _request = prepare_request(next_link) - pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response @@ -142,22 +135,17 @@ async def get_next(next_link=None): return AsyncItemPaged(get_next, extract_data) - list.metadata = {"url": "/providers/Microsoft.Portal/tenantConfigurations"} # type: ignore - @distributed_trace_async - async def get( - self, configuration_name: Union[str, _models.ConfigurationName], **kwargs: Any - ) -> Optional[_models.Configuration]: + async def get(self, configuration_name: str, **kwargs: Any) -> _models.Configuration: """Gets the tenant configuration. - :param configuration_name: The configuration name. Value must be 'default'. "default" Required. - :type configuration_name: str or ~azure.mgmt.portal.models.ConfigurationName - :keyword callable cls: A custom type or function that will be passed the direct response - :return: Configuration or None or the result of cls(response) - :rtype: ~azure.mgmt.portal.models.Configuration or None + :param configuration_name: The name of the Configuration. Required. + :type configuration_name: str + :return: Configuration or the result of cls(response) + :rtype: ~azure.mgmt.portal.models.Configuration :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -168,48 +156,41 @@ async def get( _headers = kwargs.pop("headers", {}) or {} _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - cls = kwargs.pop("cls", None) # type: ClsType[Optional[_models.Configuration]] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.Configuration] = kwargs.pop("cls", None) - request = build_get_request( + _request = build_get_request( configuration_name=configuration_name, api_version=api_version, - template_url=self.get.metadata["url"], headers=_headers, params=_params, ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore + _request.url = self._client.format_url(_request.url) - pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs + _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, 404]: + if response.status_code not in [200]: map_error(status_code=response.status_code, response=response, error_map=error_map) error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) - deserialized = None - if response.status_code == 200: - deserialized = self._deserialize("Configuration", pipeline_response) + deserialized = self._deserialize("Configuration", pipeline_response.http_response) if cls: - return cls(pipeline_response, deserialized, {}) - - return deserialized + return cls(pipeline_response, deserialized, {}) # type: ignore - get.metadata = {"url": "/providers/Microsoft.Portal/tenantConfigurations/{configurationName}"} # type: ignore + return deserialized # type: ignore @overload async def create( self, - configuration_name: Union[str, _models.ConfigurationName], - tenant_configuration: _models.Configuration, + configuration_name: str, + resource: _models.Configuration, *, content_type: str = "application/json", **kwargs: Any @@ -217,15 +198,13 @@ async def create( """Create the tenant configuration. If configuration already exists - update it. User has to be a Tenant Admin for this operation. - :param configuration_name: The configuration name. Value must be 'default'. "default" Required. - :type configuration_name: str or ~azure.mgmt.portal.models.ConfigurationName - :param tenant_configuration: The parameters required to create or update tenant configuration. - Required. - :type tenant_configuration: ~azure.mgmt.portal.models.Configuration + :param configuration_name: The name of the Configuration. Required. + :type configuration_name: str + :param resource: The parameters required to create or update tenant configuration. Required. + :type resource: ~azure.mgmt.portal.models.Configuration :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword callable cls: A custom type or function that will be passed the direct response :return: Configuration or the result of cls(response) :rtype: ~azure.mgmt.portal.models.Configuration :raises ~azure.core.exceptions.HttpResponseError: @@ -233,25 +212,18 @@ async def create( @overload async def create( - self, - configuration_name: Union[str, _models.ConfigurationName], - tenant_configuration: IO, - *, - content_type: str = "application/json", - **kwargs: Any + self, configuration_name: str, resource: IO[bytes], *, content_type: str = "application/json", **kwargs: Any ) -> _models.Configuration: """Create the tenant configuration. If configuration already exists - update it. User has to be a Tenant Admin for this operation. - :param configuration_name: The configuration name. Value must be 'default'. "default" Required. - :type configuration_name: str or ~azure.mgmt.portal.models.ConfigurationName - :param tenant_configuration: The parameters required to create or update tenant configuration. - Required. - :type tenant_configuration: IO + :param configuration_name: The name of the Configuration. Required. + :type configuration_name: str + :param resource: The parameters required to create or update tenant configuration. 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 - :keyword callable cls: A custom type or function that will be passed the direct response :return: Configuration or the result of cls(response) :rtype: ~azure.mgmt.portal.models.Configuration :raises ~azure.core.exceptions.HttpResponseError: @@ -259,28 +231,21 @@ async def create( @distributed_trace_async async def create( - self, - configuration_name: Union[str, _models.ConfigurationName], - tenant_configuration: Union[_models.Configuration, IO], - **kwargs: Any + self, configuration_name: str, resource: Union[_models.Configuration, IO[bytes]], **kwargs: Any ) -> _models.Configuration: """Create the tenant configuration. If configuration already exists - update it. User has to be a Tenant Admin for this operation. - :param configuration_name: The configuration name. Value must be 'default'. "default" Required. - :type configuration_name: str or ~azure.mgmt.portal.models.ConfigurationName - :param tenant_configuration: The parameters required to create or update tenant configuration. - Is either a model type or a IO type. Required. - :type tenant_configuration: ~azure.mgmt.portal.models.Configuration or IO - :keyword content_type: Body Parameter content-type. Known values are: 'application/json'. - Default value is None. - :paramtype content_type: str - :keyword callable cls: A custom type or function that will be passed the direct response + :param configuration_name: The name of the Configuration. Required. + :type configuration_name: str + :param resource: The parameters required to create or update tenant configuration. Is either a + Configuration type or a IO[bytes] type. Required. + :type resource: ~azure.mgmt.portal.models.Configuration or IO[bytes] :return: Configuration or the result of cls(response) :rtype: ~azure.mgmt.portal.models.Configuration :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -291,35 +256,32 @@ async def create( _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] - cls = kwargs.pop("cls", None) # type: ClsType[_models.Configuration] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.Configuration] = kwargs.pop("cls", None) content_type = content_type or "application/json" _json = None _content = None - if isinstance(tenant_configuration, (IO, bytes)): - _content = tenant_configuration + if isinstance(resource, (IOBase, bytes)): + _content = resource else: - _json = self._serialize.body(tenant_configuration, "Configuration") + _json = self._serialize.body(resource, "Configuration") - request = build_create_request( + _request = build_create_request( configuration_name=configuration_name, api_version=api_version, content_type=content_type, json=_json, content=_content, - template_url=self.create.metadata["url"], headers=_headers, params=_params, ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore + _request.url = self._client.format_url(_request.url) - pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response @@ -329,33 +291,24 @@ async def create( error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) - if response.status_code == 200: - deserialized = self._deserialize("Configuration", pipeline_response) - - if response.status_code == 201: - deserialized = self._deserialize("Configuration", pipeline_response) + deserialized = self._deserialize("Configuration", pipeline_response.http_response) if cls: - return cls(pipeline_response, deserialized, {}) - - return deserialized + return cls(pipeline_response, deserialized, {}) # type: ignore - create.metadata = {"url": "/providers/Microsoft.Portal/tenantConfigurations/{configurationName}"} # type: ignore + return deserialized # type: ignore @distributed_trace_async - async def delete( # pylint: disable=inconsistent-return-statements - self, configuration_name: Union[str, _models.ConfigurationName], **kwargs: Any - ) -> None: + async def delete(self, configuration_name: str, **kwargs: Any) -> None: """Delete the tenant configuration. User has to be a Tenant Admin for this operation. - :param configuration_name: The configuration name. Value must be 'default'. "default" Required. - :type configuration_name: str or ~azure.mgmt.portal.models.ConfigurationName - :keyword callable cls: A custom type or function that will be passed the direct response + :param configuration_name: The name of the Configuration. Required. + :type configuration_name: str :return: None or the result of cls(response) :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -366,23 +319,20 @@ async def delete( # pylint: disable=inconsistent-return-statements _headers = kwargs.pop("headers", {}) or {} _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - cls = kwargs.pop("cls", None) # type: ClsType[None] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) - request = build_delete_request( + _request = build_delete_request( configuration_name=configuration_name, api_version=api_version, - template_url=self.delete.metadata["url"], headers=_headers, params=_params, ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore + _request.url = self._client.format_url(_request.url) - pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response @@ -393,6 +343,4 @@ async def delete( # pylint: disable=inconsistent-return-statements raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) if cls: - return cls(pipeline_response, None, {}) - - delete.metadata = {"url": "/providers/Microsoft.Portal/tenantConfigurations/{configurationName}"} # type: ignore + return cls(pipeline_response, None, {}) # type: ignore diff --git a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/models/__init__.py b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/models/__init__.py index f5c0bc06d6e0..adacbd9daa1b 100644 --- a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/models/__init__.py +++ b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/models/__init__.py @@ -5,59 +5,88 @@ # Code generated by Microsoft (R) AutoRest Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._models_py3 import Configuration -from ._models_py3 import ConfigurationList -from ._models_py3 import Dashboard -from ._models_py3 import DashboardLens -from ._models_py3 import DashboardListResult -from ._models_py3 import DashboardPartMetadata -from ._models_py3 import DashboardParts -from ._models_py3 import DashboardPartsPosition -from ._models_py3 import ErrorDefinition -from ._models_py3 import ErrorResponse -from ._models_py3 import MarkdownPartMetadata -from ._models_py3 import MarkdownPartMetadataSettings -from ._models_py3 import MarkdownPartMetadataSettingsContent -from ._models_py3 import MarkdownPartMetadataSettingsContentSettings -from ._models_py3 import PatchableDashboard -from ._models_py3 import ProxyResource -from ._models_py3 import Resource -from ._models_py3 import ResourceProviderOperation -from ._models_py3 import ResourceProviderOperationDisplay -from ._models_py3 import ResourceProviderOperationList -from ._models_py3 import Violation -from ._models_py3 import ViolationsList +from typing import TYPE_CHECKING -from ._portal_enums import ConfigurationName +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + + +from ._models_py3 import ( # type: ignore + Configuration, + ConfigurationListResult, + ConfigurationProperties, + Dashboard, + DashboardLens, + DashboardListResult, + DashboardPartMetadata, + DashboardParts, + DashboardPartsPosition, + DashboardProperties, + DashboardPropertiesWithProvisioningState, + ErrorAdditionalInfo, + ErrorDetail, + ErrorResponse, + MarkdownPartMetadata, + MarkdownPartMetadataSettings, + MarkdownPartMetadataSettingsContent, + Operation, + OperationDisplay, + OperationListResult, + PatchableDashboard, + ProxyResource, + Resource, + SystemData, + TrackedResource, + Violation, + ViolationsList, +) + +from ._portal_enums import ( # type: ignore + ActionType, + CreatedByType, + DashboardPartMetadataType, + Origin, + ResourceProvisioningState, +) from ._patch import __all__ as _patch_all -from ._patch import * # type: ignore # pylint: disable=unused-wildcard-import +from ._patch import * from ._patch import patch_sdk as _patch_sdk __all__ = [ "Configuration", - "ConfigurationList", + "ConfigurationListResult", + "ConfigurationProperties", "Dashboard", "DashboardLens", "DashboardListResult", "DashboardPartMetadata", "DashboardParts", "DashboardPartsPosition", - "ErrorDefinition", + "DashboardProperties", + "DashboardPropertiesWithProvisioningState", + "ErrorAdditionalInfo", + "ErrorDetail", "ErrorResponse", "MarkdownPartMetadata", "MarkdownPartMetadataSettings", "MarkdownPartMetadataSettingsContent", - "MarkdownPartMetadataSettingsContentSettings", + "Operation", + "OperationDisplay", + "OperationListResult", "PatchableDashboard", "ProxyResource", "Resource", - "ResourceProviderOperation", - "ResourceProviderOperationDisplay", - "ResourceProviderOperationList", + "SystemData", + "TrackedResource", "Violation", "ViolationsList", - "ConfigurationName", + "ActionType", + "CreatedByType", + "DashboardPartMetadataType", + "Origin", + "ResourceProvisioningState", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/models/_models_py3.py b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/models/_models_py3.py index 5a89e85c9369..0f711b1a3531 100644 --- a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/models/_models_py3.py +++ b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/models/_models_py3.py @@ -1,5 +1,5 @@ -# coding=utf-8 # pylint: disable=too-many-lines +# coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See License.txt in the project root for license information. @@ -7,18 +7,18 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +import datetime import sys -from typing import Any, Dict, List, Optional, TYPE_CHECKING +from typing import Any, Dict, List, Optional, TYPE_CHECKING, Union from .. import _serialization if sys.version_info >= (3, 9): from collections.abc import MutableMapping else: - from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports + from typing import MutableMapping # type: ignore if TYPE_CHECKING: - # pylint: disable=unused-import,ungrouped-imports from .. import models as _models JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object @@ -28,130 +28,131 @@ class Resource(_serialization.Model): 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}. + :ivar id: Fully qualified resource ID for the resource. E.g. + "/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.portal.models.SystemData """ _validation = { "id": {"readonly": True}, "name": {"readonly": True}, "type": {"readonly": True}, + "system_data": {"readonly": True}, } _attribute_map = { "id": {"key": "id", "type": "str"}, "name": {"key": "name", "type": "str"}, "type": {"key": "type", "type": "str"}, + "system_data": {"key": "systemData", "type": "SystemData"}, } - def __init__(self, **kwargs): + def __init__(self, **kwargs: Any) -> None: """ """ super().__init__(**kwargs) self.id = None self.name = None self.type = None + self.system_data = None class ProxyResource(Resource): - """The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location. + """The resource model definition for a Azure Resource Manager proxy resource. It will not have + tags and a location. 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}. + :ivar id: Fully qualified resource ID for the resource. E.g. + "/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.portal.models.SystemData """ - _validation = { - "id": {"readonly": True}, - "name": {"readonly": True}, - "type": {"readonly": True}, - } - - _attribute_map = { - "id": {"key": "id", "type": "str"}, - "name": {"key": "name", "type": "str"}, - "type": {"key": "type", "type": "str"}, - } - - def __init__(self, **kwargs): - """ """ - super().__init__(**kwargs) - class Configuration(ProxyResource): - """Tenant configuration. + """The tenant configuration resource definition. 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}. + :ivar id: Fully qualified resource ID for the resource. E.g. + "/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 enforce_private_markdown_storage: When flag is set to true Markdown tile will require - external storage configuration (URI). The inline content configuration will be prohibited. - :vartype enforce_private_markdown_storage: bool + :ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy + information. + :vartype system_data: ~azure.mgmt.portal.models.SystemData + :ivar properties: The resource-specific properties for this resource. + :vartype properties: ~azure.mgmt.portal.models.ConfigurationProperties """ _validation = { "id": {"readonly": True}, "name": {"readonly": True}, "type": {"readonly": True}, + "system_data": {"readonly": True}, } _attribute_map = { "id": {"key": "id", "type": "str"}, "name": {"key": "name", "type": "str"}, "type": {"key": "type", "type": "str"}, - "enforce_private_markdown_storage": {"key": "properties.enforcePrivateMarkdownStorage", "type": "bool"}, + "system_data": {"key": "systemData", "type": "SystemData"}, + "properties": {"key": "properties", "type": "ConfigurationProperties"}, } - def __init__(self, *, enforce_private_markdown_storage: Optional[bool] = None, **kwargs): + def __init__(self, *, properties: Optional["_models.ConfigurationProperties"] = None, **kwargs: Any) -> None: """ - :keyword enforce_private_markdown_storage: When flag is set to true Markdown tile will require - external storage configuration (URI). The inline content configuration will be prohibited. - :paramtype enforce_private_markdown_storage: bool + :keyword properties: The resource-specific properties for this resource. + :paramtype properties: ~azure.mgmt.portal.models.ConfigurationProperties """ super().__init__(**kwargs) - self.enforce_private_markdown_storage = enforce_private_markdown_storage + self.properties = properties -class ConfigurationList(_serialization.Model): - """List of tenant configurations. +class ConfigurationListResult(_serialization.Model): + """The response of a Configuration list operation. - :ivar value: The array of tenant configurations. + All required parameters must be populated in order to send to server. + + :ivar value: The Configuration items on this page. Required. :vartype value: list[~azure.mgmt.portal.models.Configuration] - :ivar next_link: The URL to use for getting the next set of results. + :ivar next_link: The link to the next page of items. :vartype next_link: str """ + _validation = { + "value": {"required": True}, + } + _attribute_map = { "value": {"key": "value", "type": "[Configuration]"}, "next_link": {"key": "nextLink", "type": "str"}, } - def __init__( - self, *, value: Optional[List["_models.Configuration"]] = None, next_link: Optional[str] = None, **kwargs - ): + def __init__(self, *, value: List["_models.Configuration"], next_link: Optional[str] = None, **kwargs: Any) -> None: """ - :keyword value: The array of tenant configurations. + :keyword value: The Configuration items on this page. Required. :paramtype value: list[~azure.mgmt.portal.models.Configuration] - :keyword next_link: The URL to use for getting the next set of results. + :keyword next_link: The link to the next page of items. :paramtype next_link: str """ super().__init__(**kwargs) @@ -159,33 +160,69 @@ def __init__( self.next_link = next_link -class Dashboard(_serialization.Model): - """The shared dashboard resource definition. +class ConfigurationProperties(_serialization.Model): + """Tenant Configuration Properties with Provisioning state. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar enforce_private_markdown_storage: When flag is set to true Markdown tile will require + external storage configuration (URI). The inline content configuration will be prohibited. + :vartype enforce_private_markdown_storage: bool + :ivar provisioning_state: The status of the last operation. Known values are: "Succeeded", + "Failed", and "Canceled". + :vartype provisioning_state: str or ~azure.mgmt.portal.models.ResourceProvisioningState + """ + + _validation = { + "provisioning_state": {"readonly": True}, + } + + _attribute_map = { + "enforce_private_markdown_storage": {"key": "enforcePrivateMarkdownStorage", "type": "bool"}, + "provisioning_state": {"key": "provisioningState", "type": "str"}, + } + + def __init__(self, *, enforce_private_markdown_storage: Optional[bool] = None, **kwargs: Any) -> None: + """ + :keyword enforce_private_markdown_storage: When flag is set to true Markdown tile will require + external storage configuration (URI). The inline content configuration will be prohibited. + :paramtype enforce_private_markdown_storage: bool + """ + super().__init__(**kwargs) + self.enforce_private_markdown_storage = enforce_private_markdown_storage + self.provisioning_state = None + + +class TrackedResource(Resource): + """The resource model definition for an Azure Resource Manager tracked top level resource which + has 'tags' and a 'location'. 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 Azure. + All required parameters must be populated in order to send to server. - :ivar id: Resource Id. + :ivar id: Fully qualified resource ID for the resource. E.g. + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long :vartype id: str - :ivar name: Resource name. + :ivar name: The name of the resource. :vartype name: str - :ivar type: Resource type. + :ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or + "Microsoft.Storage/storageAccounts". :vartype type: str - :ivar location: Resource location. Required. - :vartype location: str + :ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy + information. + :vartype system_data: ~azure.mgmt.portal.models.SystemData :ivar tags: Resource tags. :vartype tags: dict[str, str] - :ivar lenses: The dashboard lenses. - :vartype lenses: list[~azure.mgmt.portal.models.DashboardLens] - :ivar metadata: The dashboard metadata. - :vartype metadata: dict[str, JSON] + :ivar location: The geo-location where the resource lives. Required. + :vartype location: str """ _validation = { "id": {"readonly": True}, "name": {"readonly": True}, "type": {"readonly": True}, + "system_data": {"readonly": True}, "location": {"required": True}, } @@ -193,10 +230,65 @@ class Dashboard(_serialization.Model): "id": {"key": "id", "type": "str"}, "name": {"key": "name", "type": "str"}, "type": {"key": "type", "type": "str"}, + "system_data": {"key": "systemData", "type": "SystemData"}, + "tags": {"key": "tags", "type": "{str}"}, "location": {"key": "location", "type": "str"}, + } + + def __init__(self, *, location: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any) -> None: + """ + :keyword tags: Resource tags. + :paramtype tags: dict[str, str] + :keyword location: The geo-location where the resource lives. Required. + :paramtype location: str + """ + super().__init__(**kwargs) + self.tags = tags + self.location = location + + +class Dashboard(TrackedResource): + """The shared dashboard resource definition. + + 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. E.g. + "/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.portal.models.SystemData + :ivar tags: Resource tags. + :vartype tags: dict[str, str] + :ivar location: The geo-location where the resource lives. Required. + :vartype location: str + :ivar properties: The resource-specific properties for this resource. + :vartype properties: ~azure.mgmt.portal.models.DashboardPropertiesWithProvisioningState + """ + + _validation = { + "id": {"readonly": True}, + "name": {"readonly": True}, + "type": {"readonly": True}, + "system_data": {"readonly": True}, + "location": {"required": True}, + } + + _attribute_map = { + "id": {"key": "id", "type": "str"}, + "name": {"key": "name", "type": "str"}, + "type": {"key": "type", "type": "str"}, + "system_data": {"key": "systemData", "type": "SystemData"}, "tags": {"key": "tags", "type": "{str}"}, - "lenses": {"key": "properties.lenses", "type": "[DashboardLens]"}, - "metadata": {"key": "properties.metadata", "type": "{object}"}, + "location": {"key": "location", "type": "str"}, + "properties": {"key": "properties", "type": "DashboardPropertiesWithProvisioningState"}, } def __init__( @@ -204,41 +296,32 @@ def __init__( *, location: str, tags: Optional[Dict[str, str]] = None, - lenses: Optional[List["_models.DashboardLens"]] = None, - metadata: Optional[Dict[str, JSON]] = None, - **kwargs - ): + properties: Optional["_models.DashboardPropertiesWithProvisioningState"] = None, + **kwargs: Any + ) -> None: """ - :keyword location: Resource location. Required. - :paramtype location: str :keyword tags: Resource tags. :paramtype tags: dict[str, str] - :keyword lenses: The dashboard lenses. - :paramtype lenses: list[~azure.mgmt.portal.models.DashboardLens] - :keyword metadata: The dashboard metadata. - :paramtype metadata: dict[str, JSON] + :keyword location: The geo-location where the resource lives. Required. + :paramtype location: str + :keyword properties: The resource-specific properties for this resource. + :paramtype properties: ~azure.mgmt.portal.models.DashboardPropertiesWithProvisioningState """ - super().__init__(**kwargs) - self.id = None - self.name = None - self.type = None - self.location = location - self.tags = tags - self.lenses = lenses - self.metadata = metadata + super().__init__(tags=tags, location=location, **kwargs) + self.properties = properties class DashboardLens(_serialization.Model): """A dashboard lens. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar order: The lens order. Required. :vartype order: int :ivar parts: The dashboard parts. Required. :vartype parts: list[~azure.mgmt.portal.models.DashboardParts] :ivar metadata: The dashboard len's metadata. - :vartype metadata: dict[str, JSON] + :vartype metadata: JSON """ _validation = { @@ -249,19 +332,19 @@ class DashboardLens(_serialization.Model): _attribute_map = { "order": {"key": "order", "type": "int"}, "parts": {"key": "parts", "type": "[DashboardParts]"}, - "metadata": {"key": "metadata", "type": "{object}"}, + "metadata": {"key": "metadata", "type": "object"}, } def __init__( - self, *, order: int, parts: List["_models.DashboardParts"], metadata: Optional[Dict[str, JSON]] = None, **kwargs - ): + self, *, order: int, parts: List["_models.DashboardParts"], metadata: Optional[JSON] = None, **kwargs: Any + ) -> None: """ :keyword order: The lens order. Required. :paramtype order: int :keyword parts: The dashboard parts. Required. :paramtype parts: list[~azure.mgmt.portal.models.DashboardParts] :keyword metadata: The dashboard len's metadata. - :paramtype metadata: dict[str, JSON] + :paramtype metadata: JSON """ super().__init__(**kwargs) self.order = order @@ -270,24 +353,30 @@ def __init__( class DashboardListResult(_serialization.Model): - """List of dashboards. + """The response of a Dashboard list operation. + + All required parameters must be populated in order to send to server. - :ivar value: The array of custom resource provider manifests. + :ivar value: The Dashboard items on this page. Required. :vartype value: list[~azure.mgmt.portal.models.Dashboard] - :ivar next_link: The URL to use for getting the next set of results. + :ivar next_link: The link to the next page of items. :vartype next_link: str """ + _validation = { + "value": {"required": True}, + } + _attribute_map = { "value": {"key": "value", "type": "[Dashboard]"}, "next_link": {"key": "nextLink", "type": "str"}, } - def __init__(self, *, value: Optional[List["_models.Dashboard"]] = None, next_link: Optional[str] = None, **kwargs): + def __init__(self, *, value: List["_models.Dashboard"], next_link: Optional[str] = None, **kwargs: Any) -> None: """ - :keyword value: The array of custom resource provider manifests. + :keyword value: The Dashboard items on this page. Required. :paramtype value: list[~azure.mgmt.portal.models.Dashboard] - :keyword next_link: The URL to use for getting the next set of results. + :keyword next_link: The link to the next page of items. :paramtype next_link: str """ super().__init__(**kwargs) @@ -301,13 +390,11 @@ class DashboardPartMetadata(_serialization.Model): You probably want to use the sub-classes and not this class directly. Known sub-classes are: MarkdownPartMetadata - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. - :ivar additional_properties: Unmatched properties from the message are deserialized to this - collection. - :vartype additional_properties: dict[str, any] - :ivar type: The type of dashboard part. Required. - :vartype type: str + :ivar type: The dashboard part metadata type. Required. + "Extension/HubsExtension/PartType/MarkdownPart" + :vartype type: str or ~azure.mgmt.portal.models.DashboardPartMetadataType """ _validation = { @@ -315,27 +402,21 @@ class DashboardPartMetadata(_serialization.Model): } _attribute_map = { - "additional_properties": {"key": "", "type": "{object}"}, "type": {"key": "type", "type": "str"}, } _subtype_map = {"type": {"Extension/HubsExtension/PartType/MarkdownPart": "MarkdownPartMetadata"}} - def __init__(self, *, additional_properties: Optional[Dict[str, Any]] = None, **kwargs): - """ - :keyword additional_properties: Unmatched properties from the message are deserialized to this - collection. - :paramtype additional_properties: dict[str, any] - """ + def __init__(self, **kwargs: Any) -> None: + """ """ super().__init__(**kwargs) - self.additional_properties = additional_properties - self.type = None # type: Optional[str] + self.type: Optional[str] = None class DashboardParts(_serialization.Model): """A dashboard part. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar position: The dashboard's part position. Required. :vartype position: ~azure.mgmt.portal.models.DashboardPartsPosition @@ -357,8 +438,8 @@ def __init__( *, position: "_models.DashboardPartsPosition", metadata: Optional["_models.DashboardPartMetadata"] = None, - **kwargs - ): + **kwargs: Any + ) -> None: """ :keyword position: The dashboard's part position. Required. :paramtype position: ~azure.mgmt.portal.models.DashboardPartsPosition @@ -373,7 +454,7 @@ def __init__( class DashboardPartsPosition(_serialization.Model): """The dashboard's part position. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. :ivar x: The dashboard's part x coordinate. Required. :vartype x: int @@ -384,7 +465,7 @@ class DashboardPartsPosition(_serialization.Model): :ivar col_span: The dashboard's part column span. Required. :vartype col_span: int :ivar metadata: The dashboard part's metadata. - :vartype metadata: dict[str, JSON] + :vartype metadata: JSON """ _validation = { @@ -399,12 +480,12 @@ class DashboardPartsPosition(_serialization.Model): "y": {"key": "y", "type": "int"}, "row_span": {"key": "rowSpan", "type": "int"}, "col_span": {"key": "colSpan", "type": "int"}, - "metadata": {"key": "metadata", "type": "{object}"}, + "metadata": {"key": "metadata", "type": "object"}, } def __init__( - self, *, x: int, y: int, row_span: int, col_span: int, metadata: Optional[Dict[str, JSON]] = None, **kwargs - ): + self, *, x: int, y: int, row_span: int, col_span: int, metadata: Optional[JSON] = None, **kwargs: Any + ) -> None: """ :keyword x: The dashboard's part x coordinate. Required. :paramtype x: int @@ -415,7 +496,7 @@ def __init__( :keyword col_span: The dashboard's part column span. Required. :paramtype col_span: int :keyword metadata: The dashboard part's metadata. - :paramtype metadata: dict[str, JSON] + :paramtype metadata: JSON """ super().__init__(**kwargs) self.x = x @@ -425,54 +506,160 @@ def __init__( self.metadata = metadata -class ErrorDefinition(_serialization.Model): - """Error definition. +class DashboardProperties(_serialization.Model): + """The shared dashboard properties. + + :ivar lenses: The dashboard lenses. + :vartype lenses: list[~azure.mgmt.portal.models.DashboardLens] + :ivar metadata: The dashboard metadata. + :vartype metadata: JSON + """ + + _attribute_map = { + "lenses": {"key": "lenses", "type": "[DashboardLens]"}, + "metadata": {"key": "metadata", "type": "object"}, + } + + def __init__( + self, *, lenses: Optional[List["_models.DashboardLens"]] = None, metadata: Optional[JSON] = None, **kwargs: Any + ) -> None: + """ + :keyword lenses: The dashboard lenses. + :paramtype lenses: list[~azure.mgmt.portal.models.DashboardLens] + :keyword metadata: The dashboard metadata. + :paramtype metadata: JSON + """ + super().__init__(**kwargs) + self.lenses = lenses + self.metadata = metadata + + +class DashboardPropertiesWithProvisioningState(_serialization.Model): + """Dashboard Properties with Provisioning state. Variables are only populated by the server, and will be ignored when sending a request. - :ivar code: Service specific error code which serves as the substatus for the HTTP error code. - :vartype code: int - :ivar message: Description of the error. + :ivar lenses: The dashboard lenses. + :vartype lenses: list[~azure.mgmt.portal.models.DashboardLens] + :ivar metadata: The dashboard metadata. + :vartype metadata: JSON + :ivar provisioning_state: The status of the last operation. Known values are: "Succeeded", + "Failed", and "Canceled". + :vartype provisioning_state: str or ~azure.mgmt.portal.models.ResourceProvisioningState + """ + + _validation = { + "provisioning_state": {"readonly": True}, + } + + _attribute_map = { + "lenses": {"key": "lenses", "type": "[DashboardLens]"}, + "metadata": {"key": "metadata", "type": "object"}, + "provisioning_state": {"key": "provisioningState", "type": "str"}, + } + + def __init__( + self, *, lenses: Optional[List["_models.DashboardLens"]] = None, metadata: Optional[JSON] = None, **kwargs: Any + ) -> None: + """ + :keyword lenses: The dashboard lenses. + :paramtype lenses: list[~azure.mgmt.portal.models.DashboardLens] + :keyword metadata: The dashboard metadata. + :paramtype metadata: JSON + """ + super().__init__(**kwargs) + self.lenses = lenses + self.metadata = metadata + self.provisioning_state = None + + +class ErrorAdditionalInfo(_serialization.Model): + """The resource management error additional info. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar type: The additional info type. + :vartype type: str + :ivar info: The additional info. + :vartype info: JSON + """ + + _validation = { + "type": {"readonly": True}, + "info": {"readonly": True}, + } + + _attribute_map = { + "type": {"key": "type", "type": "str"}, + "info": {"key": "info", "type": "object"}, + } + + def __init__(self, **kwargs: Any) -> None: + """ """ + super().__init__(**kwargs) + self.type = None + self.info = None + + +class ErrorDetail(_serialization.Model): + """The error detail. + + 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 details: Internal error details. - :vartype details: list[~azure.mgmt.portal.models.ErrorDefinition] + :ivar target: The error target. + :vartype target: str + :ivar details: The error details. + :vartype details: list[~azure.mgmt.portal.models.ErrorDetail] + :ivar additional_info: The error additional info. + :vartype additional_info: list[~azure.mgmt.portal.models.ErrorAdditionalInfo] """ _validation = { "code": {"readonly": True}, "message": {"readonly": True}, + "target": {"readonly": True}, "details": {"readonly": True}, + "additional_info": {"readonly": True}, } _attribute_map = { - "code": {"key": "code", "type": "int"}, + "code": {"key": "code", "type": "str"}, "message": {"key": "message", "type": "str"}, - "details": {"key": "details", "type": "[ErrorDefinition]"}, + "target": {"key": "target", "type": "str"}, + "details": {"key": "details", "type": "[ErrorDetail]"}, + "additional_info": {"key": "additionalInfo", "type": "[ErrorAdditionalInfo]"}, } - def __init__(self, **kwargs): + def __init__(self, **kwargs: Any) -> None: """ """ super().__init__(**kwargs) self.code = None self.message = None + self.target = None self.details = None + self.additional_info = None class ErrorResponse(_serialization.Model): - """Error response. + """Common error response for all Azure Resource Manager APIs to return error details for failed + operations. (This also follows the OData error response format.). - :ivar error: The error details. - :vartype error: ~azure.mgmt.portal.models.ErrorDefinition + :ivar error: The error object. + :vartype error: ~azure.mgmt.portal.models.ErrorDetail """ _attribute_map = { - "error": {"key": "error", "type": "ErrorDefinition"}, + "error": {"key": "error", "type": "ErrorDetail"}, } - def __init__(self, *, error: Optional["_models.ErrorDefinition"] = None, **kwargs): + def __init__(self, *, error: Optional["_models.ErrorDetail"] = None, **kwargs: Any) -> None: """ - :keyword error: The error details. - :paramtype error: ~azure.mgmt.portal.models.ErrorDefinition + :keyword error: The error object. + :paramtype error: ~azure.mgmt.portal.models.ErrorDetail """ super().__init__(**kwargs) self.error = error @@ -481,13 +668,11 @@ def __init__(self, *, error: Optional["_models.ErrorDefinition"] = None, **kwarg class MarkdownPartMetadata(DashboardPartMetadata): """Markdown part metadata. - All required parameters must be populated in order to send to Azure. + All required parameters must be populated in order to send to server. - :ivar additional_properties: Unmatched properties from the message are deserialized to this - collection. - :vartype additional_properties: dict[str, any] - :ivar type: The type of dashboard part. Required. - :vartype type: str + :ivar type: The dashboard part metadata type. Required. + "Extension/HubsExtension/PartType/MarkdownPart" + :vartype type: str or ~azure.mgmt.portal.models.DashboardPartMetadataType :ivar inputs: Input to dashboard part. :vartype inputs: list[JSON] :ivar settings: Markdown part settings. @@ -499,7 +684,6 @@ class MarkdownPartMetadata(DashboardPartMetadata): } _attribute_map = { - "additional_properties": {"key": "", "type": "{object}"}, "type": {"key": "type", "type": "str"}, "inputs": {"key": "inputs", "type": "[object]"}, "settings": {"key": "settings", "type": "MarkdownPartMetadataSettings"}, @@ -508,22 +692,18 @@ class MarkdownPartMetadata(DashboardPartMetadata): def __init__( self, *, - additional_properties: Optional[Dict[str, Any]] = None, inputs: Optional[List[JSON]] = None, settings: Optional["_models.MarkdownPartMetadataSettings"] = None, - **kwargs - ): + **kwargs: Any + ) -> None: """ - :keyword additional_properties: Unmatched properties from the message are deserialized to this - collection. - :paramtype additional_properties: dict[str, any] :keyword inputs: Input to dashboard part. :paramtype inputs: list[JSON] :keyword settings: Markdown part settings. :paramtype settings: ~azure.mgmt.portal.models.MarkdownPartMetadataSettings """ - super().__init__(additional_properties=additional_properties, **kwargs) - self.type = "Extension/HubsExtension/PartType/MarkdownPart" # type: str + super().__init__(**kwargs) + self.type: str = "Extension/HubsExtension/PartType/MarkdownPart" self.inputs = inputs self.settings = settings @@ -539,7 +719,9 @@ class MarkdownPartMetadataSettings(_serialization.Model): "content": {"key": "content", "type": "MarkdownPartMetadataSettingsContent"}, } - def __init__(self, *, content: Optional["_models.MarkdownPartMetadataSettingsContent"] = None, **kwargs): + def __init__( + self, *, content: Optional["_models.MarkdownPartMetadataSettingsContent"] = None, **kwargs: Any + ) -> None: """ :keyword content: The content of markdown part. :paramtype content: ~azure.mgmt.portal.models.MarkdownPartMetadataSettingsContent @@ -551,26 +733,6 @@ def __init__(self, *, content: Optional["_models.MarkdownPartMetadataSettingsCon class MarkdownPartMetadataSettingsContent(_serialization.Model): """The content of markdown part. - :ivar settings: The setting of the content of markdown part. - :vartype settings: ~azure.mgmt.portal.models.MarkdownPartMetadataSettingsContentSettings - """ - - _attribute_map = { - "settings": {"key": "settings", "type": "MarkdownPartMetadataSettingsContentSettings"}, - } - - def __init__(self, *, settings: Optional["_models.MarkdownPartMetadataSettingsContentSettings"] = None, **kwargs): - """ - :keyword settings: The setting of the content of markdown part. - :paramtype settings: ~azure.mgmt.portal.models.MarkdownPartMetadataSettingsContentSettings - """ - super().__init__(**kwargs) - self.settings = settings - - -class MarkdownPartMetadataSettingsContentSettings(_serialization.Model): - """The setting of the content of markdown part. - :ivar content: The content of the markdown part. :vartype content: str :ivar title: The title of the markdown part. @@ -599,8 +761,8 @@ def __init__( subtitle: Optional[str] = None, markdown_source: Optional[int] = None, markdown_uri: Optional[str] = None, - **kwargs - ): + **kwargs: Any + ) -> None: """ :keyword content: The content of the markdown part. :paramtype content: str @@ -621,97 +783,82 @@ def __init__( self.markdown_uri = markdown_uri -class PatchableDashboard(_serialization.Model): - """The shared dashboard resource definition. +class Operation(_serialization.Model): + """Details of a REST API operation, returned from the Resource Provider Operations API. - :ivar tags: Resource tags. - :vartype tags: dict[str, str] - :ivar lenses: The dashboard lenses. - :vartype lenses: list[~azure.mgmt.portal.models.DashboardLens] - :ivar metadata: The dashboard metadata. - :vartype metadata: dict[str, JSON] - """ - - _attribute_map = { - "tags": {"key": "tags", "type": "{str}"}, - "lenses": {"key": "properties.lenses", "type": "[DashboardLens]"}, - "metadata": {"key": "properties.metadata", "type": "{object}"}, - } - - def __init__( - self, - *, - tags: Optional[Dict[str, str]] = None, - lenses: Optional[List["_models.DashboardLens"]] = None, - metadata: Optional[Dict[str, JSON]] = None, - **kwargs - ): - """ - :keyword tags: Resource tags. - :paramtype tags: dict[str, str] - :keyword lenses: The dashboard lenses. - :paramtype lenses: list[~azure.mgmt.portal.models.DashboardLens] - :keyword metadata: The dashboard metadata. - :paramtype metadata: dict[str, JSON] - """ - super().__init__(**kwargs) - self.tags = tags - self.lenses = lenses - self.metadata = metadata - - -class ResourceProviderOperation(_serialization.Model): - """Supported operations of this resource provider. + Variables are only populated by the server, and will be ignored when sending a request. - :ivar name: Operation name, in format of {provider}/{resource}/{operation}. + :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: Indicates whether the operation applies to data-plane. - :vartype is_data_action: str - :ivar display: Display metadata associated with the operation. - :vartype display: ~azure.mgmt.portal.models.ResourceProviderOperationDisplay + :ivar is_data_action: Whether the operation applies to data-plane. This is "true" for + data-plane operations and "false" for ARM/control-plane operations. + :vartype is_data_action: bool + :ivar display: Localized display information for this particular operation. + :vartype display: ~azure.mgmt.portal.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.portal.models.Origin + :ivar action_type: Enum. Indicates the action type. "Internal" refers to actions that are for + internal only APIs. "Internal" + :vartype action_type: str or ~azure.mgmt.portal.models.ActionType """ + _validation = { + "name": {"readonly": True}, + "is_data_action": {"readonly": True}, + "origin": {"readonly": True}, + "action_type": {"readonly": True}, + } + _attribute_map = { "name": {"key": "name", "type": "str"}, - "is_data_action": {"key": "isDataAction", "type": "str"}, - "display": {"key": "display", "type": "ResourceProviderOperationDisplay"}, + "is_data_action": {"key": "isDataAction", "type": "bool"}, + "display": {"key": "display", "type": "OperationDisplay"}, + "origin": {"key": "origin", "type": "str"}, + "action_type": {"key": "actionType", "type": "str"}, } - def __init__( - self, - *, - name: Optional[str] = None, - is_data_action: Optional[str] = None, - display: Optional["_models.ResourceProviderOperationDisplay"] = None, - **kwargs - ): - """ - :keyword name: Operation name, in format of {provider}/{resource}/{operation}. - :paramtype name: str - :keyword is_data_action: Indicates whether the operation applies to data-plane. - :paramtype is_data_action: str - :keyword display: Display metadata associated with the operation. - :paramtype display: ~azure.mgmt.portal.models.ResourceProviderOperationDisplay + def __init__(self, *, display: Optional["_models.OperationDisplay"] = None, **kwargs: Any) -> None: + """ + :keyword display: Localized display information for this particular operation. + :paramtype display: ~azure.mgmt.portal.models.OperationDisplay """ super().__init__(**kwargs) - self.name = name - self.is_data_action = is_data_action + self.name = None + self.is_data_action = None self.display = display + self.origin = None + self.action_type = None + +class OperationDisplay(_serialization.Model): + """Localized display information for this particular operation. -class ResourceProviderOperationDisplay(_serialization.Model): - """Display metadata associated with the operation. + Variables are only populated by the server, and will be ignored when sending a request. - :ivar provider: Resource provider: Microsoft Custom Providers. + :ivar provider: The localized friendly form of the resource provider name, e.g. "Microsoft + Monitoring Insights" or "Microsoft Compute". :vartype provider: str - :ivar resource: Resource on which the operation is performed. + :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: Type of operation: get, read, delete, etc. + :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: Description of this operation. + :ivar description: The short, localized friendly description of the operation; suitable for + tool tips and detailed views. :vartype description: str """ + _validation = { + "provider": {"readonly": True}, + "resource": {"readonly": True}, + "operation": {"readonly": True}, + "description": {"readonly": True}, + } + _attribute_map = { "provider": {"key": "provider", "type": "str"}, "resource": {"key": "resource", "type": "str"}, @@ -719,62 +866,138 @@ class ResourceProviderOperationDisplay(_serialization.Model): "description": {"key": "description", "type": "str"}, } + def __init__(self, **kwargs: Any) -> None: + """ """ + super().__init__(**kwargs) + self.provider = None + self.resource = None + self.operation = None + self.description = None + + +class OperationListResult(_serialization.Model): + """A list of REST API operations supported by an Azure Resource Provider. It contains an URL link + to get the next set of results. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar value: List of operations supported by the resource provider. + :vartype value: list[~azure.mgmt.portal.models.Operation] + :ivar next_link: URL to get the next set of operation list results (if there are any). + :vartype next_link: str + """ + + _validation = { + "value": {"readonly": True}, + "next_link": {"readonly": True}, + } + + _attribute_map = { + "value": {"key": "value", "type": "[Operation]"}, + "next_link": {"key": "nextLink", "type": "str"}, + } + + def __init__(self, **kwargs: Any) -> None: + """ """ + super().__init__(**kwargs) + self.value = None + self.next_link = None + + +class PatchableDashboard(_serialization.Model): + """The shared dashboard resource definition. + + :ivar properties: The shared dashboard properties. + :vartype properties: ~azure.mgmt.portal.models.DashboardProperties + :ivar tags: Resource tags. + :vartype tags: dict[str, str] + """ + + _attribute_map = { + "properties": {"key": "properties", "type": "DashboardProperties"}, + "tags": {"key": "tags", "type": "{str}"}, + } + def __init__( self, *, - provider: Optional[str] = None, - resource: Optional[str] = None, - operation: Optional[str] = None, - description: Optional[str] = None, - **kwargs - ): - """ - :keyword provider: Resource provider: Microsoft Custom Providers. - :paramtype provider: str - :keyword resource: Resource on which the operation is performed. - :paramtype resource: str - :keyword operation: Type of operation: get, read, delete, etc. - :paramtype operation: str - :keyword description: Description of this operation. - :paramtype description: str + properties: Optional["_models.DashboardProperties"] = None, + tags: Optional[Dict[str, str]] = None, + **kwargs: Any + ) -> None: + """ + :keyword properties: The shared dashboard properties. + :paramtype properties: ~azure.mgmt.portal.models.DashboardProperties + :keyword tags: Resource tags. + :paramtype tags: dict[str, str] """ super().__init__(**kwargs) - self.provider = provider - self.resource = resource - self.operation = operation - self.description = description - + self.properties = properties + self.tags = tags -class ResourceProviderOperationList(_serialization.Model): - """Results of the request to list operations. - :ivar value: List of operations supported by this resource provider. - :vartype value: list[~azure.mgmt.portal.models.ResourceProviderOperation] - :ivar next_link: The URL to use for getting the next set of results. - :vartype next_link: str +class SystemData(_serialization.Model): + """Metadata pertaining to creation and last modification of the resource. + + :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.portal.models.CreatedByType + :ivar created_at: The timestamp of resource creation (UTC). + :vartype created_at: ~datetime.datetime + :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.portal.models.CreatedByType + :ivar last_modified_at: The timestamp of resource last modification (UTC). + :vartype last_modified_at: ~datetime.datetime """ _attribute_map = { - "value": {"key": "value", "type": "[ResourceProviderOperation]"}, - "next_link": {"key": "nextLink", "type": "str"}, + "created_by": {"key": "createdBy", "type": "str"}, + "created_by_type": {"key": "createdByType", "type": "str"}, + "created_at": {"key": "createdAt", "type": "iso-8601"}, + "last_modified_by": {"key": "lastModifiedBy", "type": "str"}, + "last_modified_by_type": {"key": "lastModifiedByType", "type": "str"}, + "last_modified_at": {"key": "lastModifiedAt", "type": "iso-8601"}, } def __init__( self, *, - value: Optional[List["_models.ResourceProviderOperation"]] = None, - next_link: Optional[str] = None, - **kwargs - ): - """ - :keyword value: List of operations supported by this resource provider. - :paramtype value: list[~azure.mgmt.portal.models.ResourceProviderOperation] - :keyword next_link: The URL to use for getting the next set of results. - :paramtype next_link: str + created_by: Optional[str] = None, + created_by_type: Optional[Union[str, "_models.CreatedByType"]] = None, + created_at: Optional[datetime.datetime] = None, + last_modified_by: Optional[str] = None, + last_modified_by_type: Optional[Union[str, "_models.CreatedByType"]] = None, + last_modified_at: Optional[datetime.datetime] = None, + **kwargs: Any + ) -> None: + """ + :keyword created_by: The identity that created the resource. + :paramtype created_by: str + :keyword created_by_type: The type of identity that created the resource. Known values are: + "User", "Application", "ManagedIdentity", and "Key". + :paramtype created_by_type: str or ~azure.mgmt.portal.models.CreatedByType + :keyword created_at: The timestamp of resource creation (UTC). + :paramtype created_at: ~datetime.datetime + :keyword last_modified_by: The identity that last modified the resource. + :paramtype last_modified_by: str + :keyword last_modified_by_type: The type of identity that last modified the resource. Known + values are: "User", "Application", "ManagedIdentity", and "Key". + :paramtype last_modified_by_type: str or ~azure.mgmt.portal.models.CreatedByType + :keyword last_modified_at: The timestamp of resource last modification (UTC). + :paramtype last_modified_at: ~datetime.datetime """ super().__init__(**kwargs) - self.value = value - self.next_link = next_link + self.created_by = created_by + self.created_by_type = created_by_type + self.created_at = created_at + self.last_modified_by = last_modified_by + self.last_modified_by_type = last_modified_by_type + self.last_modified_at = last_modified_at class Violation(_serialization.Model): @@ -802,7 +1025,7 @@ class Violation(_serialization.Model): "error_message": {"key": "errorMessage", "type": "str"}, } - def __init__(self, **kwargs): + def __init__(self, **kwargs: Any) -> None: """ """ super().__init__(**kwargs) self.id = None @@ -813,22 +1036,28 @@ def __init__(self, **kwargs): class ViolationsList(_serialization.Model): """List of list of items that violate tenant's configuration. - :ivar value: The array of violations. + All required parameters must be populated in order to send to server. + + :ivar value: The Violation items on this page. Required. :vartype value: list[~azure.mgmt.portal.models.Violation] - :ivar next_link: The URL to use for getting the next set of results. + :ivar next_link: The link to the next page of items. :vartype next_link: str """ + _validation = { + "value": {"required": True}, + } + _attribute_map = { "value": {"key": "value", "type": "[Violation]"}, "next_link": {"key": "nextLink", "type": "str"}, } - def __init__(self, *, value: Optional[List["_models.Violation"]] = None, next_link: Optional[str] = None, **kwargs): + def __init__(self, *, value: List["_models.Violation"], next_link: Optional[str] = None, **kwargs: Any) -> None: """ - :keyword value: The array of violations. + :keyword value: The Violation items on this page. Required. :paramtype value: list[~azure.mgmt.portal.models.Violation] - :keyword next_link: The URL to use for getting the next set of results. + :keyword next_link: The link to the next page of items. :paramtype next_link: str """ super().__init__(**kwargs) diff --git a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/models/_portal_enums.py b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/models/_portal_enums.py index 83ee537ff6ae..1fc6bbd7a94c 100644 --- a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/models/_portal_enums.py +++ b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/models/_portal_enums.py @@ -10,7 +10,44 @@ from azure.core import CaseInsensitiveEnumMeta -class ConfigurationName(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """ConfigurationName.""" +class ActionType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.""" - DEFAULT = "default" + INTERNAL = "Internal" + + +class CreatedByType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of identity that created the resource.""" + + USER = "User" + APPLICATION = "Application" + MANAGED_IDENTITY = "ManagedIdentity" + KEY = "Key" + + +class DashboardPartMetadataType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The dashboard part metadata type.""" + + MARKDOWN = "Extension/HubsExtension/PartType/MarkdownPart" + """The markdown part type.""" + + +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" + SYSTEM = "system" + USER_SYSTEM = "user,system" + + +class ResourceProvisioningState(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The provisioning state of a resource type.""" + + SUCCEEDED = "Succeeded" + """Resource has been created.""" + FAILED = "Failed" + """Resource creation failed.""" + CANCELED = "Canceled" + """Resource creation was canceled.""" diff --git a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/operations/__init__.py b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/operations/__init__.py index 87b80f74044e..44dd6865ba6c 100644 --- a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/operations/__init__.py +++ b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/operations/__init__.py @@ -5,21 +5,27 @@ # Code generated by Microsoft (R) AutoRest Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._operations import Operations -from ._dashboards_operations import DashboardsOperations -from ._tenant_configurations_operations import TenantConfigurationsOperations -from ._list_tenant_configuration_violations_operations import ListTenantConfigurationViolationsOperations +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._operations import Operations # type: ignore +from ._dashboards_operations import DashboardsOperations # type: ignore +from ._list_tenant_configuration_violations_operations import ListTenantConfigurationViolationsOperations # type: ignore +from ._tenant_configurations_operations import TenantConfigurationsOperations # type: ignore from ._patch import __all__ as _patch_all -from ._patch import * # type: ignore # pylint: disable=unused-wildcard-import +from ._patch import * from ._patch import patch_sdk as _patch_sdk __all__ = [ "Operations", "DashboardsOperations", - "TenantConfigurationsOperations", "ListTenantConfigurationViolationsOperations", + "TenantConfigurationsOperations", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/operations/_dashboards_operations.py b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/operations/_dashboards_operations.py index c60ffd5b89b9..c4d2fc0d0872 100644 --- a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/operations/_dashboards_operations.py +++ b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/operations/_dashboards_operations.py @@ -1,4 +1,3 @@ -# pylint: disable=too-many-lines # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -6,6 +5,7 @@ # Code generated by Microsoft (R) AutoRest Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +from io import IOBase import sys from typing import Any, Callable, Dict, IO, Iterable, Optional, TypeVar, Union, overload import urllib.parse @@ -20,20 +20,18 @@ ) from azure.core.paging import ItemPaged from azure.core.pipeline import PipelineResponse -from azure.core.pipeline.transport import HttpResponse -from azure.core.rest import HttpRequest +from azure.core.rest import HttpRequest, HttpResponse from azure.core.tracing.decorator import distributed_trace from azure.core.utils import case_insensitive_dict from azure.mgmt.core.exceptions import ARMErrorFormat from .. import models as _models from .._serialization import Serializer -from .._vendor import _convert_request, _format_url_section -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports + from typing import MutableMapping # type: ignore T = TypeVar("T") ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] @@ -41,65 +39,50 @@ _SERIALIZER.client_side_validation = False -def build_create_or_update_request( - resource_group_name: str, dashboard_name: str, subscription_id: str, **kwargs: Any -) -> HttpRequest: +def build_list_by_subscription_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 = kwargs.pop( - "api_version", _params.pop("api-version", "2020-09-01-preview") - ) # type: Literal["2020-09-01-preview"] - content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL - _url = kwargs.pop( - "template_url", - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}", - ) # pylint: disable=line-too-long + _url = kwargs.pop("template_url", "/subscriptions/{subscriptionId}/providers/Microsoft.Portal/dashboards") path_format_arguments = { "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), - "resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"), - "dashboardName": _SERIALIZER.url("dashboard_name", dashboard_name, "str", max_length=64, min_length=3), } - _url = _format_url_section(_url, **path_format_arguments) + _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) + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) -def build_delete_request( - resource_group_name: str, dashboard_name: str, subscription_id: str, **kwargs: Any -) -> HttpRequest: +def build_list_by_resource_group_request(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 = kwargs.pop( - "api_version", _params.pop("api-version", "2020-09-01-preview") - ) # type: Literal["2020-09-01-preview"] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL _url = kwargs.pop( "template_url", - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}", + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards", ) # 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"), - "dashboardName": _SERIALIZER.url("dashboard_name", dashboard_name, "str", max_length=64, min_length=3), + "resourceGroupName": _SERIALIZER.url( + "resource_group_name", resource_group_name, "str", max_length=90, min_length=1 + ), } - _url = _format_url_section(_url, **path_format_arguments) + _url: str = _url.format(**path_format_arguments) # type: ignore # Construct parameters _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") @@ -107,7 +90,7 @@ def build_delete_request( # Construct headers _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") - return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) def build_get_request( @@ -116,9 +99,7 @@ def build_get_request( _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", "2020-09-01-preview") - ) # type: Literal["2020-09-01-preview"] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -128,11 +109,15 @@ def build_get_request( ) # 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"), - "dashboardName": _SERIALIZER.url("dashboard_name", dashboard_name, "str", max_length=64, min_length=3), + "resourceGroupName": _SERIALIZER.url( + "resource_group_name", resource_group_name, "str", max_length=90, min_length=1 + ), + "dashboardName": _SERIALIZER.url( + "dashboard_name", dashboard_name, "str", max_length=64, min_length=3, pattern=r"^[a-zA-Z0-9-]{3,24}$" + ), } - _url = _format_url_section(_url, **path_format_arguments) + _url: str = _url.format(**path_format_arguments) # type: ignore # Construct parameters _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") @@ -143,16 +128,14 @@ def build_get_request( return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) -def build_update_request( +def build_create_or_update_request( resource_group_name: str, dashboard_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 = kwargs.pop( - "api_version", _params.pop("api-version", "2020-09-01-preview") - ) # type: Literal["2020-09-01-preview"] - content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01-preview")) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -162,11 +145,15 @@ def build_update_request( ) # 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"), - "dashboardName": _SERIALIZER.url("dashboard_name", dashboard_name, "str", max_length=64, min_length=3), + "resourceGroupName": _SERIALIZER.url( + "resource_group_name", resource_group_name, "str", max_length=90, min_length=1 + ), + "dashboardName": _SERIALIZER.url( + "dashboard_name", dashboard_name, "str", max_length=64, min_length=3, pattern=r"^[a-zA-Z0-9-]{3,24}$" + ), } - _url = _format_url_section(_url, **path_format_arguments) + _url: str = _url.format(**path_format_arguments) # type: ignore # Construct parameters _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") @@ -176,55 +163,72 @@ def build_update_request( _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) + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) -def build_list_by_resource_group_request(resource_group_name: str, subscription_id: str, **kwargs: Any) -> HttpRequest: +def build_update_request( + resource_group_name: str, dashboard_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 = kwargs.pop( - "api_version", _params.pop("api-version", "2020-09-01-preview") - ) # type: Literal["2020-09-01-preview"] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01-preview")) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) accept = _headers.pop("Accept", "application/json") # Construct URL _url = kwargs.pop( "template_url", - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards", + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}", ) # 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"), + "resourceGroupName": _SERIALIZER.url( + "resource_group_name", resource_group_name, "str", max_length=90, min_length=1 + ), + "dashboardName": _SERIALIZER.url( + "dashboard_name", dashboard_name, "str", max_length=64, min_length=3, pattern=r"^[a-zA-Z0-9-]{3,24}$" + ), } - _url = _format_url_section(_url, **path_format_arguments) + _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="GET", url=_url, params=_params, headers=_headers, **kwargs) + return HttpRequest(method="PATCH", url=_url, params=_params, headers=_headers, **kwargs) -def build_list_by_subscription_request(subscription_id: str, **kwargs: Any) -> HttpRequest: +def build_delete_request( + resource_group_name: str, dashboard_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 = kwargs.pop( - "api_version", _params.pop("api-version", "2020-09-01-preview") - ) # type: Literal["2020-09-01-preview"] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL - _url = kwargs.pop("template_url", "/subscriptions/{subscriptionId}/providers/Microsoft.Portal/dashboards") + _url = kwargs.pop( + "template_url", + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}", + ) # 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", max_length=90, min_length=1 + ), + "dashboardName": _SERIALIZER.url( + "dashboard_name", dashboard_name, "str", max_length=64, min_length=3, pattern=r"^[a-zA-Z0-9-]{3,24}$" + ), } - _url = _format_url_section(_url, **path_format_arguments) + _url: str = _url.format(**path_format_arguments) # type: ignore # Construct parameters _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") @@ -232,7 +236,7 @@ def build_list_by_subscription_request(subscription_id: str, **kwargs: Any) -> H # Construct headers _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") - return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) class DashboardsOperations: @@ -254,82 +258,99 @@ def __init__(self, *args, **kwargs): 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") - @overload - def create_or_update( - self, - resource_group_name: str, - dashboard_name: str, - dashboard: _models.Dashboard, - *, - content_type: str = "application/json", - **kwargs: Any - ) -> _models.Dashboard: - """Creates or updates a Dashboard. + @distributed_trace + def list_by_subscription(self, **kwargs: Any) -> Iterable["_models.Dashboard"]: + """Gets all the dashboards within a subscription. - :param resource_group_name: The name of the resource group. Required. - :type resource_group_name: str - :param dashboard_name: The name of the dashboard. Required. - :type dashboard_name: str - :param dashboard: The parameters required to create or update a dashboard. Required. - :type dashboard: ~azure.mgmt.portal.models.Dashboard - :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. - Default value is "application/json". - :paramtype content_type: str - :keyword callable cls: A custom type or function that will be passed the direct response - :return: Dashboard or the result of cls(response) - :rtype: ~azure.mgmt.portal.models.Dashboard + :return: An iterator like instance of either Dashboard or the result of cls(response) + :rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.portal.models.Dashboard] :raises ~azure.core.exceptions.HttpResponseError: """ + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - @overload - def create_or_update( - self, - resource_group_name: str, - dashboard_name: str, - dashboard: IO, - *, - content_type: str = "application/json", - **kwargs: Any - ) -> _models.Dashboard: - """Creates or updates a Dashboard. + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DashboardListResult] = kwargs.pop("cls", None) - :param resource_group_name: The name of the resource group. Required. - :type resource_group_name: str - :param dashboard_name: The name of the dashboard. Required. - :type dashboard_name: str - :param dashboard: The parameters required to create or update a dashboard. Required. - :type dashboard: IO - :keyword content_type: Body Parameter content-type. Content type parameter for binary body. - Default value is "application/json". - :paramtype content_type: str - :keyword callable cls: A custom type or function that will be passed the direct response - :return: Dashboard or the result of cls(response) - :rtype: ~azure.mgmt.portal.models.Dashboard - :raises ~azure.core.exceptions.HttpResponseError: - """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_list_by_subscription_request( + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request + + def extract_data(pipeline_response): + deserialized = self._deserialize("DashboardListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + + return pipeline_response + + return ItemPaged(get_next, extract_data) @distributed_trace - def create_or_update( - self, resource_group_name: str, dashboard_name: str, dashboard: Union[_models.Dashboard, IO], **kwargs: Any - ) -> _models.Dashboard: - """Creates or updates a Dashboard. + def list_by_resource_group(self, resource_group_name: str, **kwargs: Any) -> Iterable["_models.Dashboard"]: + """Gets all the Dashboards within a resource group. - :param resource_group_name: The name of the resource group. Required. + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. :type resource_group_name: str - :param dashboard_name: The name of the dashboard. Required. - :type dashboard_name: str - :param dashboard: The parameters required to create or update a dashboard. Is either a model - type or a IO type. Required. - :type dashboard: ~azure.mgmt.portal.models.Dashboard or IO - :keyword content_type: Body Parameter content-type. Known values are: 'application/json'. - Default value is None. - :paramtype content_type: str - :keyword callable cls: A custom type or function that will be passed the direct response - :return: Dashboard or the result of cls(response) - :rtype: ~azure.mgmt.portal.models.Dashboard + :return: An iterator like instance of either Dashboard or the result of cls(response) + :rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.portal.models.Dashboard] :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + _headers = kwargs.pop("headers", {}) or {} + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.DashboardListResult] = kwargs.pop("cls", None) + + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -337,78 +358,74 @@ def create_or_update( } error_map.update(kwargs.pop("error_map", {}) or {}) - _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) - _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] - cls = kwargs.pop("cls", None) # type: ClsType[_models.Dashboard] - - content_type = content_type or "application/json" - _json = None - _content = None - if isinstance(dashboard, (IO, bytes)): - _content = dashboard - else: - _json = self._serialize.body(dashboard, "Dashboard") - - request = build_create_or_update_request( - resource_group_name=resource_group_name, - dashboard_name=dashboard_name, - subscription_id=self._config.subscription_id, - api_version=api_version, - content_type=content_type, - json=_json, - content=_content, - template_url=self.create_or_update.metadata["url"], - headers=_headers, - params=_params, - ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore + def prepare_request(next_link=None): + if not next_link: - pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs - ) + _request = build_list_by_resource_group_request( + resource_group_name=resource_group_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) - response = pipeline_response.http_response + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request - if response.status_code not in [200, 201]: - map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) - raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + def extract_data(pipeline_response): + deserialized = self._deserialize("DashboardListResult", pipeline_response) + list_of_elem = deserialized.value + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.next_link or None, iter(list_of_elem) - if response.status_code == 200: - deserialized = self._deserialize("Dashboard", pipeline_response) + def get_next(next_link=None): + _request = prepare_request(next_link) - if response.status_code == 201: - deserialized = self._deserialize("Dashboard", pipeline_response) + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response - if cls: - return cls(pipeline_response, deserialized, {}) + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) - return deserialized + return pipeline_response - create_or_update.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}"} # type: ignore + return ItemPaged(get_next, extract_data) @distributed_trace - def delete( # pylint: disable=inconsistent-return-statements - self, resource_group_name: str, dashboard_name: str, **kwargs: Any - ) -> None: - """Deletes the Dashboard. + def get(self, resource_group_name: str, dashboard_name: str, **kwargs: Any) -> _models.Dashboard: + """Gets the Dashboard. - :param resource_group_name: The name of the resource group. Required. + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. :type resource_group_name: str :param dashboard_name: The name of the dashboard. Required. :type dashboard_name: str - :keyword callable cls: A custom type or function that will be passed the direct response - :return: None or the result of cls(response) - :rtype: None + :return: Dashboard or the result of cls(response) + :rtype: ~azure.mgmt.portal.models.Dashboard :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -419,53 +436,115 @@ def delete( # pylint: disable=inconsistent-return-statements _headers = kwargs.pop("headers", {}) or {} _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - cls = kwargs.pop("cls", None) # type: ClsType[None] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.Dashboard] = kwargs.pop("cls", None) - request = build_delete_request( + _request = build_get_request( resource_group_name=resource_group_name, dashboard_name=dashboard_name, subscription_id=self._config.subscription_id, api_version=api_version, - template_url=self.delete.metadata["url"], headers=_headers, params=_params, ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore + _request.url = self._client.format_url(_request.url) - pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs + _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, 204]: + if response.status_code not in [200]: map_error(status_code=response.status_code, response=response, error_map=error_map) error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + deserialized = self._deserialize("Dashboard", pipeline_response.http_response) + if cls: - return cls(pipeline_response, None, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore - delete.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}"} # type: ignore + @overload + def create_or_update( + self, + resource_group_name: str, + dashboard_name: str, + resource: _models.Dashboard, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.Dashboard: + """Creates or updates a Dashboard. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param dashboard_name: The name of the dashboard. Required. + :type dashboard_name: str + :param resource: The parameters required to create or update a dashboard. Required. + :type resource: ~azure.mgmt.portal.models.Dashboard + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: Dashboard or the result of cls(response) + :rtype: ~azure.mgmt.portal.models.Dashboard + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def create_or_update( + self, + resource_group_name: str, + dashboard_name: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.Dashboard: + """Creates or updates a Dashboard. + + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. + :type resource_group_name: str + :param dashboard_name: The name of the dashboard. Required. + :type dashboard_name: str + :param resource: The parameters required to create or update a dashboard. 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: Dashboard or the result of cls(response) + :rtype: ~azure.mgmt.portal.models.Dashboard + :raises ~azure.core.exceptions.HttpResponseError: + """ @distributed_trace - def get(self, resource_group_name: str, dashboard_name: str, **kwargs: Any) -> Optional[_models.Dashboard]: - """Gets the Dashboard. + def create_or_update( + self, + resource_group_name: str, + dashboard_name: str, + resource: Union[_models.Dashboard, IO[bytes]], + **kwargs: Any + ) -> _models.Dashboard: + """Creates or updates a Dashboard. - :param resource_group_name: The name of the resource group. Required. + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. :type resource_group_name: str :param dashboard_name: The name of the dashboard. Required. :type dashboard_name: str - :keyword callable cls: A custom type or function that will be passed the direct response - :return: Dashboard or None or the result of cls(response) - :rtype: ~azure.mgmt.portal.models.Dashboard or None + :param resource: The parameters required to create or update a dashboard. Is either a Dashboard + type or a IO[bytes] type. Required. + :type resource: ~azure.mgmt.portal.models.Dashboard or IO[bytes] + :return: Dashboard or the result of cls(response) + :rtype: ~azure.mgmt.portal.models.Dashboard :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -473,72 +552,77 @@ def get(self, resource_group_name: str, dashboard_name: str, **kwargs: Any) -> O } error_map.update(kwargs.pop("error_map", {}) or {}) - _headers = kwargs.pop("headers", {}) or {} + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - cls = kwargs.pop("cls", None) # type: ClsType[Optional[_models.Dashboard]] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.Dashboard] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(resource, (IOBase, bytes)): + _content = resource + else: + _json = self._serialize.body(resource, "Dashboard") - request = build_get_request( + _request = build_create_or_update_request( resource_group_name=resource_group_name, dashboard_name=dashboard_name, subscription_id=self._config.subscription_id, api_version=api_version, - template_url=self.get.metadata["url"], + content_type=content_type, + json=_json, + content=_content, headers=_headers, params=_params, ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore + _request.url = self._client.format_url(_request.url) - pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs + _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, 404]: + if response.status_code not in [200, 201]: map_error(status_code=response.status_code, response=response, error_map=error_map) error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) - deserialized = None - if response.status_code == 200: - deserialized = self._deserialize("Dashboard", pipeline_response) + deserialized = self._deserialize("Dashboard", pipeline_response.http_response) if cls: - return cls(pipeline_response, deserialized, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore - return deserialized - - get.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}"} # type: ignore + return deserialized # type: ignore @overload def update( self, resource_group_name: str, dashboard_name: str, - dashboard: _models.PatchableDashboard, + properties: _models.PatchableDashboard, *, content_type: str = "application/json", **kwargs: Any - ) -> Optional[_models.Dashboard]: + ) -> _models.Dashboard: """Updates an existing Dashboard. - :param resource_group_name: The name of the resource group. Required. + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. :type resource_group_name: str :param dashboard_name: The name of the dashboard. Required. :type dashboard_name: str - :param dashboard: The updatable fields of a Dashboard. Required. - :type dashboard: ~azure.mgmt.portal.models.PatchableDashboard + :param properties: The updatable fields of a Dashboard. Required. + :type properties: ~azure.mgmt.portal.models.PatchableDashboard :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword callable cls: A custom type or function that will be passed the direct response - :return: Dashboard or None or the result of cls(response) - :rtype: ~azure.mgmt.portal.models.Dashboard or None + :return: Dashboard or the result of cls(response) + :rtype: ~azure.mgmt.portal.models.Dashboard :raises ~azure.core.exceptions.HttpResponseError: """ @@ -547,25 +631,25 @@ def update( self, resource_group_name: str, dashboard_name: str, - dashboard: IO, + properties: IO[bytes], *, content_type: str = "application/json", **kwargs: Any - ) -> Optional[_models.Dashboard]: + ) -> _models.Dashboard: """Updates an existing Dashboard. - :param resource_group_name: The name of the resource group. Required. + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. :type resource_group_name: str :param dashboard_name: The name of the dashboard. Required. :type dashboard_name: str - :param dashboard: The updatable fields of a Dashboard. Required. - :type dashboard: IO + :param properties: The updatable fields of a Dashboard. 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 - :keyword callable cls: A custom type or function that will be passed the direct response - :return: Dashboard or None or the result of cls(response) - :rtype: ~azure.mgmt.portal.models.Dashboard or None + :return: Dashboard or the result of cls(response) + :rtype: ~azure.mgmt.portal.models.Dashboard :raises ~azure.core.exceptions.HttpResponseError: """ @@ -574,27 +658,24 @@ def update( self, resource_group_name: str, dashboard_name: str, - dashboard: Union[_models.PatchableDashboard, IO], + properties: Union[_models.PatchableDashboard, IO[bytes]], **kwargs: Any - ) -> Optional[_models.Dashboard]: + ) -> _models.Dashboard: """Updates an existing Dashboard. - :param resource_group_name: The name of the resource group. Required. + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. :type resource_group_name: str :param dashboard_name: The name of the dashboard. Required. :type dashboard_name: str - :param dashboard: The updatable fields of a Dashboard. Is either a model type or a IO type. - Required. - :type dashboard: ~azure.mgmt.portal.models.PatchableDashboard or IO - :keyword content_type: Body Parameter content-type. Known values are: 'application/json'. - Default value is None. - :paramtype content_type: str - :keyword callable cls: A custom type or function that will be passed the direct response - :return: Dashboard or None or the result of cls(response) - :rtype: ~azure.mgmt.portal.models.Dashboard or None + :param properties: The updatable fields of a Dashboard. Is either a PatchableDashboard type or + a IO[bytes] type. Required. + :type properties: ~azure.mgmt.portal.models.PatchableDashboard or IO[bytes] + :return: Dashboard or the result of cls(response) + :rtype: ~azure.mgmt.portal.models.Dashboard :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -605,21 +686,19 @@ def update( _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] - cls = kwargs.pop("cls", None) # type: ClsType[Optional[_models.Dashboard]] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.Dashboard] = kwargs.pop("cls", None) content_type = content_type or "application/json" _json = None _content = None - if isinstance(dashboard, (IO, bytes)): - _content = dashboard + if isinstance(properties, (IOBase, bytes)): + _content = properties else: - _json = self._serialize.body(dashboard, "PatchableDashboard") + _json = self._serialize.body(properties, "PatchableDashboard") - request = build_update_request( + _request = build_update_request( resource_group_name=resource_group_name, dashboard_name=dashboard_name, subscription_id=self._config.subscription_id, @@ -627,55 +706,46 @@ def update( content_type=content_type, json=_json, content=_content, - template_url=self.update.metadata["url"], headers=_headers, params=_params, ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore + _request.url = self._client.format_url(_request.url) - pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs + _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, 404]: + if response.status_code not in [200]: map_error(status_code=response.status_code, response=response, error_map=error_map) error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) - deserialized = None - if response.status_code == 200: - deserialized = self._deserialize("Dashboard", pipeline_response) + deserialized = self._deserialize("Dashboard", pipeline_response.http_response) if cls: - return cls(pipeline_response, deserialized, {}) - - return deserialized + return cls(pipeline_response, deserialized, {}) # type: ignore - update.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}"} # type: ignore + return deserialized # type: ignore @distributed_trace - def list_by_resource_group(self, resource_group_name: str, **kwargs: Any) -> Iterable["_models.Dashboard"]: - """Gets all the Dashboards within a resource group. + def delete( # pylint: disable=inconsistent-return-statements + self, resource_group_name: str, dashboard_name: str, **kwargs: Any + ) -> None: + """Deletes the Dashboard. - :param resource_group_name: The name of the resource group. Required. + :param resource_group_name: The name of the resource group. The name is case insensitive. + Required. :type resource_group_name: str - :keyword callable cls: A custom type or function that will be passed the direct response - :return: An iterator like instance of either Dashboard or the result of cls(response) - :rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.portal.models.Dashboard] + :param dashboard_name: The name of the dashboard. Required. + :type dashboard_name: str + :return: None or the result of cls(response) + :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - _headers = kwargs.pop("headers", {}) or {} - _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - cls = kwargs.pop("cls", None) # type: ClsType[_models.DashboardListResult] - - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -683,142 +753,33 @@ def list_by_resource_group(self, resource_group_name: str, **kwargs: Any) -> Ite } error_map.update(kwargs.pop("error_map", {}) or {}) - def prepare_request(next_link=None): - if not next_link: - - request = build_list_by_resource_group_request( - resource_group_name=resource_group_name, - subscription_id=self._config.subscription_id, - api_version=api_version, - template_url=self.list_by_resource_group.metadata["url"], - headers=_headers, - params=_params, - ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore - - 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 = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore - request.method = "GET" - return request - - def extract_data(pipeline_response): - deserialized = self._deserialize("DashboardListResult", pipeline_response) - list_of_elem = deserialized.value - if cls: - list_of_elem = cls(list_of_elem) - return deserialized.next_link or None, iter(list_of_elem) - - def get_next(next_link=None): - request = prepare_request(next_link) - - pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs - ) - response = pipeline_response.http_response - - if response.status_code not in [200]: - map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) - raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) - - return pipeline_response - - return ItemPaged(get_next, extract_data) - - list_by_resource_group.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards"} # type: ignore - - @distributed_trace - def list_by_subscription(self, **kwargs: Any) -> Iterable["_models.Dashboard"]: - """Gets all the dashboards within a subscription. - - :keyword callable cls: A custom type or function that will be passed the direct response - :return: An iterator like instance of either Dashboard or the result of cls(response) - :rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.portal.models.Dashboard] - :raises ~azure.core.exceptions.HttpResponseError: - """ _headers = kwargs.pop("headers", {}) or {} _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - cls = kwargs.pop("cls", None) # type: ClsType[_models.DashboardListResult] - - error_map = { - 401: ClientAuthenticationError, - 404: ResourceNotFoundError, - 409: ResourceExistsError, - 304: ResourceNotModifiedError, - } - error_map.update(kwargs.pop("error_map", {}) or {}) - - def prepare_request(next_link=None): - if not next_link: - - request = build_list_by_subscription_request( - subscription_id=self._config.subscription_id, - api_version=api_version, - template_url=self.list_by_subscription.metadata["url"], - headers=_headers, - params=_params, - ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore - - 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 = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore - request.method = "GET" - return request + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) - def extract_data(pipeline_response): - deserialized = self._deserialize("DashboardListResult", pipeline_response) - list_of_elem = deserialized.value - if cls: - list_of_elem = cls(list_of_elem) - return deserialized.next_link or None, iter(list_of_elem) - - def get_next(next_link=None): - request = prepare_request(next_link) - - pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs - ) - response = pipeline_response.http_response + _request = build_delete_request( + resource_group_name=resource_group_name, + dashboard_name=dashboard_name, + subscription_id=self._config.subscription_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) - if response.status_code not in [200]: - map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) - raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) - return pipeline_response + response = pipeline_response.http_response - return ItemPaged(get_next, extract_data) + if response.status_code not in [200, 204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) + raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) - list_by_subscription.metadata = {"url": "/subscriptions/{subscriptionId}/providers/Microsoft.Portal/dashboards"} # type: ignore + if cls: + return cls(pipeline_response, None, {}) # type: ignore diff --git a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/operations/_list_tenant_configuration_violations_operations.py b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/operations/_list_tenant_configuration_violations_operations.py index 41872d954d0d..314c1028d631 100644 --- a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/operations/_list_tenant_configuration_violations_operations.py +++ b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/operations/_list_tenant_configuration_violations_operations.py @@ -1,4 +1,3 @@ -# pylint: disable=too-many-lines # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -20,20 +19,18 @@ ) from azure.core.paging import ItemPaged from azure.core.pipeline import PipelineResponse -from azure.core.pipeline.transport import HttpResponse -from azure.core.rest import HttpRequest +from azure.core.rest import HttpRequest, HttpResponse from azure.core.tracing.decorator import distributed_trace from azure.core.utils import case_insensitive_dict from azure.mgmt.core.exceptions import ARMErrorFormat from .. import models as _models from .._serialization import Serializer -from .._vendor import _convert_request -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports + from typing import MutableMapping # type: ignore T = TypeVar("T") ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] @@ -45,9 +42,7 @@ def build_list_request(**kwargs: Any) -> HttpRequest: _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", "2020-09-01-preview") - ) # type: Literal["2020-09-01-preview"] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -62,7 +57,7 @@ def build_list_request(**kwargs: Any) -> HttpRequest: return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) -class ListTenantConfigurationViolationsOperations: +class ListTenantConfigurationViolationsOperations: # pylint: disable=name-too-long """ .. warning:: **DO NOT** instantiate this class directly. @@ -85,7 +80,6 @@ def __init__(self, *args, **kwargs): def list(self, **kwargs: Any) -> Iterable["_models.Violation"]: """Gets list of items that violate tenant's configuration. - :keyword callable cls: A custom type or function that will be passed the direct response :return: An iterator like instance of either Violation or the result of cls(response) :rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.portal.models.Violation] :raises ~azure.core.exceptions.HttpResponseError: @@ -93,12 +87,10 @@ def list(self, **kwargs: Any) -> Iterable["_models.Violation"]: _headers = kwargs.pop("headers", {}) or {} _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - cls = kwargs.pop("cls", None) # type: ClsType[_models.ViolationsList] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.ViolationsList] = kwargs.pop("cls", None) - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -109,14 +101,12 @@ def list(self, **kwargs: Any) -> Iterable["_models.Violation"]: def prepare_request(next_link=None): if not next_link: - request = build_list_request( + _request = build_list_request( api_version=api_version, - template_url=self.list.metadata["url"], headers=_headers, params=_params, ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore + _request.url = self._client.format_url(_request.url) else: # make call to next link with the client's api-version @@ -128,26 +118,26 @@ def prepare_request(next_link=None): } ) _next_request_params["api-version"] = self._config.api_version - request = HttpRequest( + _request = HttpRequest( "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore - request.method = "GET" - return request + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request def extract_data(pipeline_response): deserialized = self._deserialize("ViolationsList", pipeline_response) list_of_elem = deserialized.value if cls: - list_of_elem = cls(list_of_elem) + list_of_elem = cls(list_of_elem) # type: ignore return deserialized.next_link or None, iter(list_of_elem) def get_next(next_link=None): - request = prepare_request(next_link) + _request = prepare_request(next_link) - pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response @@ -159,5 +149,3 @@ def get_next(next_link=None): return pipeline_response return ItemPaged(get_next, extract_data) - - list.metadata = {"url": "/providers/Microsoft.Portal/listTenantConfigurationViolations"} # type: ignore diff --git a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/operations/_operations.py b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/operations/_operations.py index 18a3f40d983c..b732481b6d53 100644 --- a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/operations/_operations.py +++ b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/operations/_operations.py @@ -1,4 +1,3 @@ -# pylint: disable=too-many-lines # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -20,20 +19,18 @@ ) from azure.core.paging import ItemPaged from azure.core.pipeline import PipelineResponse -from azure.core.pipeline.transport import HttpResponse -from azure.core.rest import HttpRequest +from azure.core.rest import HttpRequest, HttpResponse from azure.core.tracing.decorator import distributed_trace from azure.core.utils import case_insensitive_dict from azure.mgmt.core.exceptions import ARMErrorFormat from .. import models as _models from .._serialization import Serializer -from .._vendor import _convert_request -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports + from typing import MutableMapping # type: ignore T = TypeVar("T") ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] @@ -45,9 +42,7 @@ def build_list_request(**kwargs: Any) -> HttpRequest: _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", "2020-09-01-preview") - ) # type: Literal["2020-09-01-preview"] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -82,24 +77,20 @@ def __init__(self, *args, **kwargs): self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") @distributed_trace - def list(self, **kwargs: Any) -> Iterable["_models.ResourceProviderOperation"]: - """The Microsoft Portal operations API. + def list(self, **kwargs: Any) -> Iterable["_models.Operation"]: + """List the operations for the provider. - :keyword callable cls: A custom type or function that will be passed the direct response - :return: An iterator like instance of either ResourceProviderOperation or the result of - cls(response) - :rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.portal.models.ResourceProviderOperation] + :return: An iterator like instance of either Operation or the result of cls(response) + :rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.portal.models.Operation] :raises ~azure.core.exceptions.HttpResponseError: """ _headers = kwargs.pop("headers", {}) or {} _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - cls = kwargs.pop("cls", None) # type: ClsType[_models.ResourceProviderOperationList] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.OperationListResult] = kwargs.pop("cls", None) - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -110,14 +101,12 @@ def list(self, **kwargs: Any) -> Iterable["_models.ResourceProviderOperation"]: def prepare_request(next_link=None): if not next_link: - request = build_list_request( + _request = build_list_request( api_version=api_version, - template_url=self.list.metadata["url"], headers=_headers, params=_params, ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore + _request.url = self._client.format_url(_request.url) else: # make call to next link with the client's api-version @@ -129,26 +118,26 @@ def prepare_request(next_link=None): } ) _next_request_params["api-version"] = self._config.api_version - request = HttpRequest( + _request = HttpRequest( "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore - request.method = "GET" - return request + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request def extract_data(pipeline_response): - deserialized = self._deserialize("ResourceProviderOperationList", pipeline_response) + deserialized = self._deserialize("OperationListResult", pipeline_response) list_of_elem = deserialized.value if cls: - list_of_elem = cls(list_of_elem) + list_of_elem = cls(list_of_elem) # type: ignore return deserialized.next_link or None, iter(list_of_elem) def get_next(next_link=None): - request = prepare_request(next_link) + _request = prepare_request(next_link) - pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response @@ -160,5 +149,3 @@ def get_next(next_link=None): return pipeline_response return ItemPaged(get_next, extract_data) - - list.metadata = {"url": "/providers/Microsoft.Portal/operations"} # type: ignore diff --git a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/operations/_tenant_configurations_operations.py b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/operations/_tenant_configurations_operations.py index 32584a4cf7ce..64fd59902be4 100644 --- a/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/operations/_tenant_configurations_operations.py +++ b/sdk/portal/azure-mgmt-portal/azure/mgmt/portal/operations/_tenant_configurations_operations.py @@ -1,4 +1,3 @@ -# pylint: disable=too-many-lines # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -6,6 +5,7 @@ # Code generated by Microsoft (R) AutoRest Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +from io import IOBase import sys from typing import Any, Callable, Dict, IO, Iterable, Optional, TypeVar, Union, overload import urllib.parse @@ -20,20 +20,18 @@ ) from azure.core.paging import ItemPaged from azure.core.pipeline import PipelineResponse -from azure.core.pipeline.transport import HttpResponse -from azure.core.rest import HttpRequest +from azure.core.rest import HttpRequest, HttpResponse from azure.core.tracing.decorator import distributed_trace from azure.core.utils import case_insensitive_dict from azure.mgmt.core.exceptions import ARMErrorFormat from .. import models as _models from .._serialization import Serializer -from .._vendor import _convert_request, _format_url_section -if sys.version_info >= (3, 8): - from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports + from typing import MutableMapping # type: ignore T = TypeVar("T") ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] @@ -45,9 +43,7 @@ def build_list_request(**kwargs: Any) -> HttpRequest: _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", "2020-09-01-preview") - ) # type: Literal["2020-09-01-preview"] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -62,22 +58,25 @@ def build_list_request(**kwargs: Any) -> HttpRequest: return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) -def build_get_request(configuration_name: Union[str, _models.ConfigurationName], **kwargs: Any) -> HttpRequest: +def build_get_request(configuration_name: str, **kwargs: Any) -> HttpRequest: _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", "2020-09-01-preview") - ) # type: Literal["2020-09-01-preview"] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL _url = kwargs.pop("template_url", "/providers/Microsoft.Portal/tenantConfigurations/{configurationName}") path_format_arguments = { - "configurationName": _SERIALIZER.url("configuration_name", configuration_name, "str"), + "configurationName": _SERIALIZER.url( + "configuration_name", + configuration_name, + "str", + pattern=r"^(?!con$|prn$|aux$|nul$|com[1-9]$)(?!.*[._-]{2,})[a-zA-Z0-9]([a-zA-Z0-9-._]*[a-zA-Z0-9])?$", + ), } - _url = _format_url_section(_url, **path_format_arguments) + _url: str = _url.format(**path_format_arguments) # type: ignore # Construct parameters _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") @@ -88,23 +87,26 @@ def build_get_request(configuration_name: Union[str, _models.ConfigurationName], return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) -def build_create_request(configuration_name: Union[str, _models.ConfigurationName], **kwargs: Any) -> HttpRequest: +def build_create_request(configuration_name: str, **kwargs: Any) -> HttpRequest: _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", "2020-09-01-preview") - ) # type: Literal["2020-09-01-preview"] - content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01-preview")) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) accept = _headers.pop("Accept", "application/json") # Construct URL _url = kwargs.pop("template_url", "/providers/Microsoft.Portal/tenantConfigurations/{configurationName}") path_format_arguments = { - "configurationName": _SERIALIZER.url("configuration_name", configuration_name, "str"), + "configurationName": _SERIALIZER.url( + "configuration_name", + configuration_name, + "str", + pattern=r"^(?!con$|prn$|aux$|nul$|com[1-9]$)(?!.*[._-]{2,})[a-zA-Z0-9]([a-zA-Z0-9-._]*[a-zA-Z0-9])?$", + ), } - _url = _format_url_section(_url, **path_format_arguments) + _url: str = _url.format(**path_format_arguments) # type: ignore # Construct parameters _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") @@ -117,22 +119,25 @@ def build_create_request(configuration_name: Union[str, _models.ConfigurationNam return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) -def build_delete_request(configuration_name: Union[str, _models.ConfigurationName], **kwargs: Any) -> HttpRequest: +def build_delete_request(configuration_name: str, **kwargs: Any) -> HttpRequest: _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", "2020-09-01-preview") - ) # type: Literal["2020-09-01-preview"] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-04-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL _url = kwargs.pop("template_url", "/providers/Microsoft.Portal/tenantConfigurations/{configurationName}") path_format_arguments = { - "configurationName": _SERIALIZER.url("configuration_name", configuration_name, "str"), + "configurationName": _SERIALIZER.url( + "configuration_name", + configuration_name, + "str", + pattern=r"^(?!con$|prn$|aux$|nul$|com[1-9]$)(?!.*[._-]{2,})[a-zA-Z0-9]([a-zA-Z0-9-._]*[a-zA-Z0-9])?$", + ), } - _url = _format_url_section(_url, **path_format_arguments) + _url: str = _url.format(**path_format_arguments) # type: ignore # Construct parameters _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") @@ -166,7 +171,6 @@ def __init__(self, *args, **kwargs): def list(self, **kwargs: Any) -> Iterable["_models.Configuration"]: """Gets list of the tenant configurations. - :keyword callable cls: A custom type or function that will be passed the direct response :return: An iterator like instance of either Configuration or the result of cls(response) :rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.portal.models.Configuration] :raises ~azure.core.exceptions.HttpResponseError: @@ -174,12 +178,10 @@ def list(self, **kwargs: Any) -> Iterable["_models.Configuration"]: _headers = kwargs.pop("headers", {}) or {} _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - cls = kwargs.pop("cls", None) # type: ClsType[_models.ConfigurationList] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.ConfigurationListResult] = kwargs.pop("cls", None) - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -190,14 +192,12 @@ def list(self, **kwargs: Any) -> Iterable["_models.Configuration"]: def prepare_request(next_link=None): if not next_link: - request = build_list_request( + _request = build_list_request( api_version=api_version, - template_url=self.list.metadata["url"], headers=_headers, params=_params, ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore + _request.url = self._client.format_url(_request.url) else: # make call to next link with the client's api-version @@ -209,26 +209,26 @@ def prepare_request(next_link=None): } ) _next_request_params["api-version"] = self._config.api_version - request = HttpRequest( + _request = HttpRequest( "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore - request.method = "GET" - return request + _request.url = self._client.format_url(_request.url) + _request.method = "GET" + return _request def extract_data(pipeline_response): - deserialized = self._deserialize("ConfigurationList", pipeline_response) + deserialized = self._deserialize("ConfigurationListResult", pipeline_response) list_of_elem = deserialized.value if cls: - list_of_elem = cls(list_of_elem) + list_of_elem = cls(list_of_elem) # type: ignore return deserialized.next_link or None, iter(list_of_elem) def get_next(next_link=None): - request = prepare_request(next_link) + _request = prepare_request(next_link) - pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response @@ -241,22 +241,17 @@ def get_next(next_link=None): return ItemPaged(get_next, extract_data) - list.metadata = {"url": "/providers/Microsoft.Portal/tenantConfigurations"} # type: ignore - @distributed_trace - def get( - self, configuration_name: Union[str, _models.ConfigurationName], **kwargs: Any - ) -> Optional[_models.Configuration]: + def get(self, configuration_name: str, **kwargs: Any) -> _models.Configuration: """Gets the tenant configuration. - :param configuration_name: The configuration name. Value must be 'default'. "default" Required. - :type configuration_name: str or ~azure.mgmt.portal.models.ConfigurationName - :keyword callable cls: A custom type or function that will be passed the direct response - :return: Configuration or None or the result of cls(response) - :rtype: ~azure.mgmt.portal.models.Configuration or None + :param configuration_name: The name of the Configuration. Required. + :type configuration_name: str + :return: Configuration or the result of cls(response) + :rtype: ~azure.mgmt.portal.models.Configuration :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -267,48 +262,41 @@ def get( _headers = kwargs.pop("headers", {}) or {} _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - cls = kwargs.pop("cls", None) # type: ClsType[Optional[_models.Configuration]] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[_models.Configuration] = kwargs.pop("cls", None) - request = build_get_request( + _request = build_get_request( configuration_name=configuration_name, api_version=api_version, - template_url=self.get.metadata["url"], headers=_headers, params=_params, ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore + _request.url = self._client.format_url(_request.url) - pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs + _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, 404]: + if response.status_code not in [200]: map_error(status_code=response.status_code, response=response, error_map=error_map) error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) - deserialized = None - if response.status_code == 200: - deserialized = self._deserialize("Configuration", pipeline_response) + deserialized = self._deserialize("Configuration", pipeline_response.http_response) if cls: - return cls(pipeline_response, deserialized, {}) - - return deserialized + return cls(pipeline_response, deserialized, {}) # type: ignore - get.metadata = {"url": "/providers/Microsoft.Portal/tenantConfigurations/{configurationName}"} # type: ignore + return deserialized # type: ignore @overload def create( self, - configuration_name: Union[str, _models.ConfigurationName], - tenant_configuration: _models.Configuration, + configuration_name: str, + resource: _models.Configuration, *, content_type: str = "application/json", **kwargs: Any @@ -316,15 +304,13 @@ def create( """Create the tenant configuration. If configuration already exists - update it. User has to be a Tenant Admin for this operation. - :param configuration_name: The configuration name. Value must be 'default'. "default" Required. - :type configuration_name: str or ~azure.mgmt.portal.models.ConfigurationName - :param tenant_configuration: The parameters required to create or update tenant configuration. - Required. - :type tenant_configuration: ~azure.mgmt.portal.models.Configuration + :param configuration_name: The name of the Configuration. Required. + :type configuration_name: str + :param resource: The parameters required to create or update tenant configuration. Required. + :type resource: ~azure.mgmt.portal.models.Configuration :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword callable cls: A custom type or function that will be passed the direct response :return: Configuration or the result of cls(response) :rtype: ~azure.mgmt.portal.models.Configuration :raises ~azure.core.exceptions.HttpResponseError: @@ -332,25 +318,18 @@ def create( @overload def create( - self, - configuration_name: Union[str, _models.ConfigurationName], - tenant_configuration: IO, - *, - content_type: str = "application/json", - **kwargs: Any + self, configuration_name: str, resource: IO[bytes], *, content_type: str = "application/json", **kwargs: Any ) -> _models.Configuration: """Create the tenant configuration. If configuration already exists - update it. User has to be a Tenant Admin for this operation. - :param configuration_name: The configuration name. Value must be 'default'. "default" Required. - :type configuration_name: str or ~azure.mgmt.portal.models.ConfigurationName - :param tenant_configuration: The parameters required to create or update tenant configuration. - Required. - :type tenant_configuration: IO + :param configuration_name: The name of the Configuration. Required. + :type configuration_name: str + :param resource: The parameters required to create or update tenant configuration. 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 - :keyword callable cls: A custom type or function that will be passed the direct response :return: Configuration or the result of cls(response) :rtype: ~azure.mgmt.portal.models.Configuration :raises ~azure.core.exceptions.HttpResponseError: @@ -358,28 +337,21 @@ def create( @distributed_trace def create( - self, - configuration_name: Union[str, _models.ConfigurationName], - tenant_configuration: Union[_models.Configuration, IO], - **kwargs: Any + self, configuration_name: str, resource: Union[_models.Configuration, IO[bytes]], **kwargs: Any ) -> _models.Configuration: """Create the tenant configuration. If configuration already exists - update it. User has to be a Tenant Admin for this operation. - :param configuration_name: The configuration name. Value must be 'default'. "default" Required. - :type configuration_name: str or ~azure.mgmt.portal.models.ConfigurationName - :param tenant_configuration: The parameters required to create or update tenant configuration. - Is either a model type or a IO type. Required. - :type tenant_configuration: ~azure.mgmt.portal.models.Configuration or IO - :keyword content_type: Body Parameter content-type. Known values are: 'application/json'. - Default value is None. - :paramtype content_type: str - :keyword callable cls: A custom type or function that will be passed the direct response + :param configuration_name: The name of the Configuration. Required. + :type configuration_name: str + :param resource: The parameters required to create or update tenant configuration. Is either a + Configuration type or a IO[bytes] type. Required. + :type resource: ~azure.mgmt.portal.models.Configuration or IO[bytes] :return: Configuration or the result of cls(response) :rtype: ~azure.mgmt.portal.models.Configuration :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -390,35 +362,32 @@ def create( _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] - cls = kwargs.pop("cls", None) # type: ClsType[_models.Configuration] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.Configuration] = kwargs.pop("cls", None) content_type = content_type or "application/json" _json = None _content = None - if isinstance(tenant_configuration, (IO, bytes)): - _content = tenant_configuration + if isinstance(resource, (IOBase, bytes)): + _content = resource else: - _json = self._serialize.body(tenant_configuration, "Configuration") + _json = self._serialize.body(resource, "Configuration") - request = build_create_request( + _request = build_create_request( configuration_name=configuration_name, api_version=api_version, content_type=content_type, json=_json, content=_content, - template_url=self.create.metadata["url"], headers=_headers, params=_params, ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore + _request.url = self._client.format_url(_request.url) - pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response @@ -428,33 +397,24 @@ def create( error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) - if response.status_code == 200: - deserialized = self._deserialize("Configuration", pipeline_response) - - if response.status_code == 201: - deserialized = self._deserialize("Configuration", pipeline_response) + deserialized = self._deserialize("Configuration", pipeline_response.http_response) if cls: - return cls(pipeline_response, deserialized, {}) - - return deserialized + return cls(pipeline_response, deserialized, {}) # type: ignore - create.metadata = {"url": "/providers/Microsoft.Portal/tenantConfigurations/{configurationName}"} # type: ignore + return deserialized # type: ignore @distributed_trace - def delete( # pylint: disable=inconsistent-return-statements - self, configuration_name: Union[str, _models.ConfigurationName], **kwargs: Any - ) -> None: + def delete(self, configuration_name: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements """Delete the tenant configuration. User has to be a Tenant Admin for this operation. - :param configuration_name: The configuration name. Value must be 'default'. "default" Required. - :type configuration_name: str or ~azure.mgmt.portal.models.ConfigurationName - :keyword callable cls: A custom type or function that will be passed the direct response + :param configuration_name: The name of the Configuration. Required. + :type configuration_name: str :return: None or the result of cls(response) :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -465,23 +425,20 @@ def delete( # pylint: disable=inconsistent-return-statements _headers = kwargs.pop("headers", {}) or {} _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop( - "api_version", _params.pop("api-version", self._config.api_version) - ) # type: Literal["2020-09-01-preview"] - cls = kwargs.pop("cls", None) # type: ClsType[None] + api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) + cls: ClsType[None] = kwargs.pop("cls", None) - request = build_delete_request( + _request = build_delete_request( configuration_name=configuration_name, api_version=api_version, - template_url=self.delete.metadata["url"], headers=_headers, params=_params, ) - request = _convert_request(request) - request.url = self._client.format_url(request.url) # type: ignore + _request.url = self._client.format_url(_request.url) - pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - request, stream=False, **kwargs + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response @@ -492,6 +449,4 @@ def delete( # pylint: disable=inconsistent-return-statements raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat) if cls: - return cls(pipeline_response, None, {}) - - delete.metadata = {"url": "/providers/Microsoft.Portal/tenantConfigurations/{configurationName}"} # type: ignore + return cls(pipeline_response, None, {}) # type: ignore diff --git a/sdk/portal/azure-mgmt-portal/generated_samples/create_or_update_a_dashboard.py b/sdk/portal/azure-mgmt-portal/generated_samples/create_or_update_a_dashboard.py deleted file mode 100644 index c67d2c7ca289..000000000000 --- a/sdk/portal/azure-mgmt-portal/generated_samples/create_or_update_a_dashboard.py +++ /dev/null @@ -1,58 +0,0 @@ -# coding=utf-8 -# -------------------------------------------------------------------------- -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for license information. -# Code generated by Microsoft (R) AutoRest Code Generator. -# Changes may cause incorrect behavior and will be lost if the code is regenerated. -# -------------------------------------------------------------------------- - -from azure.identity import DefaultAzureCredential -from azure.mgmt.portal import Portal - -""" -# PREREQUISITES - pip install azure-identity - pip install azure-mgmt-portal -# USAGE - python create_or_update_a_dashboard.py - - Before run the sample, please set the values of the client ID, tenant ID and client secret - of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, - AZURE_CLIENT_SECRET. For more info about how to get the value, please see: - https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal -""" - - -def main(): - client = Portal( - credential=DefaultAzureCredential(), - subscription_id="00000000-0000-0000-0000-000000000000", - ) - - response = client.dashboards.create_or_update( - resource_group_name="testRG", - dashboard_name="testDashboard", - dashboard={ - "location": "eastus", - "properties": { - "lenses": [ - { - "order": 1, - "parts": [ - {"position": {"colSpan": 3, "rowSpan": 4, "x": 1, "y": 2}}, - {"position": {"colSpan": 6, "rowSpan": 6, "x": 5, "y": 5}}, - ], - }, - {"order": 2, "parts": []}, - ], - "metadata": {"metadata": {"ColSpan": 2, "RowSpan": 1, "X": 4, "Y": 3}}, - }, - "tags": {"aKey": "aValue", "anotherKey": "anotherValue"}, - }, - ) - print(response) - - -# x-ms-original-file: specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/createOrUpdateDashboard.json -if __name__ == "__main__": - main() diff --git a/sdk/portal/azure-mgmt-portal/generated_samples/create_or_update_tenant_configuration.py b/sdk/portal/azure-mgmt-portal/generated_samples/create_or_update_tenant_configuration.py deleted file mode 100644 index f87681298d92..000000000000 --- a/sdk/portal/azure-mgmt-portal/generated_samples/create_or_update_tenant_configuration.py +++ /dev/null @@ -1,41 +0,0 @@ -# coding=utf-8 -# -------------------------------------------------------------------------- -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for license information. -# Code generated by Microsoft (R) AutoRest Code Generator. -# Changes may cause incorrect behavior and will be lost if the code is regenerated. -# -------------------------------------------------------------------------- - -from azure.identity import DefaultAzureCredential -from azure.mgmt.portal import Portal - -""" -# PREREQUISITES - pip install azure-identity - pip install azure-mgmt-portal -# USAGE - python create_or_update_tenant_configuration.py - - Before run the sample, please set the values of the client ID, tenant ID and client secret - of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, - AZURE_CLIENT_SECRET. For more info about how to get the value, please see: - https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal -""" - - -def main(): - client = Portal( - credential=DefaultAzureCredential(), - subscription_id="SUBSCRIPTION_ID", - ) - - response = client.tenant_configurations.create( - configuration_name="default", - tenant_configuration={"properties": {"enforcePrivateMarkdownStorage": True}}, - ) - print(response) - - -# x-ms-original-file: specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/CreateOrUpdateTenantConfiguration.json -if __name__ == "__main__": - main() diff --git a/sdk/portal/azure-mgmt-portal/generated_samples/delete_a_dashboard.py b/sdk/portal/azure-mgmt-portal/generated_samples/dashboards_delete.py similarity index 89% rename from sdk/portal/azure-mgmt-portal/generated_samples/delete_a_dashboard.py rename to sdk/portal/azure-mgmt-portal/generated_samples/dashboards_delete.py index 895ebd8761da..e03d39a3f372 100644 --- a/sdk/portal/azure-mgmt-portal/generated_samples/delete_a_dashboard.py +++ b/sdk/portal/azure-mgmt-portal/generated_samples/dashboards_delete.py @@ -7,6 +7,7 @@ # -------------------------------------------------------------------------- from azure.identity import DefaultAzureCredential + from azure.mgmt.portal import Portal """ @@ -14,7 +15,7 @@ pip install azure-identity pip install azure-mgmt-portal # USAGE - python delete_a_dashboard.py + python dashboards_delete.py Before run the sample, please set the values of the client ID, tenant ID and client secret of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, @@ -29,13 +30,12 @@ def main(): subscription_id="00000000-0000-0000-0000-000000000000", ) - response = client.dashboards.delete( + client.dashboards.delete( resource_group_name="testRG", dashboard_name="testDashboard", ) - print(response) -# x-ms-original-file: specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/deleteDashboard.json +# x-ms-original-file: specification/portal/resource-manager/Microsoft.Portal/preview/2025-04-01-preview/examples/Dashboards_Delete.json if __name__ == "__main__": main() diff --git a/sdk/portal/azure-mgmt-portal/generated_samples/get_a_dashboard.py b/sdk/portal/azure-mgmt-portal/generated_samples/dashboards_get.py similarity index 93% rename from sdk/portal/azure-mgmt-portal/generated_samples/get_a_dashboard.py rename to sdk/portal/azure-mgmt-portal/generated_samples/dashboards_get.py index 6f3f41455af7..10f6988ceb71 100644 --- a/sdk/portal/azure-mgmt-portal/generated_samples/get_a_dashboard.py +++ b/sdk/portal/azure-mgmt-portal/generated_samples/dashboards_get.py @@ -7,6 +7,7 @@ # -------------------------------------------------------------------------- from azure.identity import DefaultAzureCredential + from azure.mgmt.portal import Portal """ @@ -14,7 +15,7 @@ pip install azure-identity pip install azure-mgmt-portal # USAGE - python get_a_dashboard.py + python dashboards_get.py Before run the sample, please set the values of the client ID, tenant ID and client secret of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, @@ -36,6 +37,6 @@ def main(): print(response) -# x-ms-original-file: specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/getDashboard.json +# x-ms-original-file: specification/portal/resource-manager/Microsoft.Portal/preview/2025-04-01-preview/examples/Dashboards_Get.json if __name__ == "__main__": main() diff --git a/sdk/portal/azure-mgmt-portal/generated_samples/list_all_custom_resource_providers_on_the_resource_group.py b/sdk/portal/azure-mgmt-portal/generated_samples/dashboards_list_by_resource_group.py similarity index 90% rename from sdk/portal/azure-mgmt-portal/generated_samples/list_all_custom_resource_providers_on_the_resource_group.py rename to sdk/portal/azure-mgmt-portal/generated_samples/dashboards_list_by_resource_group.py index 26f5dc9b31d5..a4b7d23c1f2c 100644 --- a/sdk/portal/azure-mgmt-portal/generated_samples/list_all_custom_resource_providers_on_the_resource_group.py +++ b/sdk/portal/azure-mgmt-portal/generated_samples/dashboards_list_by_resource_group.py @@ -7,6 +7,7 @@ # -------------------------------------------------------------------------- from azure.identity import DefaultAzureCredential + from azure.mgmt.portal import Portal """ @@ -14,7 +15,7 @@ pip install azure-identity pip install azure-mgmt-portal # USAGE - python list_all_custom_resource_providers_on_the_resource_group.py + python dashboards_list_by_resource_group.py Before run the sample, please set the values of the client ID, tenant ID and client secret of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, @@ -36,6 +37,6 @@ def main(): print(item) -# x-ms-original-file: specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/listDashboardsByResourceGroup.json +# x-ms-original-file: specification/portal/resource-manager/Microsoft.Portal/preview/2025-04-01-preview/examples/Dashboards_ListByResourceGroup.json if __name__ == "__main__": main() diff --git a/sdk/portal/azure-mgmt-portal/generated_samples/list_all_custom_resource_providers_on_the_subscription.py b/sdk/portal/azure-mgmt-portal/generated_samples/dashboards_list_by_subscription.py similarity index 90% rename from sdk/portal/azure-mgmt-portal/generated_samples/list_all_custom_resource_providers_on_the_subscription.py rename to sdk/portal/azure-mgmt-portal/generated_samples/dashboards_list_by_subscription.py index 01040ffce38e..babb5a55c0dd 100644 --- a/sdk/portal/azure-mgmt-portal/generated_samples/list_all_custom_resource_providers_on_the_subscription.py +++ b/sdk/portal/azure-mgmt-portal/generated_samples/dashboards_list_by_subscription.py @@ -7,6 +7,7 @@ # -------------------------------------------------------------------------- from azure.identity import DefaultAzureCredential + from azure.mgmt.portal import Portal """ @@ -14,7 +15,7 @@ pip install azure-identity pip install azure-mgmt-portal # USAGE - python list_all_custom_resource_providers_on_the_subscription.py + python dashboards_list_by_subscription.py Before run the sample, please set the values of the client ID, tenant ID and client secret of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, @@ -34,6 +35,6 @@ def main(): print(item) -# x-ms-original-file: specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/listDashboardsBySubscription.json +# x-ms-original-file: specification/portal/resource-manager/Microsoft.Portal/preview/2025-04-01-preview/examples/Dashboards_ListBySubscription.json if __name__ == "__main__": main() diff --git a/sdk/portal/azure-mgmt-portal/generated_samples/get_list_of_of_items_that_violate_tenant's_configuration.py b/sdk/portal/azure-mgmt-portal/generated_samples/list_tenant_configuration_violations_list.py similarity index 88% rename from sdk/portal/azure-mgmt-portal/generated_samples/get_list_of_of_items_that_violate_tenant's_configuration.py rename to sdk/portal/azure-mgmt-portal/generated_samples/list_tenant_configuration_violations_list.py index 61fbafab6d87..cf2ee0a330e8 100644 --- a/sdk/portal/azure-mgmt-portal/generated_samples/get_list_of_of_items_that_violate_tenant's_configuration.py +++ b/sdk/portal/azure-mgmt-portal/generated_samples/list_tenant_configuration_violations_list.py @@ -7,6 +7,7 @@ # -------------------------------------------------------------------------- from azure.identity import DefaultAzureCredential + from azure.mgmt.portal import Portal """ @@ -14,7 +15,7 @@ pip install azure-identity pip install azure-mgmt-portal # USAGE - python get_list_of_of_items_that_violate_tenant's_configuration.py + python list_tenant_configuration_violations_list.py Before run the sample, please set the values of the client ID, tenant ID and client secret of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, @@ -34,6 +35,6 @@ def main(): print(item) -# x-ms-original-file: specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetListOfTenantConfigurationViolations.json +# x-ms-original-file: specification/portal/resource-manager/Microsoft.Portal/preview/2025-04-01-preview/examples/ListTenantConfigurationViolations_List.json if __name__ == "__main__": main() diff --git a/sdk/portal/azure-mgmt-portal/generated_samples/list_the_portal_operations.py b/sdk/portal/azure-mgmt-portal/generated_samples/operations_list.py similarity index 92% rename from sdk/portal/azure-mgmt-portal/generated_samples/list_the_portal_operations.py rename to sdk/portal/azure-mgmt-portal/generated_samples/operations_list.py index cafed17bbe67..27627f59d805 100644 --- a/sdk/portal/azure-mgmt-portal/generated_samples/list_the_portal_operations.py +++ b/sdk/portal/azure-mgmt-portal/generated_samples/operations_list.py @@ -7,6 +7,7 @@ # -------------------------------------------------------------------------- from azure.identity import DefaultAzureCredential + from azure.mgmt.portal import Portal """ @@ -14,7 +15,7 @@ pip install azure-identity pip install azure-mgmt-portal # USAGE - python list_the_portal_operations.py + python operations_list.py Before run the sample, please set the values of the client ID, tenant ID and client secret of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, @@ -34,6 +35,6 @@ def main(): print(item) -# x-ms-original-file: specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/operationsList.json +# x-ms-original-file: specification/portal/resource-manager/Microsoft.Portal/preview/2025-04-01-preview/examples/Operations_List.json if __name__ == "__main__": main() diff --git a/sdk/portal/azure-mgmt-portal/generated_samples/delete_tenant_configuration.py b/sdk/portal/azure-mgmt-portal/generated_samples/tenant_configurations_delete.py similarity index 85% rename from sdk/portal/azure-mgmt-portal/generated_samples/delete_tenant_configuration.py rename to sdk/portal/azure-mgmt-portal/generated_samples/tenant_configurations_delete.py index 05a485fe9fa4..26c04c736e68 100644 --- a/sdk/portal/azure-mgmt-portal/generated_samples/delete_tenant_configuration.py +++ b/sdk/portal/azure-mgmt-portal/generated_samples/tenant_configurations_delete.py @@ -7,6 +7,7 @@ # -------------------------------------------------------------------------- from azure.identity import DefaultAzureCredential + from azure.mgmt.portal import Portal """ @@ -14,7 +15,7 @@ pip install azure-identity pip install azure-mgmt-portal # USAGE - python delete_tenant_configuration.py + python tenant_configurations_delete.py Before run the sample, please set the values of the client ID, tenant ID and client secret of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, @@ -29,12 +30,11 @@ def main(): subscription_id="SUBSCRIPTION_ID", ) - response = client.tenant_configurations.delete( + client.tenant_configurations.delete( configuration_name="default", ) - print(response) -# x-ms-original-file: specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/DeleteTenantConfiguration.json +# x-ms-original-file: specification/portal/resource-manager/Microsoft.Portal/preview/2025-04-01-preview/examples/TenantConfigurations_Delete.json if __name__ == "__main__": main() diff --git a/sdk/portal/azure-mgmt-portal/generated_samples/get_tenant_configuration.py b/sdk/portal/azure-mgmt-portal/generated_samples/tenant_configurations_get.py similarity index 90% rename from sdk/portal/azure-mgmt-portal/generated_samples/get_tenant_configuration.py rename to sdk/portal/azure-mgmt-portal/generated_samples/tenant_configurations_get.py index e91e29c052eb..80c332bb5564 100644 --- a/sdk/portal/azure-mgmt-portal/generated_samples/get_tenant_configuration.py +++ b/sdk/portal/azure-mgmt-portal/generated_samples/tenant_configurations_get.py @@ -7,6 +7,7 @@ # -------------------------------------------------------------------------- from azure.identity import DefaultAzureCredential + from azure.mgmt.portal import Portal """ @@ -14,7 +15,7 @@ pip install azure-identity pip install azure-mgmt-portal # USAGE - python get_tenant_configuration.py + python tenant_configurations_get.py Before run the sample, please set the values of the client ID, tenant ID and client secret of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, @@ -35,6 +36,6 @@ def main(): print(response) -# x-ms-original-file: specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetTenantConfiguration.json +# x-ms-original-file: specification/portal/resource-manager/Microsoft.Portal/preview/2025-04-01-preview/examples/TenantConfigurations_Get.json if __name__ == "__main__": main() diff --git a/sdk/portal/azure-mgmt-portal/generated_samples/get_list_of_tenant_configurations.py b/sdk/portal/azure-mgmt-portal/generated_samples/tenant_configurations_list.py similarity index 89% rename from sdk/portal/azure-mgmt-portal/generated_samples/get_list_of_tenant_configurations.py rename to sdk/portal/azure-mgmt-portal/generated_samples/tenant_configurations_list.py index 14005ca5eab8..663ab35aaaec 100644 --- a/sdk/portal/azure-mgmt-portal/generated_samples/get_list_of_tenant_configurations.py +++ b/sdk/portal/azure-mgmt-portal/generated_samples/tenant_configurations_list.py @@ -7,6 +7,7 @@ # -------------------------------------------------------------------------- from azure.identity import DefaultAzureCredential + from azure.mgmt.portal import Portal """ @@ -14,7 +15,7 @@ pip install azure-identity pip install azure-mgmt-portal # USAGE - python get_list_of_tenant_configurations.py + python tenant_configurations_list.py Before run the sample, please set the values of the client ID, tenant ID and client secret of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, @@ -34,6 +35,6 @@ def main(): print(item) -# x-ms-original-file: specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetListOfTenantConfigurations.json +# x-ms-original-file: specification/portal/resource-manager/Microsoft.Portal/preview/2025-04-01-preview/examples/TenantConfigurations_List.json if __name__ == "__main__": main() diff --git a/sdk/portal/azure-mgmt-portal/generated_samples/update_a_dashboard.py b/sdk/portal/azure-mgmt-portal/generated_samples/update_a_dashboard.py deleted file mode 100644 index 76cd83bfb28e..000000000000 --- a/sdk/portal/azure-mgmt-portal/generated_samples/update_a_dashboard.py +++ /dev/null @@ -1,42 +0,0 @@ -# coding=utf-8 -# -------------------------------------------------------------------------- -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for license information. -# Code generated by Microsoft (R) AutoRest Code Generator. -# Changes may cause incorrect behavior and will be lost if the code is regenerated. -# -------------------------------------------------------------------------- - -from azure.identity import DefaultAzureCredential -from azure.mgmt.portal import Portal - -""" -# PREREQUISITES - pip install azure-identity - pip install azure-mgmt-portal -# USAGE - python update_a_dashboard.py - - Before run the sample, please set the values of the client ID, tenant ID and client secret - of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, - AZURE_CLIENT_SECRET. For more info about how to get the value, please see: - https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal -""" - - -def main(): - client = Portal( - credential=DefaultAzureCredential(), - subscription_id="00000000-0000-0000-0000-000000000000", - ) - - response = client.dashboards.update( - resource_group_name="testRG", - dashboard_name="testDashboard", - dashboard={"tags": {"aKey": "bValue", "anotherKey": "anotherValue2"}}, - ) - print(response) - - -# x-ms-original-file: specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/updateDashboard.json -if __name__ == "__main__": - main() diff --git a/sdk/portal/azure-mgmt-portal/generated_tests/conftest.py b/sdk/portal/azure-mgmt-portal/generated_tests/conftest.py new file mode 100644 index 000000000000..aae3055fd55f --- /dev/null +++ b/sdk/portal/azure-mgmt-portal/generated_tests/conftest.py @@ -0,0 +1,35 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import os +import pytest +from dotenv import load_dotenv +from devtools_testutils import ( + test_proxy, + add_general_regex_sanitizer, + add_body_key_sanitizer, + add_header_regex_sanitizer, +) + +load_dotenv() + + +# For security, please avoid record sensitive identity information in recordings +@pytest.fixture(scope="session", autouse=True) +def add_sanitizers(test_proxy): + portal_subscription_id = os.environ.get("AZURE_SUBSCRIPTION_ID", "00000000-0000-0000-0000-000000000000") + portal_tenant_id = os.environ.get("AZURE_TENANT_ID", "00000000-0000-0000-0000-000000000000") + portal_client_id = os.environ.get("AZURE_CLIENT_ID", "00000000-0000-0000-0000-000000000000") + portal_client_secret = os.environ.get("AZURE_CLIENT_SECRET", "00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=portal_subscription_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=portal_tenant_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=portal_client_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=portal_client_secret, value="00000000-0000-0000-0000-000000000000") + + add_header_regex_sanitizer(key="Set-Cookie", value="[set-cookie;]") + add_header_regex_sanitizer(key="Cookie", value="cookie;") + add_body_key_sanitizer(json_path="$..access_token", value="access_token") diff --git a/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_dashboards_operations.py b/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_dashboards_operations.py new file mode 100644 index 000000000000..15909ca75762 --- /dev/null +++ b/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_dashboards_operations.py @@ -0,0 +1,137 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from azure.mgmt.portal import Portal + +from devtools_testutils import AzureMgmtRecordedTestCase, RandomNameResourceGroupPreparer, recorded_by_proxy + +AZURE_LOCATION = "eastus" + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestPortalDashboardsOperations(AzureMgmtRecordedTestCase): + def setup_method(self, method): + self.client = self.create_mgmt_client(Portal) + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_dashboards_list_by_subscription(self, resource_group): + response = self.client.dashboards.list_by_subscription( + api_version="2025-04-01-preview", + ) + result = [r for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_dashboards_list_by_resource_group(self, resource_group): + response = self.client.dashboards.list_by_resource_group( + resource_group_name=resource_group.name, + api_version="2025-04-01-preview", + ) + result = [r for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_dashboards_get(self, resource_group): + response = self.client.dashboards.get( + resource_group_name=resource_group.name, + dashboard_name="str", + api_version="2025-04-01-preview", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_dashboards_create_or_update(self, resource_group): + response = self.client.dashboards.create_or_update( + resource_group_name=resource_group.name, + dashboard_name="str", + resource={ + "location": "str", + "id": "str", + "name": "str", + "properties": { + "lenses": [ + { + "order": 0, + "parts": [ + { + "position": {"colSpan": 0, "rowSpan": 0, "x": 0, "y": 0, "metadata": {}}, + "metadata": "dashboard_part_metadata", + } + ], + "metadata": {}, + } + ], + "metadata": {}, + "provisioningState": "str", + }, + "systemData": { + "createdAt": "2020-02-20 00:00:00", + "createdBy": "str", + "createdByType": "str", + "lastModifiedAt": "2020-02-20 00:00:00", + "lastModifiedBy": "str", + "lastModifiedByType": "str", + }, + "tags": {"str": "str"}, + "type": "str", + }, + api_version="2025-04-01-preview", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_dashboards_update(self, resource_group): + response = self.client.dashboards.update( + resource_group_name=resource_group.name, + dashboard_name="str", + properties={ + "properties": { + "lenses": [ + { + "order": 0, + "parts": [ + { + "position": {"colSpan": 0, "rowSpan": 0, "x": 0, "y": 0, "metadata": {}}, + "metadata": "dashboard_part_metadata", + } + ], + "metadata": {}, + } + ], + "metadata": {}, + }, + "tags": {"str": "str"}, + }, + api_version="2025-04-01-preview", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_dashboards_delete(self, resource_group): + response = self.client.dashboards.delete( + resource_group_name=resource_group.name, + dashboard_name="str", + api_version="2025-04-01-preview", + ) + + # please add some check logic here by yourself + # ... diff --git a/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_dashboards_operations_async.py b/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_dashboards_operations_async.py new file mode 100644 index 000000000000..d51527fc2780 --- /dev/null +++ b/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_dashboards_operations_async.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) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from azure.mgmt.portal.aio import Portal + +from devtools_testutils import AzureMgmtRecordedTestCase, RandomNameResourceGroupPreparer +from devtools_testutils.aio import recorded_by_proxy_async + +AZURE_LOCATION = "eastus" + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestPortalDashboardsOperationsAsync(AzureMgmtRecordedTestCase): + def setup_method(self, method): + self.client = self.create_mgmt_client(Portal, is_async=True) + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_dashboards_list_by_subscription(self, resource_group): + response = self.client.dashboards.list_by_subscription( + api_version="2025-04-01-preview", + ) + result = [r async for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_dashboards_list_by_resource_group(self, resource_group): + response = self.client.dashboards.list_by_resource_group( + resource_group_name=resource_group.name, + api_version="2025-04-01-preview", + ) + result = [r async for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_dashboards_get(self, resource_group): + response = await self.client.dashboards.get( + resource_group_name=resource_group.name, + dashboard_name="str", + api_version="2025-04-01-preview", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_dashboards_create_or_update(self, resource_group): + response = await self.client.dashboards.create_or_update( + resource_group_name=resource_group.name, + dashboard_name="str", + resource={ + "location": "str", + "id": "str", + "name": "str", + "properties": { + "lenses": [ + { + "order": 0, + "parts": [ + { + "position": {"colSpan": 0, "rowSpan": 0, "x": 0, "y": 0, "metadata": {}}, + "metadata": "dashboard_part_metadata", + } + ], + "metadata": {}, + } + ], + "metadata": {}, + "provisioningState": "str", + }, + "systemData": { + "createdAt": "2020-02-20 00:00:00", + "createdBy": "str", + "createdByType": "str", + "lastModifiedAt": "2020-02-20 00:00:00", + "lastModifiedBy": "str", + "lastModifiedByType": "str", + }, + "tags": {"str": "str"}, + "type": "str", + }, + api_version="2025-04-01-preview", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_dashboards_update(self, resource_group): + response = await self.client.dashboards.update( + resource_group_name=resource_group.name, + dashboard_name="str", + properties={ + "properties": { + "lenses": [ + { + "order": 0, + "parts": [ + { + "position": {"colSpan": 0, "rowSpan": 0, "x": 0, "y": 0, "metadata": {}}, + "metadata": "dashboard_part_metadata", + } + ], + "metadata": {}, + } + ], + "metadata": {}, + }, + "tags": {"str": "str"}, + }, + api_version="2025-04-01-preview", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_dashboards_delete(self, resource_group): + response = await self.client.dashboards.delete( + resource_group_name=resource_group.name, + dashboard_name="str", + api_version="2025-04-01-preview", + ) + + # please add some check logic here by yourself + # ... diff --git a/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_list_tenant_configuration_violations_operations.py b/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_list_tenant_configuration_violations_operations.py new file mode 100644 index 000000000000..6a60bcded89a --- /dev/null +++ b/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_list_tenant_configuration_violations_operations.py @@ -0,0 +1,29 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from azure.mgmt.portal import Portal + +from devtools_testutils import AzureMgmtRecordedTestCase, RandomNameResourceGroupPreparer, recorded_by_proxy + +AZURE_LOCATION = "eastus" + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestPortalListTenantConfigurationViolationsOperations(AzureMgmtRecordedTestCase): + def setup_method(self, method): + self.client = self.create_mgmt_client(Portal) + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_list_tenant_configuration_violations_list(self, resource_group): + response = self.client.list_tenant_configuration_violations.list( + api_version="2025-04-01-preview", + ) + result = [r for r in response] + # please add some check logic here by yourself + # ... diff --git a/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_list_tenant_configuration_violations_operations_async.py b/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_list_tenant_configuration_violations_operations_async.py new file mode 100644 index 000000000000..fd6440171e56 --- /dev/null +++ b/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_list_tenant_configuration_violations_operations_async.py @@ -0,0 +1,30 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from azure.mgmt.portal.aio import Portal + +from devtools_testutils import AzureMgmtRecordedTestCase, RandomNameResourceGroupPreparer +from devtools_testutils.aio import recorded_by_proxy_async + +AZURE_LOCATION = "eastus" + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestPortalListTenantConfigurationViolationsOperationsAsync(AzureMgmtRecordedTestCase): + def setup_method(self, method): + self.client = self.create_mgmt_client(Portal, is_async=True) + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_list_tenant_configuration_violations_list(self, resource_group): + response = self.client.list_tenant_configuration_violations.list( + api_version="2025-04-01-preview", + ) + result = [r async for r in response] + # please add some check logic here by yourself + # ... diff --git a/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_operations.py b/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_operations.py new file mode 100644 index 000000000000..e250431f44fd --- /dev/null +++ b/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_operations.py @@ -0,0 +1,29 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from azure.mgmt.portal import Portal + +from devtools_testutils import AzureMgmtRecordedTestCase, RandomNameResourceGroupPreparer, recorded_by_proxy + +AZURE_LOCATION = "eastus" + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestPortalOperations(AzureMgmtRecordedTestCase): + def setup_method(self, method): + self.client = self.create_mgmt_client(Portal) + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_operations_list(self, resource_group): + response = self.client.operations.list( + api_version="2025-04-01-preview", + ) + result = [r for r in response] + # please add some check logic here by yourself + # ... diff --git a/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_operations_async.py b/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_operations_async.py new file mode 100644 index 000000000000..ed5d25903f7d --- /dev/null +++ b/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_operations_async.py @@ -0,0 +1,30 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from azure.mgmt.portal.aio import Portal + +from devtools_testutils import AzureMgmtRecordedTestCase, RandomNameResourceGroupPreparer +from devtools_testutils.aio import recorded_by_proxy_async + +AZURE_LOCATION = "eastus" + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestPortalOperationsAsync(AzureMgmtRecordedTestCase): + def setup_method(self, method): + self.client = self.create_mgmt_client(Portal, is_async=True) + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_operations_list(self, resource_group): + response = self.client.operations.list( + api_version="2025-04-01-preview", + ) + result = [r async for r in response] + # please add some check logic here by yourself + # ... diff --git a/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_tenant_configurations_operations.py b/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_tenant_configurations_operations.py new file mode 100644 index 000000000000..75015b2c3db9 --- /dev/null +++ b/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_tenant_configurations_operations.py @@ -0,0 +1,76 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from azure.mgmt.portal import Portal + +from devtools_testutils import AzureMgmtRecordedTestCase, RandomNameResourceGroupPreparer, recorded_by_proxy + +AZURE_LOCATION = "eastus" + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestPortalTenantConfigurationsOperations(AzureMgmtRecordedTestCase): + def setup_method(self, method): + self.client = self.create_mgmt_client(Portal) + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_tenant_configurations_list(self, resource_group): + response = self.client.tenant_configurations.list( + api_version="2025-04-01-preview", + ) + result = [r for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_tenant_configurations_get(self, resource_group): + response = self.client.tenant_configurations.get( + configuration_name="str", + api_version="2025-04-01-preview", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_tenant_configurations_create(self, resource_group): + response = self.client.tenant_configurations.create( + configuration_name="str", + resource={ + "id": "str", + "name": "str", + "properties": {"enforcePrivateMarkdownStorage": bool, "provisioningState": "str"}, + "systemData": { + "createdAt": "2020-02-20 00:00:00", + "createdBy": "str", + "createdByType": "str", + "lastModifiedAt": "2020-02-20 00:00:00", + "lastModifiedBy": "str", + "lastModifiedByType": "str", + }, + "type": "str", + }, + api_version="2025-04-01-preview", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy + def test_tenant_configurations_delete(self, resource_group): + response = self.client.tenant_configurations.delete( + configuration_name="str", + api_version="2025-04-01-preview", + ) + + # please add some check logic here by yourself + # ... diff --git a/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_tenant_configurations_operations_async.py b/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_tenant_configurations_operations_async.py new file mode 100644 index 000000000000..a78c67643bba --- /dev/null +++ b/sdk/portal/azure-mgmt-portal/generated_tests/test_portal_tenant_configurations_operations_async.py @@ -0,0 +1,77 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from azure.mgmt.portal.aio import Portal + +from devtools_testutils import AzureMgmtRecordedTestCase, RandomNameResourceGroupPreparer +from devtools_testutils.aio import recorded_by_proxy_async + +AZURE_LOCATION = "eastus" + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestPortalTenantConfigurationsOperationsAsync(AzureMgmtRecordedTestCase): + def setup_method(self, method): + self.client = self.create_mgmt_client(Portal, is_async=True) + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_tenant_configurations_list(self, resource_group): + response = self.client.tenant_configurations.list( + api_version="2025-04-01-preview", + ) + result = [r async for r in response] + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_tenant_configurations_get(self, resource_group): + response = await self.client.tenant_configurations.get( + configuration_name="str", + api_version="2025-04-01-preview", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_tenant_configurations_create(self, resource_group): + response = await self.client.tenant_configurations.create( + configuration_name="str", + resource={ + "id": "str", + "name": "str", + "properties": {"enforcePrivateMarkdownStorage": bool, "provisioningState": "str"}, + "systemData": { + "createdAt": "2020-02-20 00:00:00", + "createdBy": "str", + "createdByType": "str", + "lastModifiedAt": "2020-02-20 00:00:00", + "lastModifiedBy": "str", + "lastModifiedByType": "str", + }, + "type": "str", + }, + api_version="2025-04-01-preview", + ) + + # please add some check logic here by yourself + # ... + + @RandomNameResourceGroupPreparer(location=AZURE_LOCATION) + @recorded_by_proxy_async + async def test_tenant_configurations_delete(self, resource_group): + response = await self.client.tenant_configurations.delete( + configuration_name="str", + api_version="2025-04-01-preview", + ) + + # please add some check logic here by yourself + # ... diff --git a/sdk/portal/azure-mgmt-portal/setup.py b/sdk/portal/azure-mgmt-portal/setup.py index e44bfe691b32..20db572cdf66 100644 --- a/sdk/portal/azure-mgmt-portal/setup.py +++ b/sdk/portal/azure-mgmt-portal/setup.py @@ -1,10 +1,10 @@ #!/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 @@ -16,63 +16,68 @@ PACKAGE_PPRINT_NAME = "Portal Management" # a-b-c => a/b/c -package_folder_path = PACKAGE_NAME.replace('-', '/') +package_folder_path = PACKAGE_NAME.replace("-", "/") # a-b-c => a.b.c -namespace_name = PACKAGE_NAME.replace('-', '.') +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) +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') + raise RuntimeError("Cannot find version information") -with open('README.md', encoding='utf-8') as f: +with open("README.md", encoding="utf-8") as f: readme = f.read() -with open('CHANGELOG.md', encoding='utf-8') as f: +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', + description="Microsoft Azure {} Client Library for Python".format(PACKAGE_PPRINT_NAME), + long_description=readme + "\n\n" + changelog, + long_description_content_type="text/markdown", + license="MIT License", + author="Microsoft Corporation", + author_email="azpysdkhelp@microsoft.com", + url="https://github.com/Azure/azure-sdk-for-python", keywords="azure, azure sdk", # update with search keywords relevant to the azure service / product classifiers=[ - 'Development Status :: 5 - Production/Stable', - 'Programming Language :: Python', - 'Programming Language :: Python :: 3 :: Only', - 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3.7', - 'Programming Language :: Python :: 3.8', - 'Programming Language :: Python :: 3.9', - 'Programming Language :: Python :: 3.10', - 'License :: OSI Approved :: MIT License', + "Development Status :: 5 - Production/Stable", + "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', - ]), + 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'], + "pytyped": ["py.typed"], }, install_requires=[ - "msrest>=0.7.1", - "azure-common~=1.1", - "azure-mgmt-core>=1.3.2,<2.0.0", - "typing-extensions>=4.3.0; python_version<'3.8.0'", + "isodate>=0.6.1", + "typing-extensions>=4.6.0", + "azure-common>=1.1", + "azure-mgmt-core>=1.3.2", ], - python_requires=">=3.7" + python_requires=">=3.8", )