From c1e8b3bc73334aa9d9fa72d7225c25b51463fb70 Mon Sep 17 00:00:00 2001 From: Paul Van Eck Date: Sun, 20 Jul 2025 10:39:36 +0000 Subject: [PATCH 1/2] [Monitor] Add Metrics Query library This adds the TypeSpec-based azure-monitor-querymetrics package. Signed-off-by: Paul Van Eck --- .../azure-monitor-querymetrics/CHANGELOG.md | 13 + .../azure-monitor-querymetrics/LICENSE | 21 + .../azure-monitor-querymetrics/MANIFEST.in | 8 + .../azure-monitor-querymetrics/README.md | 250 ++ .../TROUBLESHOOTING.md | 89 + .../azure-monitor-querymetrics/_metadata.json | 3 + .../apiview-properties.json | 19 + .../azure-monitor-querymetrics/assets.json | 6 + .../azure/__init__.py | 1 + .../azure/monitor/__init__.py | 1 + .../azure/monitor/querymetrics/__init__.py | 22 + .../azure/monitor/querymetrics/_client.py | 174 ++ .../azure/monitor/querymetrics/_enums.py | 21 + .../querymetrics/_generated/__init__.py | 32 + .../querymetrics/_generated/_client.py | 102 + .../querymetrics/_generated/_configuration.py | 67 + .../_generated/_operations/__init__.py | 22 + .../_generated/_operations/_operations.py | 484 ++++ .../_generated/_operations/_patch.py | 21 + .../monitor/querymetrics/_generated/_patch.py | 21 + .../_generated/_utils/__init__.py | 6 + .../_generated/_utils/model_base.py | 1232 ++++++++++ .../_generated/_utils/serialization.py | 2032 +++++++++++++++++ .../querymetrics/_generated/_utils/utils.py | 25 + .../querymetrics/_generated/_version.py | 9 + .../querymetrics/_generated/aio/__init__.py | 29 + .../querymetrics/_generated/aio/_client.py | 104 + .../_generated/aio/_configuration.py | 67 + .../_generated/aio/_operations/__init__.py | 22 + .../_generated/aio/_operations/_operations.py | 423 ++++ .../_generated/aio/_operations/_patch.py | 21 + .../querymetrics/_generated/aio/_patch.py | 21 + .../_generated/models/__init__.py | 52 + .../querymetrics/_generated/models/_enums.py | 42 + .../querymetrics/_generated/models/_models.py | 452 ++++ .../querymetrics/_generated/models/_patch.py | 21 + .../monitor/querymetrics/_generated/py.typed | 1 + .../azure/monitor/querymetrics/_models.py | 196 ++ .../azure/monitor/querymetrics/_utils.py | 73 + .../azure/monitor/querymetrics/_version.py | 9 + .../monitor/querymetrics/aio/__init__.py | 7 + .../azure/monitor/querymetrics/aio/_client.py | 174 ++ .../azure/monitor/querymetrics/py.typed | 1 + .../dev_requirements.txt | 4 + .../sdk_packaging.tom | 2 + .../azure-monitor-querymetrics/setup.py | 72 + .../tests/base_testcase.py | 40 + .../tests/conftest.py | 37 + .../tests/test_metrics_client.py | 79 + .../tests/test_metrics_client_async.py | 92 + .../tsp-location.yaml | 4 + sdk/monitor/ci.yml | 2 + 52 files changed, 6728 insertions(+) create mode 100644 sdk/monitor/azure-monitor-querymetrics/CHANGELOG.md create mode 100644 sdk/monitor/azure-monitor-querymetrics/LICENSE create mode 100644 sdk/monitor/azure-monitor-querymetrics/MANIFEST.in create mode 100644 sdk/monitor/azure-monitor-querymetrics/README.md create mode 100644 sdk/monitor/azure-monitor-querymetrics/TROUBLESHOOTING.md create mode 100644 sdk/monitor/azure-monitor-querymetrics/_metadata.json create mode 100644 sdk/monitor/azure-monitor-querymetrics/apiview-properties.json create mode 100644 sdk/monitor/azure-monitor-querymetrics/assets.json create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/__init__.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/__init__.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/__init__.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_client.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_enums.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/__init__.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_client.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_configuration.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_operations/__init__.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_operations/_operations.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_operations/_patch.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_patch.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_utils/__init__.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_utils/model_base.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_utils/serialization.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_utils/utils.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_version.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/__init__.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_client.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_configuration.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_operations/__init__.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_operations/_operations.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_operations/_patch.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_patch.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/models/__init__.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/models/_enums.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/models/_models.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/models/_patch.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/py.typed create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_models.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_utils.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_version.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/aio/__init__.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/aio/_client.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/py.typed create mode 100644 sdk/monitor/azure-monitor-querymetrics/dev_requirements.txt create mode 100644 sdk/monitor/azure-monitor-querymetrics/sdk_packaging.tom create mode 100644 sdk/monitor/azure-monitor-querymetrics/setup.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/tests/base_testcase.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/tests/conftest.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/tests/test_metrics_client.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/tests/test_metrics_client_async.py create mode 100644 sdk/monitor/azure-monitor-querymetrics/tsp-location.yaml diff --git a/sdk/monitor/azure-monitor-querymetrics/CHANGELOG.md b/sdk/monitor/azure-monitor-querymetrics/CHANGELOG.md new file mode 100644 index 000000000000..30e559d3504a --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/CHANGELOG.md @@ -0,0 +1,13 @@ +# Release History + +## 1.0.0 (Unreleased) + +### Features Added + +- Initial release. This version includes the core functionality for querying metrics from Azure Monitor using the `MetricsClient`, which was originally introduced in the `azure-monitor-query` package. + +### Breaking Changes + +### Bugs Fixed + +### Other Changes diff --git a/sdk/monitor/azure-monitor-querymetrics/LICENSE b/sdk/monitor/azure-monitor-querymetrics/LICENSE new file mode 100644 index 000000000000..b2f52a2bad4e --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/LICENSE @@ -0,0 +1,21 @@ +Copyright (c) Microsoft Corporation. + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/sdk/monitor/azure-monitor-querymetrics/MANIFEST.in b/sdk/monitor/azure-monitor-querymetrics/MANIFEST.in new file mode 100644 index 000000000000..50d633925660 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/MANIFEST.in @@ -0,0 +1,8 @@ +include *.md +include LICENSE +include azure/monitor/querymetrics/py.typed +recursive-include tests *.py +recursive-include samples *.py *.md +include azure/__init__.py +include azure/monitor/__init__.py +include azure/monitor/querymetrics/__init__.py diff --git a/sdk/monitor/azure-monitor-querymetrics/README.md b/sdk/monitor/azure-monitor-querymetrics/README.md new file mode 100644 index 000000000000..529223916c93 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/README.md @@ -0,0 +1,250 @@ +# Azure Monitor Query Metrics client library for Python + +The Azure Monitor Query Metrics client library is used to execute read-only queries against [Azure Monitor][azure_monitor_overview]'s metrics data platform: + +- [Metrics](https://learn.microsoft.com/azure/azure-monitor/essentials/data-platform-metrics) - Collects numeric data from monitored resources into a time series database. Metrics are numerical values that are collected at regular intervals and describe some aspect of a system at a particular time. Metrics are lightweight and capable of supporting near real-time scenarios, making them useful for alerting and fast detection of issues. + +**Resources:** + + +- [Source code][source] +- [Service documentation][azure_monitor_overview] +- [Change log][changelog] + +## Getting started + +### Prerequisites + +- Python 3.9 or later +- An [Azure subscription][azure_subscription] +- Authorization to read metrics data at the Azure subscription level. For example, the [Monitoring Reader role](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles/monitor#monitoring-reader) on the subscription containing the resources to be queried. +- An Azure resource of any kind (Storage Account, Key Vault, Cosmos DB, etc.). + +### Install the package + +Install the Azure Monitor Query Metrics client library for Python with [pip][pip]: + +```bash +pip install azure-monitor-querymetrics +``` + +### Create the client + +An authenticated client is required to query Metrics. The library includes both synchronous and asynchronous forms of the client. To authenticate, create an instance of a token credential. Use that instance when creating a `MetricsClient`. The following examples use `DefaultAzureCredential` from the [azure-identity](https://pypi.org/project/azure-identity/) package. + +#### Synchronous client + +Consider the following example, which creates a synchronous client for Metrics querying: + +```python +from azure.identity import DefaultAzureCredential +from azure.monitor.querymetrics import MetricsClient + +credential = DefaultAzureCredential() +metrics_client = MetricsClient("https://", credential) +``` + +#### Asynchronous client + +The asynchronous form of the client API is found in the `.aio`-suffixed namespace. For example: + +```python +from azure.identity.aio import DefaultAzureCredential +from azure.monitor.querymetrics.aio import MetricsClient + +credential = DefaultAzureCredential() +async_metrics_client = MetricsClient("https://", credential) +``` + +To use the asynchronous clients, you must also install an async transport, such as [aiohttp](https://pypi.org/project/aiohttp/). + +```sh +pip install aiohttp +``` + +#### Configure client for Azure sovereign cloud + +By default, the client is configured to use the Azure public cloud. To use a sovereign cloud, provide the correct `audience` argument when creating the `MetricsClient`. For example: + +```python +from azure.identity import AzureAuthorityHosts, DefaultAzureCredential +from azure.monitor.querymetrics import MetricsClient + +# Authority can also be set via the AZURE_AUTHORITY_HOST environment variable. +credential = DefaultAzureCredential(authority=AzureAuthorityHosts.AZURE_GOVERNMENT) + +metrics_client = MetricsClient( + "https://usgovvirginia.metrics.monitor.azure.us", credential, audience="https://metrics.monitor.azure.us" +) +``` + +### Execute the query + +For examples of Metrics queries, see the [Examples](#examples) section. + +## Key concepts + +### Metrics data structure + +Each set of metric values is a time series with the following characteristics: + +- The time the value was collected +- The resource associated with the value +- A namespace that acts like a category for the metric +- A metric name +- The value itself +- Some metrics have multiple dimensions as described in multi-dimensional metrics. + +## Examples + +- [Metrics query](#metrics-query) + - [Handle metrics query response](#handle-metrics-query-response) + +### Metrics query + +To query metrics for one or more Azure resources, use the `query_resources` method of `MetricsClient`. This method requires a regional endpoint when creating the client. For example, "https://westus3.metrics.monitor.azure.com". + +Each Azure resource must reside in: + +- The same region as the endpoint specified when creating the client. +- The same Azure subscription. + +The resource IDs must be that of the resources for which metrics are being queried. It's normally of the format `/subscriptions//resourceGroups//providers//topics/`. + +To find the resource ID/URI: + +1. Navigate to your resource's page in the Azure portal. +1. Select the **JSON View** link in the **Overview** section. +1. Copy the value in the **Resource ID** text box at the top of the JSON view. + +Furthermore: + +- The user must be authorized to read monitoring data at the Azure subscription level. For example, the [Monitoring Reader role](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles/monitor#monitoring-reader) on the subscription to be queried. +- The metric namespace containing the metrics to be queried must be provided. For a list of metric namespaces, see [Supported metrics and log categories by resource type][metric_namespaces]. + +```python +from datetime import timedelta +import os + +from azure.core.exceptions import HttpResponseError +from azure.identity import DefaultAzureCredential +from azure.monitor.querymetrics import MetricsClient, MetricAggregationType + +endpoint = "https://westus3.metrics.monitor.azure.com" +credential = DefaultAzureCredential() +client = MetricsClient(endpoint, credential) + +resource_ids = [ + "/subscriptions//resourceGroups//providers//storageAccounts/", + "/subscriptions//resourceGroups//providers//storageAccounts/" +] + +response = client.query_resources( + resource_ids=resource_ids, + metric_namespace="Microsoft.Storage/storageAccounts", + metric_names=["UsedCapacity"], + timespan=timedelta(hours=2), + granularity=timedelta(minutes=5), + aggregations=[MetricAggregationType.AVERAGE], +) + +for metrics_query_result in response: + for metric in metrics_query_result.metrics: + print(f"Metric: {metric.name}") + for time_series in metric.timeseries: + for metric_value in time_series.data: + if metric_value.average is not None: + print(f"Average: {metric_value.average}") +``` + +#### Handle metrics query response + +The metrics query API returns a list of `MetricsQueryResult` objects. The `MetricsQueryResult` object contains properties such as a list of `Metric`-typed objects, `granularity`, `namespace`, and `timespan`. The `Metric` objects list can be accessed using the `metrics` param. Each `Metric` object in this list contains a list of `TimeSeriesElement` objects. Each `TimeSeriesElement` object contains `data` and `metadata_values` properties. In visual form, the object hierarchy of the response resembles the following structure: + +``` +MetricsQueryResult +|---granularity +|---timespan +|---cost +|---namespace +|---resource_region +|---metrics (list of `Metric` objects) + |---id + |---type + |---name + |---unit + |---timeseries (list of `TimeSeriesElement` objects) + |---metadata_values + |---data (list of data points) +``` + +**Note:** Each `MetricsQueryResult` is returned in the same order as the corresponding resource in the `resource_ids` parameter. If multiple different metrics are queried, the metrics are returned in the order of the `metric_names` sent. + +**Example of handling response** + +```python +import os +from azure.monitor.querymetrics import MetricsClient, MetricAggregationType +from azure.identity import DefaultAzureCredential + +credential = DefaultAzureCredential() +client = MetricsClient("https://", credential) + +metrics_uri = os.environ['METRICS_RESOURCE_URI'] +response = client.query_resource( + metrics_uri, + metric_names=["PublishSuccessCount"], + aggregations=[MetricAggregationType.AVERAGE] +) + +for metrics_query_result in response: + for metric in metrics_query_result.metrics: + print(f"Metric: {metric.name}") + for time_series in metric.timeseries: + for metric_value in time_series.data: + if metric_value.average is not None: + print(f"Average: {metric_value.average}") +``` + +## Troubleshooting + +See our [troubleshooting guide][troubleshooting_guide] for details on how to diagnose various failure scenarios. + +## Next steps + +To learn more about Azure Monitor, see the [Azure Monitor service documentation][azure_monitor_overview]. + +### Samples + +The following code samples show common scenarios with the Azure Monitor Query Metrics client library. + +#### Metrics query samples + +To be added. + +## Contributing + +This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit [cla.microsoft.com][cla]. + +When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA. + +This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments. + + + +[azure_core_exceptions]: https://aka.ms/azsdk/python/core/docs#module-azure.core.exceptions +[azure_core_ref_docs]: https://aka.ms/azsdk/python/core/docs +[azure_monitor_overview]: https://learn.microsoft.com/azure/azure-monitor/ +[azure_subscription]: https://azure.microsoft.com/free/python/ +[changelog]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/monitor/azure-monitor-querymetrics/CHANGELOG.md +[metric_namespaces]: https://learn.microsoft.com/azure/azure-monitor/reference/supported-metrics/metrics-index#supported-metrics-and-log-categories-by-resource-type +[pip]: https://pypi.org/project/pip/ +[python_logging]: https://docs.python.org/3/library/logging.html +[samples]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/monitor/azure-monitor-querymetrics/samples +[source]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/monitor/azure-monitor-querymetrics/ +[troubleshooting_guide]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/monitor/azure-monitor-querymetrics/TROUBLESHOOTING.md + +[cla]: https://cla.microsoft.com +[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ +[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/ +[coc_contact]: mailto:opencode@microsoft.com diff --git a/sdk/monitor/azure-monitor-querymetrics/TROUBLESHOOTING.md b/sdk/monitor/azure-monitor-querymetrics/TROUBLESHOOTING.md new file mode 100644 index 000000000000..5d57ad83909e --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/TROUBLESHOOTING.md @@ -0,0 +1,89 @@ +# Troubleshooting Azure Monitor Query Metrics client library issues + +This troubleshooting guide contains instructions to diagnose frequently encountered issues while using the Azure Monitor Query Metrics client library for Python. + +## Table of contents + +* [General Troubleshooting](#general-troubleshooting) + * [Enable client logging](#enable-client-logging) + * [Troubleshooting authentication issues with metrics query requests](#authentication-errors) + * [Troubleshooting running async APIs](#errors-with-running-async-apis) +* [Troubleshooting Metrics Query](#troubleshooting-metrics-query) + * [Troubleshooting insufficient access error](#troubleshooting-insufficient-access-error-for-metrics-query) + * [Troubleshooting unsupported granularity for metrics query](#troubleshooting-unsupported-granularity-for-metrics-query) +* [Additional azure-core configurations](#additional-azure-core-configurations) + + +## General Troubleshooting + +Monitor query raises exceptions described in [`azure-core`](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md) + +### Enable client logging + +To troubleshoot issues with Azure Monitor Query Metrics library, it is important to first enable logging to monitor the behavior of the application. The errors and warnings in the logs generally provide useful insights into what went wrong and sometimes include corrective actions to fix issues. + +This library uses the standard [logging](https://docs.python.org/3/library/logging.html) library for logging. Basic information about HTTP sessions, such as URLs and headers, is logged at the INFO level. +Detailed DEBUG level logging, including request/response bodies and unredacted headers, can be enabled on a client with the logging_enable argument: + +```python +import logging +from azure.monitor.querymetrics import MetricsClient + +# Create a logger for the 'azure.monitor.querymetrics' SDK +logger = logging.getLogger('azure.monitor.querymetrics') +logger.setLevel(logging.DEBUG) + +# Configure a console output +handler = logging.StreamHandler(stream=sys.stdout) +logger.addHandler(handler) + +client = MetricsClient(credential, logging_enable=True) +``` + +Similarly, logging_enable can enable detailed logging for a single operation, even when it isn't enabled for the client: + +```python +client.query_workspace(logging_enable=True) +``` + +### Authentication errors + +Azure Monitor Query Metrics supports Azure Active Directory authentication. The MetricsClient has methods to set the `credential`. To provide a valid credential, you can use +`azure-identity` dependency. For more details on getting started, refer to +the [README](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/monitor/azure-monitor-querymetrics#create-the-client) +of Azure Monitor Query Metrics library. You can also refer to +the [Azure Identity documentation](https://learn.microsoft.com/python/api/overview/azure/identity-readme) +for more details on the various types of credential supported in `azure-identity`. + +For more help on troubleshooting authentication errors please see the Azure Identity client library [troubleshooting guide](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/identity/azure-identity/TROUBLESHOOTING.md). + +### Errors with running async APIs + +The async transport is designed to be opt-in. [AioHttp](https://pypi.org/project/aiohttp/) is one of the supported implementations of async transport. It is not installed by default. You need to install it separately as follows: + +``` +pip install aiohttp +``` + +## Troubleshooting Metrics Query + +### Troubleshooting insufficient access error for metrics query + +If you encounter 401 authorization errors while querying metrics using `MetricsClient`, please ensure you are authorized to read monitoring data at the Azure subscription level. For example, the [Monitoring Reader role](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles/monitor#monitoring-reader) on the subscription to be queried. + +### Troubleshooting unsupported granularity for metrics query + +If you notice the following exception, this is due to an invalid time granularity in the metrics query request. Your +query might have set the `granularity` keyword argument to an unsupported duration. + +```text +"{"code":"BadRequest","message":"Invalid time grain duration: PT10M, supported ones are: 00:01:00,00:05:00,00:15:00,00:30:00,01:00:00,06:00:00,12:00:00,1.00:00:00"}" +``` + +As documented in the error message, the supported granularity for metrics queries are 1 minute, 5 minutes, 15 minutes, +30 minutes, 1 hour, 6 hours, 12 hours and 1 day. + +## Additional azure-core configurations + +When calling the methods, some properties including `retry_mode`, `timeout`, `connection_verify` can be configured by passing in as keyword arguments. See +[configurations](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md#configurations) for list of all such properties. diff --git a/sdk/monitor/azure-monitor-querymetrics/_metadata.json b/sdk/monitor/azure-monitor-querymetrics/_metadata.json new file mode 100644 index 000000000000..4d1a849bcc73 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/_metadata.json @@ -0,0 +1,3 @@ +{ + "apiVersion": "2024-02-01" +} \ No newline at end of file diff --git a/sdk/monitor/azure-monitor-querymetrics/apiview-properties.json b/sdk/monitor/azure-monitor-querymetrics/apiview-properties.json new file mode 100644 index 000000000000..987ad0a16144 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/apiview-properties.json @@ -0,0 +1,19 @@ +{ + "CrossLanguagePackageId": "MonitorQueryMetrics", + "CrossLanguageDefinitionId": { + "azure.monitor.querymetrics._generated.models.ErrorAdditionalInfo": "Azure.ResourceManager.CommonTypes.ErrorAdditionalInfo", + "azure.monitor.querymetrics._generated.models.ErrorDetail": "Azure.ResourceManager.CommonTypes.ErrorDetail", + "azure.monitor.querymetrics._generated.models.ErrorResponse": "Azure.ResourceManager.CommonTypes.ErrorResponse", + "azure.monitor.querymetrics._generated.models.LocalizableString": "MonitorQueryMetrics.LocalizableString", + "azure.monitor.querymetrics._generated.models.MetadataValue": "MonitorQueryMetrics.MetadataValue", + "azure.monitor.querymetrics._generated.models.Metric": "MonitorQueryMetrics.Metric", + "azure.monitor.querymetrics._generated.models.MetricResultsResponse": "MonitorQueryMetrics.MetricResultsResponse", + "azure.monitor.querymetrics._generated.models.MetricResultsResponseValuesItem": "MonitorQueryMetrics.MetricResultsResponseValuesItem", + "azure.monitor.querymetrics._generated.models.MetricValue": "MonitorQueryMetrics.MetricValue", + "azure.monitor.querymetrics._generated.models.ResourceIdList": "MonitorQueryMetrics.ResourceIdList", + "azure.monitor.querymetrics._generated.models.TimeSeriesElement": "MonitorQueryMetrics.TimeSeriesElement", + "azure.monitor.querymetrics._generated.models.MetricUnit": "MonitorQueryMetrics.MetricUnit", + "azure.monitor.querymetrics._generated.MonitorQueryMetricsClient.query_resources": "MonitorQueryMetrics.batch", + "azure.monitor.querymetrics._generated.aio.MonitorQueryMetricsClient.query_resources": "MonitorQueryMetrics.batch" + } +} diff --git a/sdk/monitor/azure-monitor-querymetrics/assets.json b/sdk/monitor/azure-monitor-querymetrics/assets.json new file mode 100644 index 000000000000..158a08a2a003 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/assets.json @@ -0,0 +1,6 @@ +{ + "AssetsRepo": "Azure/azure-sdk-assets", + "AssetsRepoPrefixPath": "python", + "TagPrefix": "python/monitor/azure-monitor-querymetrics", + "Tag": "python/monitor/azure-monitor-querymetrics_de653d2808" +} diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/__init__.py b/sdk/monitor/azure-monitor-querymetrics/azure/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/__init__.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/__init__.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/__init__.py new file mode 100644 index 000000000000..e6fc9cf96a61 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/__init__.py @@ -0,0 +1,22 @@ +# 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. +# -------------------------------------------------------------------------- + +from ._client import MetricsClient +from ._enums import MetricAggregationType +from ._models import MetricsQueryResult, TimeSeriesElement, Metric, MetricValue + +from ._version import VERSION + +__all__ = [ + "MetricsClient", + "MetricsQueryResult", + "TimeSeriesElement", + "Metric", + "MetricValue", + "MetricAggregationType", +] + +__version__ = VERSION diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_client.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_client.py new file mode 100644 index 000000000000..2a8b1fccfb3f --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_client.py @@ -0,0 +1,174 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +from datetime import timedelta, datetime +from json import loads +from typing import Any, List, MutableMapping, Sequence, Optional, Union, Tuple + +import isodate +from azure.core.credentials import TokenCredential +from azure.core.tracing.decorator import distributed_trace + +from ._generated._client import MonitorQueryMetricsClient +from ._models import MetricsQueryResult +from ._enums import MetricAggregationType +from ._utils import get_timespan_iso8601_endpoints, get_subscription_id_from_resource +from ._version import SDK_MONIKER + +JSON = MutableMapping[str, Any] + + +class MetricsClient: # pylint: disable=client-accepts-api-version-keyword + """MetricsClient should be used for performing metrics queries on multiple monitored resources in the + same region. A credential with authorization at the subscription level is required when using this client. + + :param str endpoint: The regional endpoint to use, for example + https://eastus.metrics.monitor.azure.com. The region should match the region of the requested + resources. For global resources, the region should be 'global'. Required. + :param credential: The credential to authenticate the client. + :type credential: ~azure.core.credentials.TokenCredential + :keyword str audience: The audience to use when requesting tokens for Microsoft Entra ID. Defaults to the public + cloud audience (https://metrics.monitor.azure.com). + :keyword api_version: The API version to use for this operation. Default value is "2024-02-01". + Note that overriding this default value may result in unsupported behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: TokenCredential, **kwargs: Any) -> None: + self._endpoint = endpoint + if not self._endpoint.startswith("https://") and not self._endpoint.startswith("http://"): + self._endpoint = "https://" + self._endpoint + audience = kwargs.pop("audience", "https://metrics.monitor.azure.com") + scope = audience.rstrip("/") + "/.default" + credential_scopes = kwargs.pop("credential_scopes", [scope]) + + kwargs.setdefault("sdk_moniker", SDK_MONIKER) + self._client = MonitorQueryMetricsClient( + credential=credential, endpoint=self._endpoint, credential_scopes=credential_scopes, **kwargs + ) + + @distributed_trace + def query_resources( + self, + *, + resource_ids: Sequence[str], + metric_namespace: str, + metric_names: Sequence[str], + timespan: Optional[Union[timedelta, Tuple[datetime, timedelta], Tuple[datetime, datetime]]] = None, + granularity: Optional[timedelta] = None, + aggregations: Optional[Sequence[Union[MetricAggregationType, str]]] = None, + max_results: Optional[int] = None, + order_by: Optional[str] = None, + filter: Optional[str] = None, + roll_up_by: Optional[str] = None, + **kwargs: Any, + ) -> List[MetricsQueryResult]: + """Lists the metric values for multiple resources. + + :keyword resource_ids: A list of resource IDs to query metrics for. Required. + :paramtype resource_ids: list[str] + :keyword metric_namespace: Metric namespace that contains the requested metric names. Required. + :paramtype metric_namespace: str + :keyword metric_names: The names of the metrics to retrieve. Required. + :paramtype metric_names: list[str] + :keyword timespan: The timespan for which to query the data. This can be a timedelta, + a tuple of a start datetime with timedelta, or a tuple with start and end datetimes. + :paramtype timespan: Optional[Union[~datetime.timedelta, tuple[~datetime.datetime, ~datetime.timedelta], + tuple[~datetime.datetime, ~datetime.datetime]]] + :keyword granularity: The granularity (i.e. timegrain) of the query. + :paramtype granularity: Optional[~datetime.timedelta] + :keyword aggregations: The list of aggregation types to retrieve. Use + `azure.monitor.querymetrics.MetricAggregationType` enum to get each aggregation type. + :paramtype aggregations: Optional[list[Union[~azure.monitor.querymetrics.MetricAggregationType, str]]] + :keyword max_results: The maximum number of records to retrieve. + Valid only if 'filter' is specified. Defaults to 10. + :paramtype max_results: Optional[int] + :keyword order_by: The aggregation to use for sorting results and the direction of the sort. + Only one order can be specified. Examples: 'sum asc', 'maximum desc'. + :paramtype order_by: Optional[str] + :keyword filter: The **filter** is used to reduce the set of metric data returned. Default value is None. + + Example: Metric contains metadata A, B and C. + + - Return all time series of C where A = a1 and B = b1 or b2: + + **filter="A eq 'a1' and B eq 'b1' or B eq 'b2' and C eq '*'"** + + - Invalid variant: + + **filter="A eq 'a1' and B eq 'b1' and C eq '*' or B = 'b2'"**. This is invalid because the + logical 'or' operator cannot separate two different metadata names. + + - Return all time series where A = a1, B = b1 and C = c1: + + **filter="A eq 'a1' and B eq 'b1' and C eq 'c1'"** + + - Return all time series where A = a1: + + **filter="A eq 'a1' and B eq '*' and C eq '*'"** + + - Special case: When dimension name or dimension value uses round brackets. Example: When dimension name + is **dim (test) 1**, instead of using **filter="dim (test) 1 eq '*'"** use + **filter="dim %2528test%2529 1 eq '*'"**. + + When dimension name is **dim (test) 3** and dimension value is + **dim3 (test) val**, instead of using **filter="dim (test) 3 eq 'dim3 (test) val'"**, use **filter="dim + %2528test%2529 3 eq 'dim3 %2528test%2529 val'"**. + :paramtype filter: str + :keyword roll_up_by: Dimension name(s) to rollup results by. For example if you only want to see + metric values with a filter like 'City eq Seattle or City eq Tacoma' but don't want to see + separate values for each city, you can specify 'City' to see the results for Seattle + and Tacoma rolled up into one timeseries. + :paramtype roll_up_by: str + :return: A list of MetricsQueryResult objects. + :rtype: list[~azure.monitor.querymetrics.MetricsQueryResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + if not resource_ids: + raise ValueError("'resource_ids' must be provided and must not be empty.") + + # Metric names with commas need to be encoded. + metric_names = [x.replace(",", "%2") for x in metric_names] + + start_time, end_time = get_timespan_iso8601_endpoints(timespan) + resource_id_json: JSON = {"resourceids": list(resource_ids)} + subscription_id = get_subscription_id_from_resource(resource_ids[0]) + interval = isodate.duration_isoformat(granularity) if granularity else None + + generated = self._client.query_resources( + subscription_id=subscription_id, + batch_request=resource_id_json, + metric_namespace=metric_namespace, + metric_names=metric_names, + start_time=start_time, + end_time=end_time, + interval=interval, + aggregation=",".join(aggregations) if aggregations else None, + top=max_results, + order_by=order_by, + filter=filter, + roll_up_by=roll_up_by, # cspell:ignore rollupby + **kwargs, + ) + + # In rare cases, the generated value is a JSON string instead of a dict. This potentially stems from a bug in + # the service. This check handles that case. + if isinstance(generated, str): + generated = loads(generated) + + return [ + MetricsQueryResult._from_generated(value) # pylint: disable=protected-access + for value in generated["values"] + ] + + def close(self) -> None: + return self._client.close() + + def __enter__(self) -> "MetricsClient": + self._client.__enter__() + return self + + def __exit__(self, *args: Any) -> None: + self._client.__exit__(*args) diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_enums.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_enums.py new file mode 100644 index 000000000000..66f1e7e498e5 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_enums.py @@ -0,0 +1,21 @@ +# +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +# cspell:ignore milli +from enum import Enum + +from azure.core import CaseInsensitiveEnumMeta + + +class MetricAggregationType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The aggregation type of the metric.""" + + NONE = "None" + AVERAGE = "Average" + COUNT = "Count" + MINIMUM = "Minimum" + MAXIMUM = "Maximum" + TOTAL = "Total" diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/__init__.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/__init__.py new file mode 100644 index 000000000000..139e30bc2a2f --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/__init__.py @@ -0,0 +1,32 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._client import MonitorQueryMetricsClient # type: ignore +from ._version import VERSION + +__version__ = VERSION + +try: + from ._patch import __all__ as _patch_all + from ._patch import * +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "MonitorQueryMetricsClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore + +_patch_sdk() diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_client.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_client.py new file mode 100644 index 000000000000..8007455655fb --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_client.py @@ -0,0 +1,102 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, TYPE_CHECKING +from typing_extensions import Self + +from azure.core import PipelineClient +from azure.core.pipeline import policies +from azure.core.rest import HttpRequest, HttpResponse + +from ._configuration import MonitorQueryMetricsClientConfiguration +from ._operations._operations import _MonitorQueryMetricsClientOperationsMixin +from ._utils.serialization import Deserializer, Serializer + +if TYPE_CHECKING: + from azure.core.credentials import TokenCredential + + +class MonitorQueryMetricsClient(_MonitorQueryMetricsClientOperationsMixin): + """MonitorQueryMetricsClient. + + :param endpoint: The regional endpoint to use, for example + `https://eastus.metrics.monitor.azure.com `_. The + region should match + the region of the requested resources. For global resources, the region should be 'global'. + Required. + :type endpoint: str + :param credential: Credential used to authenticate requests to the service. Required. + :type credential: ~azure.core.credentials.TokenCredential + :keyword api_version: The API version to use for this operation. Default value is "2024-02-01". + Note that overriding this default value may result in unsupported behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None: + _endpoint = "{endpoint}" + self._config = MonitorQueryMetricsClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + 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: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.HttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + def close(self) -> None: + self._client.close() + + def __enter__(self) -> Self: + self._client.__enter__() + return self + + def __exit__(self, *exc_details: Any) -> None: + self._client.__exit__(*exc_details) diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_configuration.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_configuration.py new file mode 100644 index 000000000000..d16327e4907b --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_configuration.py @@ -0,0 +1,67 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, TYPE_CHECKING + +from azure.core.pipeline import policies + +from ._version import VERSION + +if TYPE_CHECKING: + from azure.core.credentials import TokenCredential + + +class MonitorQueryMetricsClientConfiguration: # pylint: disable=too-many-instance-attributes + """Configuration for MonitorQueryMetricsClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: The regional endpoint to use, for example + `https://eastus.metrics.monitor.azure.com `_. The + region should match + the region of the requested resources. For global resources, the region should be 'global'. + Required. + :type endpoint: str + :param credential: Credential used to authenticate requests to the service. Required. + :type credential: ~azure.core.credentials.TokenCredential + :keyword api_version: The API version to use for this operation. Default value is "2024-02-01". + Note that overriding this default value may result in unsupported behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2024-02-01") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://metrics.monitor.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "monitor-querymetrics/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**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 = policies.BearerTokenCredentialPolicy( + self.credential, *self.credential_scopes, **kwargs + ) diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_operations/__init__.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_operations/__init__.py new file mode 100644 index 000000000000..933fcd7d1b55 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_operations/__init__.py @@ -0,0 +1,22 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + + +from ._patch import __all__ as _patch_all +from ._patch import * +from ._patch import patch_sdk as _patch_sdk + +__all__ = [] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore +_patch_sdk() diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_operations/_operations.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_operations/_operations.py new file mode 100644 index 000000000000..3e82dd5ed234 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_operations/_operations.py @@ -0,0 +1,484 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from collections.abc import MutableMapping +from io import IOBase +import json +from typing import Any, Callable, Dict, IO, List, Optional, TypeVar, Union, overload + +from azure.core import PipelineClient +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + StreamClosedError, + StreamConsumedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.rest import HttpRequest, HttpResponse +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict + +from .. import models as _models +from .._configuration import MonitorQueryMetricsClientConfiguration +from .._utils.model_base import SdkJSONEncoder, _deserialize, _failsafe_deserialize +from .._utils.serialization import Serializer +from .._utils.utils import ClientMixinABC + +JSON = MutableMapping[str, Any] +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] + +_SERIALIZER = Serializer() +_SERIALIZER.client_side_validation = False + + +def build_monitor_query_metrics_query_resources_request( # pylint: disable=name-too-long + subscription_id: str, + *, + metric_namespace: str, + metric_names: List[str], + start_time: Optional[str] = None, + end_time: Optional[str] = None, + interval: Optional[str] = None, + aggregation: Optional[str] = None, + top: Optional[int] = None, + order_by: Optional[str] = None, + filter: Optional[str] = None, + roll_up_by: Optional[str] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-02-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/subscriptions/{subscriptionId}/metrics:getBatch" + path_format_arguments = { + "subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if start_time is not None: + _params["starttime"] = _SERIALIZER.query("start_time", start_time, "str") + if end_time is not None: + _params["endtime"] = _SERIALIZER.query("end_time", end_time, "str") + if interval is not None: + _params["interval"] = _SERIALIZER.query("interval", interval, "str") + _params["metricnamespace"] = _SERIALIZER.query("metric_namespace", metric_namespace, "str") + _params["metricnames"] = _SERIALIZER.query("metric_names", metric_names, "[str]", div=",") + if aggregation is not None: + _params["aggregation"] = _SERIALIZER.query("aggregation", aggregation, "str") + if top is not None: + _params["top"] = _SERIALIZER.query("top", top, "int") + if order_by is not None: + _params["orderby"] = _SERIALIZER.query("order_by", order_by, "str") + if filter is not None: + _params["filter"] = _SERIALIZER.query("filter", filter, "str") + if roll_up_by is not None: + _params["rollupby"] = _SERIALIZER.query("roll_up_by", roll_up_by, "str") + + # Construct headers + if content_type is not None: + _headers["content-type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +class _MonitorQueryMetricsClientOperationsMixin( + ClientMixinABC[PipelineClient[HttpRequest, HttpResponse], MonitorQueryMetricsClientConfiguration] +): + + @overload + def query_resources( + self, + subscription_id: str, + batch_request: _models.ResourceIdList, + *, + metric_namespace: str, + metric_names: List[str], + start_time: Optional[str] = None, + end_time: Optional[str] = None, + interval: Optional[str] = None, + aggregation: Optional[str] = None, + top: Optional[int] = None, + order_by: Optional[str] = None, + filter: Optional[str] = None, + roll_up_by: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.MetricResultsResponse: + """Lists the metric values for multiple resources. + + :param subscription_id: The subscription identifier for the resources in this batch. Required. + :type subscription_id: str + :param batch_request: Metrics batch body including the list of resource ids. Required. + :type batch_request: ~azure.monitor.querymetrics._generated.models.ResourceIdList + :keyword metric_namespace: Metric namespace that contains the requested metric names. Required. + :paramtype metric_namespace: str + :keyword metric_names: The names of the metrics (comma separated) to retrieve. Required. + :paramtype metric_names: list[str] + :keyword start_time: The start time of the query. It is a string in the format + 'yyyy-MM-ddTHH:mm:ss.fffZ'. If you have specified the endtime parameter, then + this parameter is required. + If only starttime is specified, then endtime defaults to the current time. + If no time interval is specified, the default is 1 hour. Default value is None. + :paramtype start_time: str + :keyword end_time: The end time of the query. It is a string in the format + 'yyyy-MM-ddTHH:mm:ss.fffZ'. Default value is None. + :paramtype end_time: str + :keyword interval: The interval (i.e. timegrain) of the query in ISO 8601 duration format. + Defaults to PT1M. Special case for 'FULL' value that returns single datapoint + for entire time span requested. + *Examples: PT15M, PT1H, P1D, FULL*. Default value is None. + :paramtype interval: str + :keyword aggregation: The list of aggregation types (comma separated) to retrieve. *Examples: + average, minimum, maximum*. Default value is None. + :paramtype aggregation: str + :keyword top: The maximum number of records to retrieve per resource ID in the request. + Valid only if filter is specified. + Defaults to 10. Default value is None. + :paramtype top: int + :keyword order_by: The aggregation to use for sorting results and the direction of the sort. + Only one order can be specified. + *Examples: sum asc*. Default value is None. + :paramtype order_by: str + :keyword filter: The filter is used to reduce the set of metric data + returned.
Example:
Metric contains metadata A, B and C.
- Return all + time series of C where A = a1 and B = b1 or b2
**filter=A eq ‘a1’ and B eq + ‘b1’ or B eq ‘b2’ and C eq ‘*’**
- Invalid variant:
**filter=A eq ‘a1’ + and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’**
This is invalid because the logical + or operator cannot separate two different metadata names.
- Return all time + series where A = a1, B = b1 and C = c1:
**filter=A eq ‘a1’ and B eq ‘b1’ and + C eq ‘c1’**
- Return all time series where A = a1
**filter=A eq ‘a1’ and + B eq ‘*’ and C eq ‘*’**. Default value is None. + :paramtype filter: str + :keyword roll_up_by: Dimension name(s) to rollup results by. For example if you only want to + see + metric values with a filter like 'City eq Seattle or City eq Tacoma' but don't + want to see separate values for each city, you can specify 'RollUpBy=City' to + see the results for Seattle and Tacoma rolled up into one timeseries. Default value is None. + :paramtype roll_up_by: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: MetricResultsResponse. The MetricResultsResponse is compatible with MutableMapping + :rtype: ~azure.monitor.querymetrics._generated.models.MetricResultsResponse + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def query_resources( + self, + subscription_id: str, + batch_request: JSON, + *, + metric_namespace: str, + metric_names: List[str], + start_time: Optional[str] = None, + end_time: Optional[str] = None, + interval: Optional[str] = None, + aggregation: Optional[str] = None, + top: Optional[int] = None, + order_by: Optional[str] = None, + filter: Optional[str] = None, + roll_up_by: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.MetricResultsResponse: + """Lists the metric values for multiple resources. + + :param subscription_id: The subscription identifier for the resources in this batch. Required. + :type subscription_id: str + :param batch_request: Metrics batch body including the list of resource ids. Required. + :type batch_request: JSON + :keyword metric_namespace: Metric namespace that contains the requested metric names. Required. + :paramtype metric_namespace: str + :keyword metric_names: The names of the metrics (comma separated) to retrieve. Required. + :paramtype metric_names: list[str] + :keyword start_time: The start time of the query. It is a string in the format + 'yyyy-MM-ddTHH:mm:ss.fffZ'. If you have specified the endtime parameter, then + this parameter is required. + If only starttime is specified, then endtime defaults to the current time. + If no time interval is specified, the default is 1 hour. Default value is None. + :paramtype start_time: str + :keyword end_time: The end time of the query. It is a string in the format + 'yyyy-MM-ddTHH:mm:ss.fffZ'. Default value is None. + :paramtype end_time: str + :keyword interval: The interval (i.e. timegrain) of the query in ISO 8601 duration format. + Defaults to PT1M. Special case for 'FULL' value that returns single datapoint + for entire time span requested. + *Examples: PT15M, PT1H, P1D, FULL*. Default value is None. + :paramtype interval: str + :keyword aggregation: The list of aggregation types (comma separated) to retrieve. *Examples: + average, minimum, maximum*. Default value is None. + :paramtype aggregation: str + :keyword top: The maximum number of records to retrieve per resource ID in the request. + Valid only if filter is specified. + Defaults to 10. Default value is None. + :paramtype top: int + :keyword order_by: The aggregation to use for sorting results and the direction of the sort. + Only one order can be specified. + *Examples: sum asc*. Default value is None. + :paramtype order_by: str + :keyword filter: The filter is used to reduce the set of metric data + returned.
Example:
Metric contains metadata A, B and C.
- Return all + time series of C where A = a1 and B = b1 or b2
**filter=A eq ‘a1’ and B eq + ‘b1’ or B eq ‘b2’ and C eq ‘*’**
- Invalid variant:
**filter=A eq ‘a1’ + and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’**
This is invalid because the logical + or operator cannot separate two different metadata names.
- Return all time + series where A = a1, B = b1 and C = c1:
**filter=A eq ‘a1’ and B eq ‘b1’ and + C eq ‘c1’**
- Return all time series where A = a1
**filter=A eq ‘a1’ and + B eq ‘*’ and C eq ‘*’**. Default value is None. + :paramtype filter: str + :keyword roll_up_by: Dimension name(s) to rollup results by. For example if you only want to + see + metric values with a filter like 'City eq Seattle or City eq Tacoma' but don't + want to see separate values for each city, you can specify 'RollUpBy=City' to + see the results for Seattle and Tacoma rolled up into one timeseries. Default value is None. + :paramtype roll_up_by: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: MetricResultsResponse. The MetricResultsResponse is compatible with MutableMapping + :rtype: ~azure.monitor.querymetrics._generated.models.MetricResultsResponse + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def query_resources( + self, + subscription_id: str, + batch_request: IO[bytes], + *, + metric_namespace: str, + metric_names: List[str], + start_time: Optional[str] = None, + end_time: Optional[str] = None, + interval: Optional[str] = None, + aggregation: Optional[str] = None, + top: Optional[int] = None, + order_by: Optional[str] = None, + filter: Optional[str] = None, + roll_up_by: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.MetricResultsResponse: + """Lists the metric values for multiple resources. + + :param subscription_id: The subscription identifier for the resources in this batch. Required. + :type subscription_id: str + :param batch_request: Metrics batch body including the list of resource ids. Required. + :type batch_request: IO[bytes] + :keyword metric_namespace: Metric namespace that contains the requested metric names. Required. + :paramtype metric_namespace: str + :keyword metric_names: The names of the metrics (comma separated) to retrieve. Required. + :paramtype metric_names: list[str] + :keyword start_time: The start time of the query. It is a string in the format + 'yyyy-MM-ddTHH:mm:ss.fffZ'. If you have specified the endtime parameter, then + this parameter is required. + If only starttime is specified, then endtime defaults to the current time. + If no time interval is specified, the default is 1 hour. Default value is None. + :paramtype start_time: str + :keyword end_time: The end time of the query. It is a string in the format + 'yyyy-MM-ddTHH:mm:ss.fffZ'. Default value is None. + :paramtype end_time: str + :keyword interval: The interval (i.e. timegrain) of the query in ISO 8601 duration format. + Defaults to PT1M. Special case for 'FULL' value that returns single datapoint + for entire time span requested. + *Examples: PT15M, PT1H, P1D, FULL*. Default value is None. + :paramtype interval: str + :keyword aggregation: The list of aggregation types (comma separated) to retrieve. *Examples: + average, minimum, maximum*. Default value is None. + :paramtype aggregation: str + :keyword top: The maximum number of records to retrieve per resource ID in the request. + Valid only if filter is specified. + Defaults to 10. Default value is None. + :paramtype top: int + :keyword order_by: The aggregation to use for sorting results and the direction of the sort. + Only one order can be specified. + *Examples: sum asc*. Default value is None. + :paramtype order_by: str + :keyword filter: The filter is used to reduce the set of metric data + returned.
Example:
Metric contains metadata A, B and C.
- Return all + time series of C where A = a1 and B = b1 or b2
**filter=A eq ‘a1’ and B eq + ‘b1’ or B eq ‘b2’ and C eq ‘*’**
- Invalid variant:
**filter=A eq ‘a1’ + and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’**
This is invalid because the logical + or operator cannot separate two different metadata names.
- Return all time + series where A = a1, B = b1 and C = c1:
**filter=A eq ‘a1’ and B eq ‘b1’ and + C eq ‘c1’**
- Return all time series where A = a1
**filter=A eq ‘a1’ and + B eq ‘*’ and C eq ‘*’**. Default value is None. + :paramtype filter: str + :keyword roll_up_by: Dimension name(s) to rollup results by. For example if you only want to + see + metric values with a filter like 'City eq Seattle or City eq Tacoma' but don't + want to see separate values for each city, you can specify 'RollUpBy=City' to + see the results for Seattle and Tacoma rolled up into one timeseries. Default value is None. + :paramtype roll_up_by: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: MetricResultsResponse. The MetricResultsResponse is compatible with MutableMapping + :rtype: ~azure.monitor.querymetrics._generated.models.MetricResultsResponse + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def query_resources( + self, + subscription_id: str, + batch_request: Union[_models.ResourceIdList, JSON, IO[bytes]], + *, + metric_namespace: str, + metric_names: List[str], + start_time: Optional[str] = None, + end_time: Optional[str] = None, + interval: Optional[str] = None, + aggregation: Optional[str] = None, + top: Optional[int] = None, + order_by: Optional[str] = None, + filter: Optional[str] = None, + roll_up_by: Optional[str] = None, + **kwargs: Any + ) -> _models.MetricResultsResponse: + """Lists the metric values for multiple resources. + + :param subscription_id: The subscription identifier for the resources in this batch. Required. + :type subscription_id: str + :param batch_request: Metrics batch body including the list of resource ids. Is one of the + following types: ResourceIdList, JSON, IO[bytes] Required. + :type batch_request: ~azure.monitor.querymetrics._generated.models.ResourceIdList or JSON or + IO[bytes] + :keyword metric_namespace: Metric namespace that contains the requested metric names. Required. + :paramtype metric_namespace: str + :keyword metric_names: The names of the metrics (comma separated) to retrieve. Required. + :paramtype metric_names: list[str] + :keyword start_time: The start time of the query. It is a string in the format + 'yyyy-MM-ddTHH:mm:ss.fffZ'. If you have specified the endtime parameter, then + this parameter is required. + If only starttime is specified, then endtime defaults to the current time. + If no time interval is specified, the default is 1 hour. Default value is None. + :paramtype start_time: str + :keyword end_time: The end time of the query. It is a string in the format + 'yyyy-MM-ddTHH:mm:ss.fffZ'. Default value is None. + :paramtype end_time: str + :keyword interval: The interval (i.e. timegrain) of the query in ISO 8601 duration format. + Defaults to PT1M. Special case for 'FULL' value that returns single datapoint + for entire time span requested. + *Examples: PT15M, PT1H, P1D, FULL*. Default value is None. + :paramtype interval: str + :keyword aggregation: The list of aggregation types (comma separated) to retrieve. *Examples: + average, minimum, maximum*. Default value is None. + :paramtype aggregation: str + :keyword top: The maximum number of records to retrieve per resource ID in the request. + Valid only if filter is specified. + Defaults to 10. Default value is None. + :paramtype top: int + :keyword order_by: The aggregation to use for sorting results and the direction of the sort. + Only one order can be specified. + *Examples: sum asc*. Default value is None. + :paramtype order_by: str + :keyword filter: The filter is used to reduce the set of metric data + returned.
Example:
Metric contains metadata A, B and C.
- Return all + time series of C where A = a1 and B = b1 or b2
**filter=A eq ‘a1’ and B eq + ‘b1’ or B eq ‘b2’ and C eq ‘*’**
- Invalid variant:
**filter=A eq ‘a1’ + and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’**
This is invalid because the logical + or operator cannot separate two different metadata names.
- Return all time + series where A = a1, B = b1 and C = c1:
**filter=A eq ‘a1’ and B eq ‘b1’ and + C eq ‘c1’**
- Return all time series where A = a1
**filter=A eq ‘a1’ and + B eq ‘*’ and C eq ‘*’**. Default value is None. + :paramtype filter: str + :keyword roll_up_by: Dimension name(s) to rollup results by. For example if you only want to + see + metric values with a filter like 'City eq Seattle or City eq Tacoma' but don't + want to see separate values for each city, you can specify 'RollUpBy=City' to + see the results for Seattle and Tacoma rolled up into one timeseries. Default value is None. + :paramtype roll_up_by: str + :return: MetricResultsResponse. The MetricResultsResponse is compatible with MutableMapping + :rtype: ~azure.monitor.querymetrics._generated.models.MetricResultsResponse + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + cls: ClsType[_models.MetricResultsResponse] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(batch_request, (IOBase, bytes)): + _content = batch_request + else: + _content = json.dumps(batch_request, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_monitor_query_metrics_query_resources_request( + subscription_id=subscription_id, + metric_namespace=metric_namespace, + metric_names=metric_names, + start_time=start_time, + end_time=end_time, + interval=interval, + aggregation=aggregation, + top=top, + order_by=order_by, + filter=filter, + roll_up_by=roll_up_by, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _failsafe_deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.MetricResultsResponse, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_operations/_patch.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_operations/_patch.py new file mode 100644 index 000000000000..8bcb627aa475 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_operations/_patch.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_patch.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_patch.py new file mode 100644 index 000000000000..8bcb627aa475 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_patch.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_utils/__init__.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_utils/__init__.py new file mode 100644 index 000000000000..8026245c2abc --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_utils/__init__.py @@ -0,0 +1,6 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_utils/model_base.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_utils/model_base.py new file mode 100644 index 000000000000..49d5c7259389 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_utils/model_base.py @@ -0,0 +1,1232 @@ +# pylint: disable=too-many-lines +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=protected-access, broad-except + +import copy +import calendar +import decimal +import functools +import sys +import logging +import base64 +import re +import typing +import enum +import email.utils +from datetime import datetime, date, time, timedelta, timezone +from json import JSONEncoder +import xml.etree.ElementTree as ET +from collections.abc import MutableMapping +from typing_extensions import Self +import isodate +from azure.core.exceptions import DeserializationError +from azure.core import CaseInsensitiveEnumMeta +from azure.core.pipeline import PipelineResponse +from azure.core.serialization import _Null + +_LOGGER = logging.getLogger(__name__) + +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] + +TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") + + +def _timedelta_as_isostr(td: timedelta) -> str: + """Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S' + + Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython + + :param timedelta td: The timedelta to convert + :rtype: str + :return: ISO8601 version of this timedelta + """ + + # Split seconds to larger units + seconds = td.total_seconds() + minutes, seconds = divmod(seconds, 60) + hours, minutes = divmod(minutes, 60) + days, hours = divmod(hours, 24) + + days, hours, minutes = list(map(int, (days, hours, minutes))) + seconds = round(seconds, 6) + + # Build date + date_str = "" + if days: + date_str = "%sD" % days + + if hours or minutes or seconds: + # Build time + time_str = "T" + + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) + + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) + + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) + + time_str += "{}S".format(seconds_string) + else: + time_str = "" + + return "P" + date_str + time_str + + +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded + + +def _serialize_datetime(o, format: typing.Optional[str] = None): + if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) + if not o.tzinfo: + iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() + else: + iso_formatted = o.astimezone(TZ_UTC).isoformat() + # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) + return iso_formatted.replace("+00:00", "Z") + # Next try datetime.date or datetime.time + return o.isoformat() + + +def _is_readonly(p): + try: + return p._visibility == ["read"] + except AttributeError: + return False + + +class SdkJSONEncoder(JSONEncoder): + """A JSON encoder that's capable of serializing datetime objects and bytes.""" + + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + + def default(self, o): # pylint: disable=too-many-return-statements + if _is_model(o): + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) + try: + return super(SdkJSONEncoder, self).default(o) + except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, self.format) + try: + # First try datetime.datetime + return _serialize_datetime(o, self.format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return super(SdkJSONEncoder, self).default(o) + + +_VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) + + +def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + attr = attr.upper() + match = _VALID_DATE.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + return date_obj + + +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + +def _deserialize_date(attr: typing.Union[str, date]) -> date: + """Deserialize ISO-8601 formatted string into Date object. + :param str attr: response string to be deserialized. + :rtype: date + :returns: The date object from that input + """ + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + if isinstance(attr, date): + return attr + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore + + +def _deserialize_time(attr: typing.Union[str, time]) -> time: + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :returns: The time object from that input + """ + if isinstance(attr, time): + return attr + return isodate.parse_time(attr) + + +def _deserialize_bytes(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + return bytes(base64.b64decode(attr)) + + +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): + if isinstance(attr, timedelta): + return attr + return isodate.parse_duration(attr) + + +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + +def _deserialize_int_as_str(attr): + if isinstance(attr, int): + return attr + return int(attr) + + +_DESERIALIZE_MAPPING = { + datetime: _deserialize_datetime, + date: _deserialize_date, + time: _deserialize_time, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, + typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, +} + +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if annotation is int and rf and rf._format == "str": + return _deserialize_int_as_str + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) # pyright: ignore + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + + +def _get_model(module_name: str, model_name: str): + models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} + module_end = module_name.rsplit(".", 1)[0] + models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) + if isinstance(model_name, str): + model_name = model_name.split(".")[-1] + if model_name not in models: + return model_name + return models[model_name] + + +_UNSET = object() + + +class _MyMutableMapping(MutableMapping[str, typing.Any]): + def __init__(self, data: typing.Dict[str, typing.Any]) -> None: + self._data = data + + def __contains__(self, key: typing.Any) -> bool: + return key in self._data + + def __getitem__(self, key: str) -> typing.Any: + return self._data.__getitem__(key) + + def __setitem__(self, key: str, value: typing.Any) -> None: + self._data.__setitem__(key, value) + + def __delitem__(self, key: str) -> None: + self._data.__delitem__(key) + + def __iter__(self) -> typing.Iterator[typing.Any]: + return self._data.__iter__() + + def __len__(self) -> int: + return self._data.__len__() + + def __ne__(self, other: typing.Any) -> bool: + return not self.__eq__(other) + + def keys(self) -> typing.KeysView[str]: + """ + :returns: a set-like object providing a view on D's keys + :rtype: ~typing.KeysView + """ + return self._data.keys() + + def values(self) -> typing.ValuesView[typing.Any]: + """ + :returns: an object providing a view on D's values + :rtype: ~typing.ValuesView + """ + return self._data.values() + + def items(self) -> typing.ItemsView[str, typing.Any]: + """ + :returns: set-like object providing a view on D's items + :rtype: ~typing.ItemsView + """ + return self._data.items() + + def get(self, key: str, default: typing.Any = None) -> typing.Any: + """ + Get the value for key if key is in the dictionary, else default. + :param str key: The key to look up. + :param any default: The value to return if key is not in the dictionary. Defaults to None + :returns: D[k] if k in D, else d. + :rtype: any + """ + try: + return self[key] + except KeyError: + return default + + @typing.overload + def pop(self, key: str) -> typing.Any: ... # pylint: disable=arguments-differ + + @typing.overload + def pop(self, key: str, default: _T) -> _T: ... # pylint: disable=signature-differs + + @typing.overload + def pop(self, key: str, default: typing.Any) -> typing.Any: ... # pylint: disable=signature-differs + + def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + """ + Removes specified key and return the corresponding value. + :param str key: The key to pop. + :param any default: The value to return if key is not in the dictionary + :returns: The value corresponding to the key. + :rtype: any + :raises KeyError: If key is not found and default is not given. + """ + if default is _UNSET: + return self._data.pop(key) + return self._data.pop(key, default) + + def popitem(self) -> typing.Tuple[str, typing.Any]: + """ + Removes and returns some (key, value) pair + :returns: The (key, value) pair. + :rtype: tuple + :raises KeyError: if D is empty. + """ + return self._data.popitem() + + def clear(self) -> None: + """ + Remove all items from D. + """ + self._data.clear() + + def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: # pylint: disable=arguments-differ + """ + Updates D from mapping/iterable E and F. + :param any args: Either a mapping object or an iterable of key-value pairs. + """ + self._data.update(*args, **kwargs) + + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: ... + + @typing.overload + def setdefault(self, key: str, default: typing.Any) -> typing.Any: ... # pylint: disable=signature-differs + + def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + """ + Same as calling D.get(k, d), and setting D[k]=d if k not found + :param str key: The key to look up. + :param any default: The value to set if key is not in the dictionary + :returns: D[k] if k in D, else d. + :rtype: any + """ + if default is _UNSET: + return self._data.setdefault(key) + return self._data.setdefault(key, default) + + def __eq__(self, other: typing.Any) -> bool: + try: + other_model = self.__class__(other) + except Exception: + return False + return self._data == other_model._data + + def __repr__(self) -> str: + return str(self._data) + + +def _is_model(obj: typing.Any) -> bool: + return getattr(obj, "_is_model", False) + + +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, enum.Enum): + return o.value + if isinstance(o, int): + if format == "str": + return str(o) + return o + try: + # First try datetime.datetime + return _serialize_datetime(o, format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return o + + +def _get_rest_field( + attr_to_rest_field: typing.Dict[str, "_RestField"], rest_name: str +) -> typing.Optional["_RestField"]: + try: + return next(rf for rf in attr_to_rest_field.values() if rf._rest_name == rest_name) + except StopIteration: + return None + + +def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: + if not rf: + return _serialize(value, None) + if rf._is_multipart_file_input: + return value + if rf._is_model: + return _deserialize(rf._type, value) + if isinstance(value, ET.Element): + value = _deserialize(rf._type, value) + return _serialize(value, rf._format) + + +class Model(_MyMutableMapping): + _is_model = True + # label whether current class's _attr_to_rest_field has been calculated + # could not see _attr_to_rest_field directly because subclass inherits it from parent class + _calculated: typing.Set[str] = set() + + def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: + class_name = self.__class__.__name__ + if len(args) > 1: + raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given") + dict_to_pass = { + rest_field._rest_name: rest_field._default + for rest_field in self._attr_to_rest_field.values() + if rest_field._default is not _UNSET + } + if args: # pylint: disable=too-many-nested-blocks + if isinstance(args[0], ET.Element): + existed_attr_keys = [] + model_meta = getattr(self, "_xml", {}) + + for rf in self._attr_to_rest_field.values(): + prop_meta = getattr(rf, "_xml", {}) + xml_name = prop_meta.get("name", rf._rest_name) + xml_ns = prop_meta.get("ns", model_meta.get("ns", None)) + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + + # attribute + if prop_meta.get("attribute", False) and args[0].get(xml_name) is not None: + existed_attr_keys.append(xml_name) + dict_to_pass[rf._rest_name] = _deserialize(rf._type, args[0].get(xml_name)) + continue + + # unwrapped element is array + if prop_meta.get("unwrapped", False): + # unwrapped array could either use prop items meta/prop meta + if prop_meta.get("itemsName"): + xml_name = prop_meta.get("itemsName") + xml_ns = prop_meta.get("itemNs") + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + items = args[0].findall(xml_name) # pyright: ignore + if len(items) > 0: + existed_attr_keys.append(xml_name) + dict_to_pass[rf._rest_name] = _deserialize(rf._type, items) + continue + + # text element is primitive type + if prop_meta.get("text", False): + if args[0].text is not None: + dict_to_pass[rf._rest_name] = _deserialize(rf._type, args[0].text) + continue + + # wrapped element could be normal property or array, it should only have one element + item = args[0].find(xml_name) + if item is not None: + existed_attr_keys.append(xml_name) + dict_to_pass[rf._rest_name] = _deserialize(rf._type, item) + + # rest thing is additional properties + for e in args[0]: + if e.tag not in existed_attr_keys: + dict_to_pass[e.tag] = _convert_element(e) + else: + dict_to_pass.update( + {k: _create_value(_get_rest_field(self._attr_to_rest_field, k), v) for k, v in args[0].items()} + ) + else: + non_attr_kwargs = [k for k in kwargs if k not in self._attr_to_rest_field] + if non_attr_kwargs: + # actual type errors only throw the first wrong keyword arg they see, so following that. + raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) + super().__init__(dict_to_pass) + + def copy(self) -> "Model": + return Model(self.__dict__) + + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: + if f"{cls.__module__}.{cls.__qualname__}" not in cls._calculated: + # we know the last nine classes in mro are going to be 'Model', '_MyMutableMapping', 'MutableMapping', + # 'Mapping', 'Collection', 'Sized', 'Iterable', 'Container' and 'object' + mros = cls.__mro__[:-9][::-1] # ignore parents, and reverse the mro order + attr_to_rest_field: typing.Dict[str, _RestField] = { # map attribute name to rest_field property + k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type") + } + annotations = { + k: v + for mro_class in mros + if hasattr(mro_class, "__annotations__") + for k, v in mro_class.__annotations__.items() + } + for attr, rf in attr_to_rest_field.items(): + rf._module = cls.__module__ + if not rf._type: + rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None)) + if not rf._rest_name_input: + rf._rest_name_input = attr + cls._attr_to_rest_field: typing.Dict[str, _RestField] = dict(attr_to_rest_field.items()) + cls._calculated.add(f"{cls.__module__}.{cls.__qualname__}") + + return super().__new__(cls) + + def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: + for base in cls.__bases__: + if hasattr(base, "__mapping__"): + base.__mapping__[discriminator or cls.__name__] = cls # type: ignore + + @classmethod + def _get_discriminator(cls, exist_discriminators) -> typing.Optional["_RestField"]: + for v in cls.__dict__.values(): + if isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators: + return v + return None + + @classmethod + def _deserialize(cls, data, exist_discriminators): + if not hasattr(cls, "__mapping__"): + return cls(data) + discriminator = cls._get_discriminator(exist_discriminators) + if discriminator is None: + return cls(data) + exist_discriminators.append(discriminator._rest_name) + if isinstance(data, ET.Element): + model_meta = getattr(cls, "_xml", {}) + prop_meta = getattr(discriminator, "_xml", {}) + xml_name = prop_meta.get("name", discriminator._rest_name) + xml_ns = prop_meta.get("ns", model_meta.get("ns", None)) + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + + if data.get(xml_name) is not None: + discriminator_value = data.get(xml_name) + else: + discriminator_value = data.find(xml_name).text # pyright: ignore + else: + discriminator_value = data.get(discriminator._rest_name) + mapped_cls = cls.__mapping__.get(discriminator_value, cls) # pyright: ignore # pylint: disable=no-member + return mapped_cls._deserialize(data, exist_discriminators) + + def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]: + """Return a dict that can be turned into json using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + readonly_props = [] + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore + continue + is_multipart_file_input = False + try: + is_multipart_file_input = next( + rf for rf in self._attr_to_rest_field.values() if rf._rest_name == k + )._is_multipart_file_input + except StopIteration: + pass + result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return type(v)(Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v) + if isinstance(v, dict): + return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v + + +def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + +def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): + if obj is None: + return obj + return _deserialize_with_callable(if_obj_deserializer, obj) + + +def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + +def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj: typing.Dict[typing.Any, typing.Any], +): + if obj is None: + return obj + if isinstance(obj, ET.Element): + obj = {child.tag: child for child in obj} + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} + + +def _deserialize_multiple_sequence( + entry_deserializers: typing.List[typing.Optional[typing.Callable]], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry, deserializer in zip(obj, entry_deserializers)) + + +def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + if isinstance(obj, ET.Element): + obj = list(obj) + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + +def _sorted_annotations(types: typing.List[typing.Any]) -> typing.List[typing.Any]: + return sorted( + types, + key=lambda x: hasattr(x, "__name__") and x.__name__.lower() in ("str", "float", "int", "bool"), + ) + + +def _get_deserialize_callable_from_annotation( # pylint: disable=too-many-return-statements, too-many-branches + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, +) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + if not annotation: + return None + + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) # type: ignore + + try: + if module and _is_model(annotation): + if rf: + rf._is_model = True + + return functools.partial(_deserialize_model, annotation) # pyright: ignore + except Exception: + pass + + # is it a literal? + try: + if annotation.__origin__ is typing.Literal: # pyright: ignore + return None + except AttributeError: + pass + + # is it optional? + try: + if any(a for a in annotation.__args__ if a == type(None)): # pyright: ignore + if len(annotation.__args__) <= 2: # pyright: ignore + if_obj_deserializer = _get_deserialize_callable_from_annotation( + next(a for a in annotation.__args__ if a != type(None)), module, rf # pyright: ignore + ) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + # the type is Optional[Union[...]], we need to remove the None type from the Union + annotation_copy = copy.copy(annotation) + annotation_copy.__args__ = [a for a in annotation_copy.__args__ if a != type(None)] # pyright: ignore + return _get_deserialize_callable_from_annotation(annotation_copy, module, rf) + except AttributeError: + pass + + # is it union? + if getattr(annotation, "__origin__", None) is typing.Union: + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in _sorted_annotations(annotation.__args__) # pyright: ignore + ] + + return functools.partial(_deserialize_with_union, deserializers) + + try: + if annotation._name == "Dict": # pyright: ignore + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) + + return functools.partial( + _deserialize_dict, + value_deserializer, + module, + ) + except (AttributeError, IndexError): + pass + try: + if annotation._name in ["List", "Set", "Tuple", "Sequence"]: # pyright: ignore + if len(annotation.__args__) > 1: # pyright: ignore + entry_deserializers = [ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore + ] + return functools.partial(_deserialize_multiple_sequence, entry_deserializers, module) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) + + return functools.partial(_deserialize_sequence, deserializer, module) + except (TypeError, IndexError, AttributeError, SyntaxError): + pass + + def _deserialize_default( + deserializer, + obj, + ): + if obj is None: + return obj + try: + return _deserialize_with_callable(deserializer, obj) + except Exception: + pass + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) + + return functools.partial(_deserialize_default, annotation) + + +def _deserialize_with_callable( + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, +): # pylint: disable=too-many-return-statements + try: + if value is None or isinstance(value, _Null): + return None + if isinstance(value, ET.Element): + if deserializer is str: + return value.text or "" + if deserializer is int: + return int(value.text) if value.text else None + if deserializer is float: + return float(value.text) if value.text else None + if deserializer is bool: + return value.text == "true" if value.text else None + if deserializer is None: + return value + if deserializer in [int, float, bool]: + return deserializer(value) + if isinstance(deserializer, CaseInsensitiveEnumMeta): + try: + return deserializer(value) + except ValueError: + # for unknown value, return raw value + return value + if isinstance(deserializer, type) and issubclass(deserializer, Model): + return deserializer._deserialize(value, []) + return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) + except Exception as e: + raise DeserializationError() from e + + +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + if isinstance(value, PipelineResponse): + value = value.http_response.json() + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) + return _deserialize_with_callable(deserializer, value) + + +def _failsafe_deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + try: + return _deserialize(deserializer, value, module, rf, format) + except DeserializationError: + _LOGGER.warning( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + +def _failsafe_deserialize_xml( + deserializer: typing.Any, + value: typing.Any, +) -> typing.Any: + try: + return _deserialize_xml(deserializer, value) + except DeserializationError: + _LOGGER.warning( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + +class _RestField: + def __init__( + self, + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + is_discriminator: bool = False, + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + xml: typing.Optional[typing.Dict[str, typing.Any]] = None, + ): + self._type = type + self._rest_name_input = name + self._module: typing.Optional[str] = None + self._is_discriminator = is_discriminator + self._visibility = visibility + self._is_model = False + self._default = default + self._format = format + self._is_multipart_file_input = is_multipart_file_input + self._xml = xml if xml is not None else {} + + @property + def _class_type(self) -> typing.Any: + return getattr(self._type, "args", [None])[0] + + @property + def _rest_name(self) -> str: + if self._rest_name_input is None: + raise ValueError("Rest name was never set") + return self._rest_name_input + + def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin + # by this point, type and rest_name will have a value bc we default + # them in __new__ of the Model class + item = obj.get(self._rest_name) + if item is None: + return item + if self._is_model: + return item + return _deserialize(self._type, _serialize(item, self._format), rf=self) + + def __set__(self, obj: Model, value) -> None: + if value is None: + # we want to wipe out entries if users set attr to None + try: + obj.__delitem__(self._rest_name) + except KeyError: + pass + return + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) + + def _get_deserialize_callable_from_annotation( + self, annotation: typing.Any + ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + return _get_deserialize_callable_from_annotation(annotation, self._module, self) + + +def rest_field( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + xml: typing.Optional[typing.Dict[str, typing.Any]] = None, +) -> typing.Any: + return _RestField( + name=name, + type=type, + visibility=visibility, + default=default, + format=format, + is_multipart_file_input=is_multipart_file_input, + xml=xml, + ) + + +def rest_discriminator( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[typing.List[str]] = None, + xml: typing.Optional[typing.Dict[str, typing.Any]] = None, +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True, visibility=visibility, xml=xml) + + +def serialize_xml(model: Model, exclude_readonly: bool = False) -> str: + """Serialize a model to XML. + + :param Model model: The model to serialize. + :param bool exclude_readonly: Whether to exclude readonly properties. + :returns: The XML representation of the model. + :rtype: str + """ + return ET.tostring(_get_element(model, exclude_readonly), encoding="unicode") # type: ignore + + +def _get_element( + o: typing.Any, + exclude_readonly: bool = False, + parent_meta: typing.Optional[typing.Dict[str, typing.Any]] = None, + wrapped_element: typing.Optional[ET.Element] = None, +) -> typing.Union[ET.Element, typing.List[ET.Element]]: + if _is_model(o): + model_meta = getattr(o, "_xml", {}) + + # if prop is a model, then use the prop element directly, else generate a wrapper of model + if wrapped_element is None: + wrapped_element = _create_xml_element( + model_meta.get("name", o.__class__.__name__), + model_meta.get("prefix"), + model_meta.get("ns"), + ) + + readonly_props = [] + if exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + + for k, v in o.items(): + # do not serialize readonly properties + if exclude_readonly and k in readonly_props: + continue + + prop_rest_field = _get_rest_field(o._attr_to_rest_field, k) + if prop_rest_field: + prop_meta = getattr(prop_rest_field, "_xml").copy() + # use the wire name as xml name if no specific name is set + if prop_meta.get("name") is None: + prop_meta["name"] = k + else: + # additional properties will not have rest field, use the wire name as xml name + prop_meta = {"name": k} + + # if no ns for prop, use model's + if prop_meta.get("ns") is None and model_meta.get("ns"): + prop_meta["ns"] = model_meta.get("ns") + prop_meta["prefix"] = model_meta.get("prefix") + + if prop_meta.get("unwrapped", False): + # unwrapped could only set on array + wrapped_element.extend(_get_element(v, exclude_readonly, prop_meta)) + elif prop_meta.get("text", False): + # text could only set on primitive type + wrapped_element.text = _get_primitive_type_value(v) + elif prop_meta.get("attribute", False): + xml_name = prop_meta.get("name", k) + if prop_meta.get("ns"): + ET.register_namespace(prop_meta.get("prefix"), prop_meta.get("ns")) # pyright: ignore + xml_name = "{" + prop_meta.get("ns") + "}" + xml_name # pyright: ignore + # attribute should be primitive type + wrapped_element.set(xml_name, _get_primitive_type_value(v)) + else: + # other wrapped prop element + wrapped_element.append(_get_wrapped_element(v, exclude_readonly, prop_meta)) + return wrapped_element + if isinstance(o, list): + return [_get_element(x, exclude_readonly, parent_meta) for x in o] # type: ignore + if isinstance(o, dict): + result = [] + for k, v in o.items(): + result.append( + _get_wrapped_element( + v, + exclude_readonly, + { + "name": k, + "ns": parent_meta.get("ns") if parent_meta else None, + "prefix": parent_meta.get("prefix") if parent_meta else None, + }, + ) + ) + return result + + # primitive case need to create element based on parent_meta + if parent_meta: + return _get_wrapped_element( + o, + exclude_readonly, + { + "name": parent_meta.get("itemsName", parent_meta.get("name")), + "prefix": parent_meta.get("itemsPrefix", parent_meta.get("prefix")), + "ns": parent_meta.get("itemsNs", parent_meta.get("ns")), + }, + ) + + raise ValueError("Could not serialize value into xml: " + o) + + +def _get_wrapped_element( + v: typing.Any, + exclude_readonly: bool, + meta: typing.Optional[typing.Dict[str, typing.Any]], +) -> ET.Element: + wrapped_element = _create_xml_element( + meta.get("name") if meta else None, meta.get("prefix") if meta else None, meta.get("ns") if meta else None + ) + if isinstance(v, (dict, list)): + wrapped_element.extend(_get_element(v, exclude_readonly, meta)) + elif _is_model(v): + _get_element(v, exclude_readonly, meta, wrapped_element) + else: + wrapped_element.text = _get_primitive_type_value(v) + return wrapped_element + + +def _get_primitive_type_value(v) -> str: + if v is True: + return "true" + if v is False: + return "false" + if isinstance(v, _Null): + return "" + return str(v) + + +def _create_xml_element(tag, prefix=None, ns=None): + if prefix and ns: + ET.register_namespace(prefix, ns) + if ns: + return ET.Element("{" + ns + "}" + tag) + return ET.Element(tag) + + +def _deserialize_xml( + deserializer: typing.Any, + value: str, +) -> typing.Any: + element = ET.fromstring(value) # nosec + return _deserialize(deserializer, element) + + +def _convert_element(e: ET.Element): + # dict case + if len(e.attrib) > 0 or len({child.tag for child in e}) > 1: + dict_result: typing.Dict[str, typing.Any] = {} + for child in e: + if dict_result.get(child.tag) is not None: + if isinstance(dict_result[child.tag], list): + dict_result[child.tag].append(_convert_element(child)) + else: + dict_result[child.tag] = [dict_result[child.tag], _convert_element(child)] + else: + dict_result[child.tag] = _convert_element(child) + dict_result.update(e.attrib) + return dict_result + # array case + if len(e) > 0: + array_result: typing.List[typing.Any] = [] + for child in e: + array_result.append(_convert_element(child)) + return array_result + # primitive case + return e.text diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_utils/serialization.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_utils/serialization.py new file mode 100644 index 000000000000..eb86ea23c965 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_utils/serialization.py @@ -0,0 +1,2032 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +# pyright: reportUnnecessaryTypeIgnoreComment=false + +from base64 import b64decode, b64encode +import calendar +import datetime +import decimal +import email +from enum import Enum +import json +import logging +import re +import sys +import codecs +from typing import ( + Dict, + Any, + cast, + Optional, + Union, + AnyStr, + IO, + Mapping, + Callable, + MutableMapping, + List, +) + +try: + from urllib import quote # type: ignore +except ImportError: + from urllib.parse import quote +import xml.etree.ElementTree as ET + +import isodate # type: ignore +from typing_extensions import Self + +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull + +_BOM = codecs.BOM_UTF8.decode(encoding="utf-8") + +JSON = MutableMapping[str, Any] + + +class RawDeserializer: + + # Accept "text" because we're open minded people... + JSON_REGEXP = re.compile(r"^(application|text)/([a-z+.]+\+)?json$") + + # Name used in context + CONTEXT_NAME = "deserialized_data" + + @classmethod + def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: Optional[str] = None) -> Any: + """Decode data according to content-type. + + Accept a stream of data as well, but will be load at once in memory for now. + + If no content-type, will return the string version (not bytes, not stream) + + :param data: Input, could be bytes or stream (will be decoded with UTF8) or text + :type data: str or bytes or IO + :param str content_type: The content type. + :return: The deserialized data. + :rtype: object + """ + if hasattr(data, "read"): + # Assume a stream + data = cast(IO, data).read() + + if isinstance(data, bytes): + data_as_str = data.decode(encoding="utf-8-sig") + else: + # Explain to mypy the correct type. + data_as_str = cast(str, data) + + # Remove Byte Order Mark if present in string + data_as_str = data_as_str.lstrip(_BOM) + + if content_type is None: + return data + + if cls.JSON_REGEXP.match(content_type): + try: + return json.loads(data_as_str) + except ValueError as err: + raise DeserializationError("JSON is invalid: {}".format(err), err) from err + elif "xml" in (content_type or []): + try: + + try: + if isinstance(data, unicode): # type: ignore + # If I'm Python 2.7 and unicode XML will scream if I try a "fromstring" on unicode string + data_as_str = data_as_str.encode(encoding="utf-8") # type: ignore + except NameError: + pass + + return ET.fromstring(data_as_str) # nosec + except ET.ParseError as err: + # It might be because the server has an issue, and returned JSON with + # content-type XML.... + # So let's try a JSON load, and if it's still broken + # let's flow the initial exception + def _json_attemp(data): + try: + return True, json.loads(data) + except ValueError: + return False, None # Don't care about this one + + success, json_result = _json_attemp(data) + if success: + return json_result + # If i'm here, it's not JSON, it's not XML, let's scream + # and raise the last context in this block (the XML exception) + # The function hack is because Py2.7 messes up with exception + # context otherwise. + _LOGGER.critical("Wasn't XML not JSON, failing") + raise DeserializationError("XML is invalid") from err + elif content_type.startswith("text/"): + return data_as_str + raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) + + @classmethod + def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], headers: Mapping) -> Any: + """Deserialize from HTTP response. + + Use bytes and headers to NOT use any requests/aiohttp or whatever + specific implementation. + Headers will tested for "content-type" + + :param bytes body_bytes: The body of the response. + :param dict headers: The headers of the response. + :returns: The deserialized data. + :rtype: object + """ + # Try to use content-type from headers if available + content_type = None + if "content-type" in headers: + content_type = headers["content-type"].split(";")[0].strip().lower() + # Ouch, this server did not declare what it sent... + # Let's guess it's JSON... + # Also, since Autorest was considering that an empty body was a valid JSON, + # need that test as well.... + else: + content_type = "application/json" + + if body_bytes: + return cls.deserialize_from_text(body_bytes, content_type) + return None + + +_LOGGER = logging.getLogger(__name__) + +try: + _long_type = long # type: ignore +except NameError: + _long_type = int + +TZ_UTC = datetime.timezone.utc + +_FLATTEN = re.compile(r"(? None: + self.additional_properties: Optional[Dict[str, Any]] = {} + for k in kwargs: # pylint: disable=consider-using-dict-items + if k not in self._attribute_map: + _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) + elif k in self._validation and self._validation[k].get("readonly", False): + _LOGGER.warning("Readonly attribute %s will be ignored in class %s", k, self.__class__) + else: + setattr(self, k, kwargs[k]) + + def __eq__(self, other: Any) -> bool: + """Compare objects by comparing all attributes. + + :param object other: The object to compare + :returns: True if objects are equal + :rtype: bool + """ + if isinstance(other, self.__class__): + return self.__dict__ == other.__dict__ + return False + + def __ne__(self, other: Any) -> bool: + """Compare objects by comparing all attributes. + + :param object other: The object to compare + :returns: True if objects are not equal + :rtype: bool + """ + return not self.__eq__(other) + + def __str__(self) -> str: + return str(self.__dict__) + + @classmethod + def enable_additional_properties_sending(cls) -> None: + cls._attribute_map["additional_properties"] = {"key": "", "type": "{object}"} + + @classmethod + def is_xml_model(cls) -> bool: + try: + cls._xml_map # type: ignore + except AttributeError: + return False + return True + + @classmethod + def _create_xml_node(cls): + """Create XML node. + + :returns: The XML node + :rtype: xml.etree.ElementTree.Element + """ + try: + xml_map = cls._xml_map # type: ignore + except AttributeError: + xml_map = {} + + return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) + + def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: + """Return the JSON that would be sent to server from this model. + + This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`. + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, keep_readonly=keep_readonly, **kwargs + ) + + def as_dict( + self, + keep_readonly: bool = True, + key_transformer: Callable[[str, Dict[str, Any], Any], Any] = attribute_transformer, + **kwargs: Any + ) -> JSON: + """Return a dict that can be serialized using json.dump. + + Advanced usage might optionally use a callback as parameter: + + .. code::python + + def my_key_transformer(key, attr_desc, value): + return key + + Key is the attribute name used in Python. Attr_desc + is a dict of metadata. Currently contains 'type' with the + msrest type and 'key' with the RestAPI encoded key. + Value is the current value in this object. + + The string returned will be used to serialize the key. + If the return type is a list, this is considered hierarchical + result dict. + + See the three examples in this file: + + - attribute_transformer + - full_restapi_key_transformer + - last_restapi_key_transformer + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :param function key_transformer: A key transformer function. + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs + ) + + @classmethod + def _infer_class_models(cls): + try: + str_models = cls.__module__.rsplit(".", 1)[0] + models = sys.modules[str_models] + client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} + if cls.__name__ not in client_models: + raise ValueError("Not Autorest generated code") + except Exception: # pylint: disable=broad-exception-caught + # Assume it's not Autorest generated (tests?). Add ourselves as dependencies. + client_models = {cls.__name__: cls} + return client_models + + @classmethod + def deserialize(cls, data: Any, content_type: Optional[str] = None) -> Self: + """Parse a str using the RestAPI syntax and return a model. + + :param str data: A str using RestAPI structure. JSON by default. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises DeserializationError: if something went wrong + :rtype: Self + """ + deserializer = Deserializer(cls._infer_class_models()) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def from_dict( + cls, + data: Any, + key_extractors: Optional[Callable[[str, Dict[str, Any], Any], Any]] = None, + content_type: Optional[str] = None, + ) -> Self: + """Parse a dict using given key extractor return a model. + + By default consider key + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + and last_rest_key_case_insensitive_extractor) + + :param dict data: A dict using RestAPI structure + :param function key_extractors: A key extractor function. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises DeserializationError: if something went wrong + :rtype: Self + """ + deserializer = Deserializer(cls._infer_class_models()) + deserializer.key_extractors = ( # type: ignore + [ # type: ignore + attribute_key_case_insensitive_extractor, + rest_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + if key_extractors is None + else key_extractors + ) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def _flatten_subtype(cls, key, objects): + if "_subtype_map" not in cls.__dict__: + return {} + result = dict(cls._subtype_map[key]) + for valuetype in cls._subtype_map[key].values(): + result.update(objects[valuetype]._flatten_subtype(key, objects)) # pylint: disable=protected-access + return result + + @classmethod + def _classify(cls, response, objects): + """Check the class _subtype_map for any child classes. + We want to ignore any inherited _subtype_maps. + + :param dict response: The initial data + :param dict objects: The class objects + :returns: The class to be used + :rtype: class + """ + for subtype_key in cls.__dict__.get("_subtype_map", {}).keys(): + subtype_value = None + + if not isinstance(response, ET.Element): + rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1] + subtype_value = response.get(rest_api_response_key, None) or response.get(subtype_key, None) + else: + subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response) + if subtype_value: + # Try to match base class. Can be class name only + # (bug to fix in Autorest to support x-ms-discriminator-name) + if cls.__name__ == subtype_value: + return cls + flatten_mapping_type = cls._flatten_subtype(subtype_key, objects) + try: + return objects[flatten_mapping_type[subtype_value]] # type: ignore + except KeyError: + _LOGGER.warning( + "Subtype value %s has no mapping, use base class %s.", + subtype_value, + cls.__name__, + ) + break + else: + _LOGGER.warning("Discriminator %s is absent or null, use base class %s.", subtype_key, cls.__name__) + break + return cls + + @classmethod + def _get_rest_key_parts(cls, attr_key): + """Get the RestAPI key of this attr, split it and decode part + :param str attr_key: Attribute key must be in attribute_map. + :returns: A list of RestAPI part + :rtype: list + """ + rest_split_key = _FLATTEN.split(cls._attribute_map[attr_key]["key"]) + return [_decode_attribute_map_key(key_part) for key_part in rest_split_key] + + +def _decode_attribute_map_key(key): + """This decode a key in an _attribute_map to the actual key we want to look at + inside the received data. + + :param str key: A key string from the generated code + :returns: The decoded key + :rtype: str + """ + return key.replace("\\.", ".") + + +class Serializer: # pylint: disable=too-many-public-methods + """Request object model serializer.""" + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + _xml_basic_types_serializers = {"bool": lambda x: str(x).lower()} + days = {0: "Mon", 1: "Tue", 2: "Wed", 3: "Thu", 4: "Fri", 5: "Sat", 6: "Sun"} + months = { + 1: "Jan", + 2: "Feb", + 3: "Mar", + 4: "Apr", + 5: "May", + 6: "Jun", + 7: "Jul", + 8: "Aug", + 9: "Sep", + 10: "Oct", + 11: "Nov", + 12: "Dec", + } + validation = { + "min_length": lambda x, y: len(x) < y, + "max_length": lambda x, y: len(x) > y, + "minimum": lambda x, y: x < y, + "maximum": lambda x, y: x > y, + "minimum_ex": lambda x, y: x <= y, + "maximum_ex": lambda x, y: x >= y, + "min_items": lambda x, y: len(x) < y, + "max_items": lambda x, y: len(x) > y, + "pattern": lambda x, y: not re.match(y, x, re.UNICODE), + "unique": lambda x, y: len(x) != len(set(x)), + "multiple": lambda x, y: x % y != 0, + } + + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: + self.serialize_type = { + "iso-8601": Serializer.serialize_iso, + "rfc-1123": Serializer.serialize_rfc, + "unix-time": Serializer.serialize_unix, + "duration": Serializer.serialize_duration, + "date": Serializer.serialize_date, + "time": Serializer.serialize_time, + "decimal": Serializer.serialize_decimal, + "long": Serializer.serialize_long, + "bytearray": Serializer.serialize_bytearray, + "base64": Serializer.serialize_base64, + "object": self.serialize_object, + "[]": self.serialize_iter, + "{}": self.serialize_dict, + } + self.dependencies: Dict[str, type] = dict(classes) if classes else {} + self.key_transformer = full_restapi_key_transformer + self.client_side_validation = True + + def _serialize( # pylint: disable=too-many-nested-blocks, too-many-branches, too-many-statements, too-many-locals + self, target_obj, data_type=None, **kwargs + ): + """Serialize data into a string according to type. + + :param object target_obj: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, dict + :raises SerializationError: if serialization fails. + :returns: The serialized data. + """ + key_transformer = kwargs.get("key_transformer", self.key_transformer) + keep_readonly = kwargs.get("keep_readonly", False) + if target_obj is None: + return None + + attr_name = None + class_name = target_obj.__class__.__name__ + + if data_type: + return self.serialize_data(target_obj, data_type, **kwargs) + + if not hasattr(target_obj, "_attribute_map"): + data_type = type(target_obj).__name__ + if data_type in self.basic_types.values(): + return self.serialize_data(target_obj, data_type, **kwargs) + + # Force "is_xml" kwargs if we detect a XML model + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + is_xml_model_serialization = kwargs.setdefault("is_xml", target_obj.is_xml_model()) + + serialized = {} + if is_xml_model_serialization: + serialized = target_obj._create_xml_node() # pylint: disable=protected-access + try: + attributes = target_obj._attribute_map # pylint: disable=protected-access + for attr, attr_desc in attributes.items(): + attr_name = attr + if not keep_readonly and target_obj._validation.get( # pylint: disable=protected-access + attr_name, {} + ).get("readonly", False): + continue + + if attr_name == "additional_properties" and attr_desc["key"] == "": + if target_obj.additional_properties is not None: + serialized.update(target_obj.additional_properties) + continue + try: + + orig_attr = getattr(target_obj, attr) + if is_xml_model_serialization: + pass # Don't provide "transformer" for XML for now. Keep "orig_attr" + else: # JSON + keys, orig_attr = key_transformer(attr, attr_desc.copy(), orig_attr) + keys = keys if isinstance(keys, list) else [keys] + + kwargs["serialization_ctxt"] = attr_desc + new_attr = self.serialize_data(orig_attr, attr_desc["type"], **kwargs) + + if is_xml_model_serialization: + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + xml_prefix = xml_desc.get("prefix", None) + xml_ns = xml_desc.get("ns", None) + if xml_desc.get("attr", False): + if xml_ns: + ET.register_namespace(xml_prefix, xml_ns) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + serialized.set(xml_name, new_attr) # type: ignore + continue + if xml_desc.get("text", False): + serialized.text = new_attr # type: ignore + continue + if isinstance(new_attr, list): + serialized.extend(new_attr) # type: ignore + elif isinstance(new_attr, ET.Element): + # If the down XML has no XML/Name, + # we MUST replace the tag with the local tag. But keeping the namespaces. + if "name" not in getattr(orig_attr, "_xml_map", {}): + splitted_tag = new_attr.tag.split("}") + if len(splitted_tag) == 2: # Namespace + new_attr.tag = "}".join([splitted_tag[0], xml_name]) + else: + new_attr.tag = xml_name + serialized.append(new_attr) # type: ignore + else: # That's a basic type + # Integrate namespace if necessary + local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) + local_node.text = str(new_attr) + serialized.append(local_node) # type: ignore + else: # JSON + for k in reversed(keys): # type: ignore + new_attr = {k: new_attr} + + _new_attr = new_attr + _serialized = serialized + for k in keys: # type: ignore + if k not in _serialized: + _serialized.update(_new_attr) # type: ignore + _new_attr = _new_attr[k] # type: ignore + _serialized = _serialized[k] + except ValueError as err: + if isinstance(err, SerializationError): + raise + + except (AttributeError, KeyError, TypeError) as err: + msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) + raise SerializationError(msg) from err + return serialized + + def body(self, data, data_type, **kwargs): + """Serialize data intended for a request body. + + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: dict + :raises SerializationError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized request body + """ + + # Just in case this is a dict + internal_data_type_str = data_type.strip("[]{}") + internal_data_type = self.dependencies.get(internal_data_type_str, None) + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + if internal_data_type and issubclass(internal_data_type, Model): + is_xml_model_serialization = kwargs.setdefault("is_xml", internal_data_type.is_xml_model()) + else: + is_xml_model_serialization = False + if internal_data_type and not isinstance(internal_data_type, Enum): + try: + deserializer = Deserializer(self.dependencies) + # Since it's on serialization, it's almost sure that format is not JSON REST + # We're not able to deal with additional properties for now. + deserializer.additional_properties_detection = False + if is_xml_model_serialization: + deserializer.key_extractors = [ # type: ignore + attribute_key_case_insensitive_extractor, + ] + else: + deserializer.key_extractors = [ + rest_key_case_insensitive_extractor, + attribute_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + data = deserializer._deserialize(data_type, data) # pylint: disable=protected-access + except DeserializationError as err: + raise SerializationError("Unable to build a model: " + str(err)) from err + + return self._serialize(data, data_type, **kwargs) + + def url(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL path. + + :param str name: The name of the URL path parameter. + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :returns: The serialized URL path + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + """ + try: + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + + if kwargs.get("skip_quote") is True: + output = str(output) + output = output.replace("{", quote("{")).replace("}", quote("}")) + else: + output = quote(str(output), safe="") + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return output + + def query(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL query. + + :param str name: The name of the query parameter. + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, list + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized query parameter + """ + try: + # Treat the list aside, since we don't want to encode the div separator + if data_type.startswith("["): + internal_data_type = data_type[1:-1] + do_quote = not kwargs.get("skip_quote", False) + return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs) + + # Not a list, regular serialization + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + if kwargs.get("skip_quote") is True: + output = str(output) + else: + output = quote(str(output), safe="") + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return str(output) + + def header(self, name, data, data_type, **kwargs): + """Serialize data intended for a request header. + + :param str name: The name of the header. + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized header + """ + try: + if data_type in ["[str]"]: + data = ["" if d is None else d for d in data] + + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return str(output) + + def serialize_data(self, data, data_type, **kwargs): + """Serialize generic data according to supplied data type. + + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :raises AttributeError: if required data is None. + :raises ValueError: if data is None + :raises SerializationError: if serialization fails. + :returns: The serialized data. + :rtype: str, int, float, bool, dict, list + """ + if data is None: + raise ValueError("No value for given attribute") + + try: + if data is CoreNull: + return None + if data_type in self.basic_types.values(): + return self.serialize_basic(data, data_type, **kwargs) + + if data_type in self.serialize_type: + return self.serialize_type[data_type](data, **kwargs) + + # If dependencies is empty, try with current data class + # It has to be a subclass of Enum anyway + enum_type = self.dependencies.get(data_type, data.__class__) + if issubclass(enum_type, Enum): + return Serializer.serialize_enum(data, enum_obj=enum_type) + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.serialize_type: + return self.serialize_type[iter_type](data, data_type[1:-1], **kwargs) + + except (ValueError, TypeError) as err: + msg = "Unable to serialize value: {!r} as type: {!r}." + raise SerializationError(msg.format(data, data_type)) from err + return self._serialize(data, **kwargs) + + @classmethod + def _get_custom_serializers(cls, data_type, **kwargs): # pylint: disable=inconsistent-return-statements + custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type) + if custom_serializer: + return custom_serializer + if kwargs.get("is_xml", False): + return cls._xml_basic_types_serializers.get(data_type) + + @classmethod + def serialize_basic(cls, data, data_type, **kwargs): + """Serialize basic builting data type. + Serializes objects to str, int, float or bool. + + Possible kwargs: + - basic_types_serializers dict[str, callable] : If set, use the callable as serializer + - is_xml bool : If set, use xml_basic_types_serializers + + :param obj data: Object to be serialized. + :param str data_type: Type of object in the iterable. + :rtype: str, int, float, bool + :return: serialized object + """ + custom_serializer = cls._get_custom_serializers(data_type, **kwargs) + if custom_serializer: + return custom_serializer(data) + if data_type == "str": + return cls.serialize_unicode(data) + return eval(data_type)(data) # nosec # pylint: disable=eval-used + + @classmethod + def serialize_unicode(cls, data): + """Special handling for serializing unicode strings in Py2. + Encode to UTF-8 if unicode, otherwise handle as a str. + + :param str data: Object to be serialized. + :rtype: str + :return: serialized object + """ + try: # If I received an enum, return its value + return data.value + except AttributeError: + pass + + try: + if isinstance(data, unicode): # type: ignore + # Don't change it, JSON and XML ElementTree are totally able + # to serialize correctly u'' strings + return data + except NameError: + return str(data) + return str(data) + + def serialize_iter(self, data, iter_type, div=None, **kwargs): + """Serialize iterable. + + Supported kwargs: + - serialization_ctxt dict : The current entry of _attribute_map, or same format. + serialization_ctxt['type'] should be same as data_type. + - is_xml bool : If set, serialize as XML + + :param list data: Object to be serialized. + :param str iter_type: Type of object in the iterable. + :param str div: If set, this str will be used to combine the elements + in the iterable into a combined string. Default is 'None'. + Defaults to False. + :rtype: list, str + :return: serialized iterable + """ + if isinstance(data, str): + raise SerializationError("Refuse str type as a valid iter type.") + + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + is_xml = kwargs.get("is_xml", False) + + serialized = [] + for d in data: + try: + serialized.append(self.serialize_data(d, iter_type, **kwargs)) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized.append(None) + + if kwargs.get("do_quote", False): + serialized = ["" if s is None else quote(str(s), safe="") for s in serialized] + + if div: + serialized = ["" if s is None else str(s) for s in serialized] + serialized = div.join(serialized) + + if "xml" in serialization_ctxt or is_xml: + # XML serialization is more complicated + xml_desc = serialization_ctxt.get("xml", {}) + xml_name = xml_desc.get("name") + if not xml_name: + xml_name = serialization_ctxt["key"] + + # Create a wrap node if necessary (use the fact that Element and list have "append") + is_wrapped = xml_desc.get("wrapped", False) + node_name = xml_desc.get("itemsName", xml_name) + if is_wrapped: + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + else: + final_result = [] + # All list elements to "local_node" + for el in serialized: + if isinstance(el, ET.Element): + el_node = el + else: + el_node = _create_xml_node(node_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + if el is not None: # Otherwise it writes "None" :-p + el_node.text = str(el) + final_result.append(el_node) + return final_result + return serialized + + def serialize_dict(self, attr, dict_type, **kwargs): + """Serialize a dictionary of objects. + + :param dict attr: Object to be serialized. + :param str dict_type: Type of object in the dictionary. + :rtype: dict + :return: serialized dictionary + """ + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized[self.serialize_unicode(key)] = None + + if "xml" in serialization_ctxt: + # XML serialization is more complicated + xml_desc = serialization_ctxt["xml"] + xml_name = xml_desc["name"] + + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + for key, value in serialized.items(): + ET.SubElement(final_result, key).text = value + return final_result + + return serialized + + def serialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements + """Serialize a generic object. + This will be handled as a dictionary. If object passed in is not + a basic type (str, int, float, dict, list) it will simply be + cast to str. + + :param dict attr: Object to be serialized. + :rtype: dict or str + :return: serialized object + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + return attr + obj_type = type(attr) + if obj_type in self.basic_types: + return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) + if obj_type is _long_type: + return self.serialize_long(attr) + if obj_type is str: + return self.serialize_unicode(attr) + if obj_type is datetime.datetime: + return self.serialize_iso(attr) + if obj_type is datetime.date: + return self.serialize_date(attr) + if obj_type is datetime.time: + return self.serialize_time(attr) + if obj_type is datetime.timedelta: + return self.serialize_duration(attr) + if obj_type is decimal.Decimal: + return self.serialize_decimal(attr) + + # If it's a model or I know this dependency, serialize as a Model + if obj_type in self.dependencies.values() or isinstance(attr, Model): + return self._serialize(attr) + + if obj_type == dict: + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_object(value, **kwargs) + except ValueError: + serialized[self.serialize_unicode(key)] = None + return serialized + + if obj_type == list: + serialized = [] + for obj in attr: + try: + serialized.append(self.serialize_object(obj, **kwargs)) + except ValueError: + pass + return serialized + return str(attr) + + @staticmethod + def serialize_enum(attr, enum_obj=None): + try: + result = attr.value + except AttributeError: + result = attr + try: + enum_obj(result) # type: ignore + return result + except ValueError as exc: + for enum_value in enum_obj: # type: ignore + if enum_value.value.lower() == str(attr).lower(): + return enum_value.value + error = "{!r} is not valid value for enum {!r}" + raise SerializationError(error.format(attr, enum_obj)) from exc + + @staticmethod + def serialize_bytearray(attr, **kwargs): # pylint: disable=unused-argument + """Serialize bytearray into base-64 string. + + :param str attr: Object to be serialized. + :rtype: str + :return: serialized base64 + """ + return b64encode(attr).decode() + + @staticmethod + def serialize_base64(attr, **kwargs): # pylint: disable=unused-argument + """Serialize str into base-64 string. + + :param str attr: Object to be serialized. + :rtype: str + :return: serialized base64 + """ + encoded = b64encode(attr).decode("ascii") + return encoded.strip("=").replace("+", "-").replace("/", "_") + + @staticmethod + def serialize_decimal(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Decimal object to float. + + :param decimal attr: Object to be serialized. + :rtype: float + :return: serialized decimal + """ + return float(attr) + + @staticmethod + def serialize_long(attr, **kwargs): # pylint: disable=unused-argument + """Serialize long (Py2) or int (Py3). + + :param int attr: Object to be serialized. + :rtype: int/long + :return: serialized long + """ + return _long_type(attr) + + @staticmethod + def serialize_date(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Date object into ISO-8601 formatted string. + + :param Date attr: Object to be serialized. + :rtype: str + :return: serialized date + """ + if isinstance(attr, str): + attr = isodate.parse_date(attr) + t = "{:04}-{:02}-{:02}".format(attr.year, attr.month, attr.day) + return t + + @staticmethod + def serialize_time(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Time object into ISO-8601 formatted string. + + :param datetime.time attr: Object to be serialized. + :rtype: str + :return: serialized time + """ + if isinstance(attr, str): + attr = isodate.parse_time(attr) + t = "{:02}:{:02}:{:02}".format(attr.hour, attr.minute, attr.second) + if attr.microsecond: + t += ".{:02}".format(attr.microsecond) + return t + + @staticmethod + def serialize_duration(attr, **kwargs): # pylint: disable=unused-argument + """Serialize TimeDelta object into ISO-8601 formatted string. + + :param TimeDelta attr: Object to be serialized. + :rtype: str + :return: serialized duration + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + return isodate.duration_isoformat(attr) + + @staticmethod + def serialize_rfc(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Datetime object into RFC-1123 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises TypeError: if format invalid. + :return: serialized rfc + """ + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + except AttributeError as exc: + raise TypeError("RFC1123 object must be valid Datetime object.") from exc + + return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format( + Serializer.days[utc.tm_wday], + utc.tm_mday, + Serializer.months[utc.tm_mon], + utc.tm_year, + utc.tm_hour, + utc.tm_min, + utc.tm_sec, + ) + + @staticmethod + def serialize_iso(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Datetime object into ISO-8601 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises SerializationError: if format invalid. + :return: serialized iso + """ + if isinstance(attr, str): + attr = isodate.parse_datetime(attr) + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + if utc.tm_year > 9999 or utc.tm_year < 1: + raise OverflowError("Hit max or min date") + + microseconds = str(attr.microsecond).rjust(6, "0").rstrip("0").ljust(3, "0") + if microseconds: + microseconds = "." + microseconds + date = "{:04}-{:02}-{:02}T{:02}:{:02}:{:02}".format( + utc.tm_year, utc.tm_mon, utc.tm_mday, utc.tm_hour, utc.tm_min, utc.tm_sec + ) + return date + microseconds + "Z" + except (ValueError, OverflowError) as err: + msg = "Unable to serialize datetime object." + raise SerializationError(msg) from err + except AttributeError as err: + msg = "ISO-8601 object must be valid Datetime object." + raise TypeError(msg) from err + + @staticmethod + def serialize_unix(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param Datetime attr: Object to be serialized. + :rtype: int + :raises SerializationError: if format invalid + :return: serialied unix + """ + if isinstance(attr, int): + return attr + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + return int(calendar.timegm(attr.utctimetuple())) + except AttributeError as exc: + raise TypeError("Unix time object must be valid Datetime object.") from exc + + +def rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + key = attr_desc["key"] + working_data = data + + while "." in key: + # Need the cast, as for some reasons "split" is typed as list[str | Any] + dict_keys = cast(List[str], _FLATTEN.split(key)) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = working_data.get(working_key, data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + return working_data.get(key) + + +def rest_key_case_insensitive_extractor( # pylint: disable=unused-argument, inconsistent-return-statements + attr, attr_desc, data +): + key = attr_desc["key"] + working_data = data + + while "." in key: + dict_keys = _FLATTEN.split(key) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = attribute_key_case_insensitive_extractor(working_key, None, working_data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + if working_data: + return attribute_key_case_insensitive_extractor(key, None, working_data) + + +def last_rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + """Extract the attribute in "data" based on the last part of the JSON path key. + + :param str attr: The attribute to extract + :param dict attr_desc: The attribute description + :param dict data: The data to extract from + :rtype: object + :returns: The extracted attribute + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_extractor(dict_keys[-1], None, data) + + +def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + """Extract the attribute in "data" based on the last part of the JSON path key. + + This is the case insensitive version of "last_rest_key_extractor" + :param str attr: The attribute to extract + :param dict attr_desc: The attribute description + :param dict data: The data to extract from + :rtype: object + :returns: The extracted attribute + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_case_insensitive_extractor(dict_keys[-1], None, data) + + +def attribute_key_extractor(attr, _, data): + return data.get(attr) + + +def attribute_key_case_insensitive_extractor(attr, _, data): + found_key = None + lower_attr = attr.lower() + for key in data: + if lower_attr == key.lower(): + found_key = key + break + + return data.get(found_key) + + +def _extract_name_from_internal_type(internal_type): + """Given an internal type XML description, extract correct XML name with namespace. + + :param dict internal_type: An model type + :rtype: tuple + :returns: A tuple XML name + namespace dict + """ + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + xml_name = internal_type_xml_map.get("name", internal_type.__name__) + xml_ns = internal_type_xml_map.get("ns", None) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + return xml_name + + +def xml_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument,too-many-return-statements + if isinstance(data, dict): + return None + + # Test if this model is XML ready first + if not isinstance(data, ET.Element): + return None + + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + + # Look for a children + is_iter_type = attr_desc["type"].startswith("[") + is_wrapped = xml_desc.get("wrapped", False) + internal_type = attr_desc.get("internalType", None) + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + + # Integrate namespace if necessary + xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None)) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + + # If it's an attribute, that's simple + if xml_desc.get("attr", False): + return data.get(xml_name) + + # If it's x-ms-text, that's simple too + if xml_desc.get("text", False): + return data.text + + # Scenario where I take the local name: + # - Wrapped node + # - Internal type is an enum (considered basic types) + # - Internal type has no XML/Name node + if is_wrapped or (internal_type and (issubclass(internal_type, Enum) or "name" not in internal_type_xml_map)): + children = data.findall(xml_name) + # If internal type has a local name and it's not a list, I use that name + elif not is_iter_type and internal_type and "name" in internal_type_xml_map: + xml_name = _extract_name_from_internal_type(internal_type) + children = data.findall(xml_name) + # That's an array + else: + if internal_type: # Complex type, ignore itemsName and use the complex type name + items_name = _extract_name_from_internal_type(internal_type) + else: + items_name = xml_desc.get("itemsName", xml_name) + children = data.findall(items_name) + + if len(children) == 0: + if is_iter_type: + if is_wrapped: + return None # is_wrapped no node, we want None + return [] # not wrapped, assume empty list + return None # Assume it's not there, maybe an optional node. + + # If is_iter_type and not wrapped, return all found children + if is_iter_type: + if not is_wrapped: + return children + # Iter and wrapped, should have found one node only (the wrap one) + if len(children) != 1: + raise DeserializationError( + "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( + xml_name + ) + ) + return list(children[0]) # Might be empty list and that's ok. + + # Here it's not a itertype, we should have found one element only or empty + if len(children) > 1: + raise DeserializationError("Find several XML '{}' where it was not expected".format(xml_name)) + return children[0] + + +class Deserializer: + """Response object model deserializer. + + :param dict classes: Class type dictionary for deserializing complex types. + :ivar list key_extractors: Ordered list of extractors to be used by this deserializer. + """ + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: + self.deserialize_type = { + "iso-8601": Deserializer.deserialize_iso, + "rfc-1123": Deserializer.deserialize_rfc, + "unix-time": Deserializer.deserialize_unix, + "duration": Deserializer.deserialize_duration, + "date": Deserializer.deserialize_date, + "time": Deserializer.deserialize_time, + "decimal": Deserializer.deserialize_decimal, + "long": Deserializer.deserialize_long, + "bytearray": Deserializer.deserialize_bytearray, + "base64": Deserializer.deserialize_base64, + "object": self.deserialize_object, + "[]": self.deserialize_iter, + "{}": self.deserialize_dict, + } + self.deserialize_expected_types = { + "duration": (isodate.Duration, datetime.timedelta), + "iso-8601": (datetime.datetime), + } + self.dependencies: Dict[str, type] = dict(classes) if classes else {} + self.key_extractors = [rest_key_extractor, xml_key_extractor] + # Additional properties only works if the "rest_key_extractor" is used to + # extract the keys. Making it to work whatever the key extractor is too much + # complicated, with no real scenario for now. + # So adding a flag to disable additional properties detection. This flag should be + # used if your expect the deserialization to NOT come from a JSON REST syntax. + # Otherwise, result are unexpected + self.additional_properties_detection = True + + def __call__(self, target_obj, response_data, content_type=None): + """Call the deserializer to process a REST response. + + :param str target_obj: Target data type to deserialize to. + :param requests.Response response_data: REST response object. + :param str content_type: Swagger "produces" if available. + :raises DeserializationError: if deserialization fails. + :return: Deserialized object. + :rtype: object + """ + data = self._unpack_content(response_data, content_type) + return self._deserialize(target_obj, data) + + def _deserialize(self, target_obj, data): # pylint: disable=inconsistent-return-statements + """Call the deserializer on a model. + + Data needs to be already deserialized as JSON or XML ElementTree + + :param str target_obj: Target data type to deserialize to. + :param object data: Object to deserialize. + :raises DeserializationError: if deserialization fails. + :return: Deserialized object. + :rtype: object + """ + # This is already a model, go recursive just in case + if hasattr(data, "_attribute_map"): + constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")] + try: + for attr, mapconfig in data._attribute_map.items(): # pylint: disable=protected-access + if attr in constants: + continue + value = getattr(data, attr) + if value is None: + continue + local_type = mapconfig["type"] + internal_data_type = local_type.strip("[]{}") + if internal_data_type not in self.dependencies or isinstance(internal_data_type, Enum): + continue + setattr(data, attr, self._deserialize(local_type, value)) + return data + except AttributeError: + return + + response, class_name = self._classify_target(target_obj, data) + + if isinstance(response, str): + return self.deserialize_data(data, response) + if isinstance(response, type) and issubclass(response, Enum): + return self.deserialize_enum(data, response) + + if data is None or data is CoreNull: + return data + try: + attributes = response._attribute_map # type: ignore # pylint: disable=protected-access + d_attrs = {} + for attr, attr_desc in attributes.items(): + # Check empty string. If it's not empty, someone has a real "additionalProperties"... + if attr == "additional_properties" and attr_desc["key"] == "": + continue + raw_value = None + # Enhance attr_desc with some dynamic data + attr_desc = attr_desc.copy() # Do a copy, do not change the real one + internal_data_type = attr_desc["type"].strip("[]{}") + if internal_data_type in self.dependencies: + attr_desc["internalType"] = self.dependencies[internal_data_type] + + for key_extractor in self.key_extractors: + found_value = key_extractor(attr, attr_desc, data) + if found_value is not None: + if raw_value is not None and raw_value != found_value: + msg = ( + "Ignoring extracted value '%s' from %s for key '%s'" + " (duplicate extraction, follow extractors order)" + ) + _LOGGER.warning(msg, found_value, key_extractor, attr) + continue + raw_value = found_value + + value = self.deserialize_data(raw_value, attr_desc["type"]) + d_attrs[attr] = value + except (AttributeError, TypeError, KeyError) as err: + msg = "Unable to deserialize to object: " + class_name # type: ignore + raise DeserializationError(msg) from err + additional_properties = self._build_additional_properties(attributes, data) + return self._instantiate_model(response, d_attrs, additional_properties) + + def _build_additional_properties(self, attribute_map, data): + if not self.additional_properties_detection: + return None + if "additional_properties" in attribute_map and attribute_map.get("additional_properties", {}).get("key") != "": + # Check empty string. If it's not empty, someone has a real "additionalProperties" + return None + if isinstance(data, ET.Element): + data = {el.tag: el.text for el in data} + + known_keys = { + _decode_attribute_map_key(_FLATTEN.split(desc["key"])[0]) + for desc in attribute_map.values() + if desc["key"] != "" + } + present_keys = set(data.keys()) + missing_keys = present_keys - known_keys + return {key: data[key] for key in missing_keys} + + def _classify_target(self, target, data): + """Check to see whether the deserialization target object can + be classified into a subclass. + Once classification has been determined, initialize object. + + :param str target: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :return: The classified target object and its class name. + :rtype: tuple + """ + if target is None: + return None, None + + if isinstance(target, str): + try: + target = self.dependencies[target] + except KeyError: + return target, target + + try: + target = target._classify(data, self.dependencies) # type: ignore # pylint: disable=protected-access + except AttributeError: + pass # Target is not a Model, no classify + return target, target.__class__.__name__ # type: ignore + + def failsafe_deserialize(self, target_obj, data, content_type=None): + """Ignores any errors encountered in deserialization, + and falls back to not deserializing the object. Recommended + for use in error deserialization, as we want to return the + HttpResponseError to users, and not have them deal with + a deserialization error. + + :param str target_obj: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :param str content_type: Swagger "produces" if available. + :return: Deserialized object. + :rtype: object + """ + try: + return self(target_obj, data, content_type=content_type) + except: # pylint: disable=bare-except + _LOGGER.debug( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + @staticmethod + def _unpack_content(raw_data, content_type=None): + """Extract the correct structure for deserialization. + + If raw_data is a PipelineResponse, try to extract the result of RawDeserializer. + if we can't, raise. Your Pipeline should have a RawDeserializer. + + If not a pipeline response and raw_data is bytes or string, use content-type + to decode it. If no content-type, try JSON. + + If raw_data is something else, bypass all logic and return it directly. + + :param obj raw_data: Data to be processed. + :param str content_type: How to parse if raw_data is a string/bytes. + :raises JSONDecodeError: If JSON is requested and parsing is impossible. + :raises UnicodeDecodeError: If bytes is not UTF8 + :rtype: object + :return: Unpacked content. + """ + # Assume this is enough to detect a Pipeline Response without importing it + context = getattr(raw_data, "context", {}) + if context: + if RawDeserializer.CONTEXT_NAME in context: + return context[RawDeserializer.CONTEXT_NAME] + raise ValueError("This pipeline didn't have the RawDeserializer policy; can't deserialize") + + # Assume this is enough to recognize universal_http.ClientResponse without importing it + if hasattr(raw_data, "body"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text(), raw_data.headers) + + # Assume this enough to recognize requests.Response without importing it. + if hasattr(raw_data, "_content_consumed"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) + + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): + return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore + return raw_data + + def _instantiate_model(self, response, attrs, additional_properties=None): + """Instantiate a response model passing in deserialized args. + + :param Response response: The response model class. + :param dict attrs: The deserialized response attributes. + :param dict additional_properties: Additional properties to be set. + :rtype: Response + :return: The instantiated response model. + """ + if callable(response): + subtype = getattr(response, "_subtype_map", {}) + try: + readonly = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("readonly") + ] + const = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("constant") + ] + kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const} + response_obj = response(**kwargs) + for attr in readonly: + setattr(response_obj, attr, attrs.get(attr)) + if additional_properties: + response_obj.additional_properties = additional_properties # type: ignore + return response_obj + except TypeError as err: + msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore + raise DeserializationError(msg + str(err)) from err + else: + try: + for attr, value in attrs.items(): + setattr(response, attr, value) + return response + except Exception as exp: + msg = "Unable to populate response model. " + msg += "Type: {}, Error: {}".format(type(response), exp) + raise DeserializationError(msg) from exp + + def deserialize_data(self, data, data_type): # pylint: disable=too-many-return-statements + """Process data for deserialization according to data type. + + :param str data: The response string to be deserialized. + :param str data_type: The type to deserialize to. + :raises DeserializationError: if deserialization fails. + :return: Deserialized object. + :rtype: object + """ + if data is None: + return data + + try: + if not data_type: + return data + if data_type in self.basic_types.values(): + return self.deserialize_basic(data, data_type) + if data_type in self.deserialize_type: + if isinstance(data, self.deserialize_expected_types.get(data_type, tuple())): + return data + + is_a_text_parsing_type = lambda x: x not in [ # pylint: disable=unnecessary-lambda-assignment + "object", + "[]", + r"{}", + ] + if isinstance(data, ET.Element) and is_a_text_parsing_type(data_type) and not data.text: + return None + data_val = self.deserialize_type[data_type](data) + return data_val + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.deserialize_type: + return self.deserialize_type[iter_type](data, data_type[1:-1]) + + obj_type = self.dependencies[data_type] + if issubclass(obj_type, Enum): + if isinstance(data, ET.Element): + data = data.text + return self.deserialize_enum(data, obj_type) + + except (ValueError, TypeError, AttributeError) as err: + msg = "Unable to deserialize response data." + msg += " Data: {}, {}".format(data, data_type) + raise DeserializationError(msg) from err + return self._deserialize(obj_type, data) + + def deserialize_iter(self, attr, iter_type): + """Deserialize an iterable. + + :param list attr: Iterable to be deserialized. + :param str iter_type: The type of object in the iterable. + :return: Deserialized iterable. + :rtype: list + """ + if attr is None: + return None + if isinstance(attr, ET.Element): # If I receive an element here, get the children + attr = list(attr) + if not isinstance(attr, (list, set)): + raise DeserializationError("Cannot deserialize as [{}] an object of type {}".format(iter_type, type(attr))) + return [self.deserialize_data(a, iter_type) for a in attr] + + def deserialize_dict(self, attr, dict_type): + """Deserialize a dictionary. + + :param dict/list attr: Dictionary to be deserialized. Also accepts + a list of key, value pairs. + :param str dict_type: The object type of the items in the dictionary. + :return: Deserialized dictionary. + :rtype: dict + """ + if isinstance(attr, list): + return {x["key"]: self.deserialize_data(x["value"], dict_type) for x in attr} + + if isinstance(attr, ET.Element): + # Transform value into {"Key": "value"} + attr = {el.tag: el.text for el in attr} + return {k: self.deserialize_data(v, dict_type) for k, v in attr.items()} + + def deserialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements + """Deserialize a generic object. + This will be handled as a dictionary. + + :param dict attr: Dictionary to be deserialized. + :return: Deserialized object. + :rtype: dict + :raises TypeError: if non-builtin datatype encountered. + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + # Do no recurse on XML, just return the tree as-is + return attr + if isinstance(attr, str): + return self.deserialize_basic(attr, "str") + obj_type = type(attr) + if obj_type in self.basic_types: + return self.deserialize_basic(attr, self.basic_types[obj_type]) + if obj_type is _long_type: + return self.deserialize_long(attr) + + if obj_type == dict: + deserialized = {} + for key, value in attr.items(): + try: + deserialized[key] = self.deserialize_object(value, **kwargs) + except ValueError: + deserialized[key] = None + return deserialized + + if obj_type == list: + deserialized = [] + for obj in attr: + try: + deserialized.append(self.deserialize_object(obj, **kwargs)) + except ValueError: + pass + return deserialized + + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) + + def deserialize_basic(self, attr, data_type): # pylint: disable=too-many-return-statements + """Deserialize basic builtin data type from string. + Will attempt to convert to str, int, float and bool. + This function will also accept '1', '0', 'true' and 'false' as + valid bool values. + + :param str attr: response string to be deserialized. + :param str data_type: deserialization data type. + :return: Deserialized basic type. + :rtype: str, int, float or bool + :raises TypeError: if string format is not valid. + """ + # If we're here, data is supposed to be a basic type. + # If it's still an XML node, take the text + if isinstance(attr, ET.Element): + attr = attr.text + if not attr: + if data_type == "str": + # None or '', node is empty string. + return "" + # None or '', node with a strong type is None. + # Don't try to model "empty bool" or "empty int" + return None + + if data_type == "bool": + if attr in [True, False, 1, 0]: + return bool(attr) + if isinstance(attr, str): + if attr.lower() in ["true", "1"]: + return True + if attr.lower() in ["false", "0"]: + return False + raise TypeError("Invalid boolean value: {}".format(attr)) + + if data_type == "str": + return self.deserialize_unicode(attr) + return eval(data_type)(attr) # nosec # pylint: disable=eval-used + + @staticmethod + def deserialize_unicode(data): + """Preserve unicode objects in Python 2, otherwise return data + as a string. + + :param str data: response string to be deserialized. + :return: Deserialized string. + :rtype: str or unicode + """ + # We might be here because we have an enum modeled as string, + # and we try to deserialize a partial dict with enum inside + if isinstance(data, Enum): + return data + + # Consider this is real string + try: + if isinstance(data, unicode): # type: ignore + return data + except NameError: + return str(data) + return str(data) + + @staticmethod + def deserialize_enum(data, enum_obj): + """Deserialize string into enum object. + + If the string is not a valid enum value it will be returned as-is + and a warning will be logged. + + :param str data: Response string to be deserialized. If this value is + None or invalid it will be returned as-is. + :param Enum enum_obj: Enum object to deserialize to. + :return: Deserialized enum object. + :rtype: Enum + """ + if isinstance(data, enum_obj) or data is None: + return data + if isinstance(data, Enum): + data = data.value + if isinstance(data, int): + # Workaround. We might consider remove it in the future. + try: + return list(enum_obj.__members__.values())[data] + except IndexError as exc: + error = "{!r} is not a valid index for enum {!r}" + raise DeserializationError(error.format(data, enum_obj)) from exc + try: + return enum_obj(str(data)) + except ValueError: + for enum_value in enum_obj: + if enum_value.value.lower() == str(data).lower(): + return enum_value + # We don't fail anymore for unknown value, we deserialize as a string + _LOGGER.warning("Deserializer is not able to find %s as valid enum in %s", data, enum_obj) + return Deserializer.deserialize_unicode(data) + + @staticmethod + def deserialize_bytearray(attr): + """Deserialize string into bytearray. + + :param str attr: response string to be deserialized. + :return: Deserialized bytearray + :rtype: bytearray + :raises TypeError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return bytearray(b64decode(attr)) # type: ignore + + @staticmethod + def deserialize_base64(attr): + """Deserialize base64 encoded string into string. + + :param str attr: response string to be deserialized. + :return: Deserialized base64 string + :rtype: bytearray + :raises TypeError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return b64decode(encoded) + + @staticmethod + def deserialize_decimal(attr): + """Deserialize string into Decimal object. + + :param str attr: response string to be deserialized. + :return: Deserialized decimal + :raises DeserializationError: if string format invalid. + :rtype: decimal + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + return decimal.Decimal(str(attr)) # type: ignore + except decimal.DecimalException as err: + msg = "Invalid decimal {}".format(attr) + raise DeserializationError(msg) from err + + @staticmethod + def deserialize_long(attr): + """Deserialize string into long (Py2) or int (Py3). + + :param str attr: response string to be deserialized. + :return: Deserialized int + :rtype: long or int + :raises ValueError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return _long_type(attr) # type: ignore + + @staticmethod + def deserialize_duration(attr): + """Deserialize ISO-8601 formatted string into TimeDelta object. + + :param str attr: response string to be deserialized. + :return: Deserialized duration + :rtype: TimeDelta + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + duration = isodate.parse_duration(attr) + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize duration object." + raise DeserializationError(msg) from err + return duration + + @staticmethod + def deserialize_date(attr): + """Deserialize ISO-8601 formatted string into Date object. + + :param str attr: response string to be deserialized. + :return: Deserialized date + :rtype: Date + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + return isodate.parse_date(attr, defaultmonth=0, defaultday=0) + + @staticmethod + def deserialize_time(attr): + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :return: Deserialized time + :rtype: datetime.time + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + return isodate.parse_time(attr) + + @staticmethod + def deserialize_rfc(attr): + """Deserialize RFC-1123 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :return: Deserialized RFC datetime + :rtype: Datetime + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + parsed_date = email.utils.parsedate_tz(attr) # type: ignore + date_obj = datetime.datetime( + *parsed_date[:6], tzinfo=datetime.timezone(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60)) + ) + if not date_obj.tzinfo: + date_obj = date_obj.astimezone(tz=TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to rfc datetime object." + raise DeserializationError(msg) from err + return date_obj + + @staticmethod + def deserialize_iso(attr): + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :return: Deserialized ISO datetime + :rtype: Datetime + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + attr = attr.upper() # type: ignore + match = Deserializer.valid_date.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize datetime object." + raise DeserializationError(msg) from err + return date_obj + + @staticmethod + def deserialize_unix(attr): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param int attr: Object to be serialized. + :return: Deserialized datetime + :rtype: Datetime + :raises DeserializationError: if format invalid + """ + if isinstance(attr, ET.Element): + attr = int(attr.text) # type: ignore + try: + attr = int(attr) + date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to unix datetime object." + raise DeserializationError(msg) from err + return date_obj diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_utils/utils.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_utils/utils.py new file mode 100644 index 000000000000..35c9c836f85f --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_utils/utils.py @@ -0,0 +1,25 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +from typing import Generic, TYPE_CHECKING, TypeVar + +if TYPE_CHECKING: + from .serialization import Deserializer, Serializer + + +TClient = TypeVar("TClient") +TConfig = TypeVar("TConfig") + + +class ClientMixinABC(ABC, Generic[TClient, TConfig]): + """DO NOT use this class. It is for internal typing use only.""" + + _client: TClient + _config: TConfig + _serialize: "Serializer" + _deserialize: "Deserializer" diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_version.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_version.py new file mode 100644 index 000000000000..be71c81bd282 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/_version.py @@ -0,0 +1,9 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +VERSION = "1.0.0b1" diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/__init__.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/__init__.py new file mode 100644 index 000000000000..4cc6753fa7e3 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/__init__.py @@ -0,0 +1,29 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._client import MonitorQueryMetricsClient # type: ignore + +try: + from ._patch import __all__ as _patch_all + from ._patch import * +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "MonitorQueryMetricsClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore + +_patch_sdk() diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_client.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_client.py new file mode 100644 index 000000000000..8be5ee8993c8 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_client.py @@ -0,0 +1,104 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, Awaitable, TYPE_CHECKING +from typing_extensions import Self + +from azure.core import AsyncPipelineClient +from azure.core.pipeline import policies +from azure.core.rest import AsyncHttpResponse, HttpRequest + +from .._utils.serialization import Deserializer, Serializer +from ._configuration import MonitorQueryMetricsClientConfiguration +from ._operations._operations import _MonitorQueryMetricsClientOperationsMixin + +if TYPE_CHECKING: + from azure.core.credentials_async import AsyncTokenCredential + + +class MonitorQueryMetricsClient(_MonitorQueryMetricsClientOperationsMixin): + """MonitorQueryMetricsClient. + + :param endpoint: The regional endpoint to use, for example + `https://eastus.metrics.monitor.azure.com `_. The + region should match + the region of the requested resources. For global resources, the region should be 'global'. + Required. + :type endpoint: str + :param credential: Credential used to authenticate requests to the service. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + :keyword api_version: The API version to use for this operation. Default value is "2024-02-01". + Note that overriding this default value may result in unsupported behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: + _endpoint = "{endpoint}" + self._config = MonitorQueryMetricsClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + 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: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + def send_request( + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = await client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.AsyncHttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + async def close(self) -> None: + await self._client.close() + + async def __aenter__(self) -> Self: + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details: Any) -> None: + await self._client.__aexit__(*exc_details) diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_configuration.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_configuration.py new file mode 100644 index 000000000000..8f9aa2c0f2ec --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_configuration.py @@ -0,0 +1,67 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, TYPE_CHECKING + +from azure.core.pipeline import policies + +from .._version import VERSION + +if TYPE_CHECKING: + from azure.core.credentials_async import AsyncTokenCredential + + +class MonitorQueryMetricsClientConfiguration: # pylint: disable=too-many-instance-attributes + """Configuration for MonitorQueryMetricsClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: The regional endpoint to use, for example + `https://eastus.metrics.monitor.azure.com `_. The + region should match + the region of the requested resources. For global resources, the region should be 'global'. + Required. + :type endpoint: str + :param credential: Credential used to authenticate requests to the service. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + :keyword api_version: The API version to use for this operation. Default value is "2024-02-01". + Note that overriding this default value may result in unsupported behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2024-02-01") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://metrics.monitor.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "monitor-querymetrics/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**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 = policies.AsyncBearerTokenCredentialPolicy( + self.credential, *self.credential_scopes, **kwargs + ) diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_operations/__init__.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_operations/__init__.py new file mode 100644 index 000000000000..933fcd7d1b55 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_operations/__init__.py @@ -0,0 +1,22 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + + +from ._patch import __all__ as _patch_all +from ._patch import * +from ._patch import patch_sdk as _patch_sdk + +__all__ = [] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore +_patch_sdk() diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_operations/_operations.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_operations/_operations.py new file mode 100644 index 000000000000..ae996ddbd1bc --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_operations/_operations.py @@ -0,0 +1,423 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from collections.abc import MutableMapping +from io import IOBase +import json +from typing import Any, Callable, Dict, IO, List, Optional, TypeVar, Union, overload + +from azure.core import AsyncPipelineClient +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + StreamClosedError, + StreamConsumedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.rest import AsyncHttpResponse, HttpRequest +from azure.core.tracing.decorator_async import distributed_trace_async +from azure.core.utils import case_insensitive_dict + +from ... import models as _models +from ..._operations._operations import build_monitor_query_metrics_query_resources_request +from ..._utils.model_base import SdkJSONEncoder, _deserialize, _failsafe_deserialize +from ..._utils.utils import ClientMixinABC +from .._configuration import MonitorQueryMetricsClientConfiguration + +JSON = MutableMapping[str, Any] +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] + + +class _MonitorQueryMetricsClientOperationsMixin( + ClientMixinABC[AsyncPipelineClient[HttpRequest, AsyncHttpResponse], MonitorQueryMetricsClientConfiguration] +): + + @overload + async def query_resources( + self, + subscription_id: str, + batch_request: _models.ResourceIdList, + *, + metric_namespace: str, + metric_names: List[str], + start_time: Optional[str] = None, + end_time: Optional[str] = None, + interval: Optional[str] = None, + aggregation: Optional[str] = None, + top: Optional[int] = None, + order_by: Optional[str] = None, + filter: Optional[str] = None, + roll_up_by: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.MetricResultsResponse: + """Lists the metric values for multiple resources. + + :param subscription_id: The subscription identifier for the resources in this batch. Required. + :type subscription_id: str + :param batch_request: Metrics batch body including the list of resource ids. Required. + :type batch_request: ~azure.monitor.querymetrics._generated.models.ResourceIdList + :keyword metric_namespace: Metric namespace that contains the requested metric names. Required. + :paramtype metric_namespace: str + :keyword metric_names: The names of the metrics (comma separated) to retrieve. Required. + :paramtype metric_names: list[str] + :keyword start_time: The start time of the query. It is a string in the format + 'yyyy-MM-ddTHH:mm:ss.fffZ'. If you have specified the endtime parameter, then + this parameter is required. + If only starttime is specified, then endtime defaults to the current time. + If no time interval is specified, the default is 1 hour. Default value is None. + :paramtype start_time: str + :keyword end_time: The end time of the query. It is a string in the format + 'yyyy-MM-ddTHH:mm:ss.fffZ'. Default value is None. + :paramtype end_time: str + :keyword interval: The interval (i.e. timegrain) of the query in ISO 8601 duration format. + Defaults to PT1M. Special case for 'FULL' value that returns single datapoint + for entire time span requested. + *Examples: PT15M, PT1H, P1D, FULL*. Default value is None. + :paramtype interval: str + :keyword aggregation: The list of aggregation types (comma separated) to retrieve. *Examples: + average, minimum, maximum*. Default value is None. + :paramtype aggregation: str + :keyword top: The maximum number of records to retrieve per resource ID in the request. + Valid only if filter is specified. + Defaults to 10. Default value is None. + :paramtype top: int + :keyword order_by: The aggregation to use for sorting results and the direction of the sort. + Only one order can be specified. + *Examples: sum asc*. Default value is None. + :paramtype order_by: str + :keyword filter: The filter is used to reduce the set of metric data + returned.
Example:
Metric contains metadata A, B and C.
- Return all + time series of C where A = a1 and B = b1 or b2
**filter=A eq ‘a1’ and B eq + ‘b1’ or B eq ‘b2’ and C eq ‘*’**
- Invalid variant:
**filter=A eq ‘a1’ + and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’**
This is invalid because the logical + or operator cannot separate two different metadata names.
- Return all time + series where A = a1, B = b1 and C = c1:
**filter=A eq ‘a1’ and B eq ‘b1’ and + C eq ‘c1’**
- Return all time series where A = a1
**filter=A eq ‘a1’ and + B eq ‘*’ and C eq ‘*’**. Default value is None. + :paramtype filter: str + :keyword roll_up_by: Dimension name(s) to rollup results by. For example if you only want to + see + metric values with a filter like 'City eq Seattle or City eq Tacoma' but don't + want to see separate values for each city, you can specify 'RollUpBy=City' to + see the results for Seattle and Tacoma rolled up into one timeseries. Default value is None. + :paramtype roll_up_by: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: MetricResultsResponse. The MetricResultsResponse is compatible with MutableMapping + :rtype: ~azure.monitor.querymetrics._generated.models.MetricResultsResponse + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def query_resources( + self, + subscription_id: str, + batch_request: JSON, + *, + metric_namespace: str, + metric_names: List[str], + start_time: Optional[str] = None, + end_time: Optional[str] = None, + interval: Optional[str] = None, + aggregation: Optional[str] = None, + top: Optional[int] = None, + order_by: Optional[str] = None, + filter: Optional[str] = None, + roll_up_by: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.MetricResultsResponse: + """Lists the metric values for multiple resources. + + :param subscription_id: The subscription identifier for the resources in this batch. Required. + :type subscription_id: str + :param batch_request: Metrics batch body including the list of resource ids. Required. + :type batch_request: JSON + :keyword metric_namespace: Metric namespace that contains the requested metric names. Required. + :paramtype metric_namespace: str + :keyword metric_names: The names of the metrics (comma separated) to retrieve. Required. + :paramtype metric_names: list[str] + :keyword start_time: The start time of the query. It is a string in the format + 'yyyy-MM-ddTHH:mm:ss.fffZ'. If you have specified the endtime parameter, then + this parameter is required. + If only starttime is specified, then endtime defaults to the current time. + If no time interval is specified, the default is 1 hour. Default value is None. + :paramtype start_time: str + :keyword end_time: The end time of the query. It is a string in the format + 'yyyy-MM-ddTHH:mm:ss.fffZ'. Default value is None. + :paramtype end_time: str + :keyword interval: The interval (i.e. timegrain) of the query in ISO 8601 duration format. + Defaults to PT1M. Special case for 'FULL' value that returns single datapoint + for entire time span requested. + *Examples: PT15M, PT1H, P1D, FULL*. Default value is None. + :paramtype interval: str + :keyword aggregation: The list of aggregation types (comma separated) to retrieve. *Examples: + average, minimum, maximum*. Default value is None. + :paramtype aggregation: str + :keyword top: The maximum number of records to retrieve per resource ID in the request. + Valid only if filter is specified. + Defaults to 10. Default value is None. + :paramtype top: int + :keyword order_by: The aggregation to use for sorting results and the direction of the sort. + Only one order can be specified. + *Examples: sum asc*. Default value is None. + :paramtype order_by: str + :keyword filter: The filter is used to reduce the set of metric data + returned.
Example:
Metric contains metadata A, B and C.
- Return all + time series of C where A = a1 and B = b1 or b2
**filter=A eq ‘a1’ and B eq + ‘b1’ or B eq ‘b2’ and C eq ‘*’**
- Invalid variant:
**filter=A eq ‘a1’ + and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’**
This is invalid because the logical + or operator cannot separate two different metadata names.
- Return all time + series where A = a1, B = b1 and C = c1:
**filter=A eq ‘a1’ and B eq ‘b1’ and + C eq ‘c1’**
- Return all time series where A = a1
**filter=A eq ‘a1’ and + B eq ‘*’ and C eq ‘*’**. Default value is None. + :paramtype filter: str + :keyword roll_up_by: Dimension name(s) to rollup results by. For example if you only want to + see + metric values with a filter like 'City eq Seattle or City eq Tacoma' but don't + want to see separate values for each city, you can specify 'RollUpBy=City' to + see the results for Seattle and Tacoma rolled up into one timeseries. Default value is None. + :paramtype roll_up_by: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: MetricResultsResponse. The MetricResultsResponse is compatible with MutableMapping + :rtype: ~azure.monitor.querymetrics._generated.models.MetricResultsResponse + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def query_resources( + self, + subscription_id: str, + batch_request: IO[bytes], + *, + metric_namespace: str, + metric_names: List[str], + start_time: Optional[str] = None, + end_time: Optional[str] = None, + interval: Optional[str] = None, + aggregation: Optional[str] = None, + top: Optional[int] = None, + order_by: Optional[str] = None, + filter: Optional[str] = None, + roll_up_by: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.MetricResultsResponse: + """Lists the metric values for multiple resources. + + :param subscription_id: The subscription identifier for the resources in this batch. Required. + :type subscription_id: str + :param batch_request: Metrics batch body including the list of resource ids. Required. + :type batch_request: IO[bytes] + :keyword metric_namespace: Metric namespace that contains the requested metric names. Required. + :paramtype metric_namespace: str + :keyword metric_names: The names of the metrics (comma separated) to retrieve. Required. + :paramtype metric_names: list[str] + :keyword start_time: The start time of the query. It is a string in the format + 'yyyy-MM-ddTHH:mm:ss.fffZ'. If you have specified the endtime parameter, then + this parameter is required. + If only starttime is specified, then endtime defaults to the current time. + If no time interval is specified, the default is 1 hour. Default value is None. + :paramtype start_time: str + :keyword end_time: The end time of the query. It is a string in the format + 'yyyy-MM-ddTHH:mm:ss.fffZ'. Default value is None. + :paramtype end_time: str + :keyword interval: The interval (i.e. timegrain) of the query in ISO 8601 duration format. + Defaults to PT1M. Special case for 'FULL' value that returns single datapoint + for entire time span requested. + *Examples: PT15M, PT1H, P1D, FULL*. Default value is None. + :paramtype interval: str + :keyword aggregation: The list of aggregation types (comma separated) to retrieve. *Examples: + average, minimum, maximum*. Default value is None. + :paramtype aggregation: str + :keyword top: The maximum number of records to retrieve per resource ID in the request. + Valid only if filter is specified. + Defaults to 10. Default value is None. + :paramtype top: int + :keyword order_by: The aggregation to use for sorting results and the direction of the sort. + Only one order can be specified. + *Examples: sum asc*. Default value is None. + :paramtype order_by: str + :keyword filter: The filter is used to reduce the set of metric data + returned.
Example:
Metric contains metadata A, B and C.
- Return all + time series of C where A = a1 and B = b1 or b2
**filter=A eq ‘a1’ and B eq + ‘b1’ or B eq ‘b2’ and C eq ‘*’**
- Invalid variant:
**filter=A eq ‘a1’ + and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’**
This is invalid because the logical + or operator cannot separate two different metadata names.
- Return all time + series where A = a1, B = b1 and C = c1:
**filter=A eq ‘a1’ and B eq ‘b1’ and + C eq ‘c1’**
- Return all time series where A = a1
**filter=A eq ‘a1’ and + B eq ‘*’ and C eq ‘*’**. Default value is None. + :paramtype filter: str + :keyword roll_up_by: Dimension name(s) to rollup results by. For example if you only want to + see + metric values with a filter like 'City eq Seattle or City eq Tacoma' but don't + want to see separate values for each city, you can specify 'RollUpBy=City' to + see the results for Seattle and Tacoma rolled up into one timeseries. Default value is None. + :paramtype roll_up_by: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: MetricResultsResponse. The MetricResultsResponse is compatible with MutableMapping + :rtype: ~azure.monitor.querymetrics._generated.models.MetricResultsResponse + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def query_resources( + self, + subscription_id: str, + batch_request: Union[_models.ResourceIdList, JSON, IO[bytes]], + *, + metric_namespace: str, + metric_names: List[str], + start_time: Optional[str] = None, + end_time: Optional[str] = None, + interval: Optional[str] = None, + aggregation: Optional[str] = None, + top: Optional[int] = None, + order_by: Optional[str] = None, + filter: Optional[str] = None, + roll_up_by: Optional[str] = None, + **kwargs: Any + ) -> _models.MetricResultsResponse: + """Lists the metric values for multiple resources. + + :param subscription_id: The subscription identifier for the resources in this batch. Required. + :type subscription_id: str + :param batch_request: Metrics batch body including the list of resource ids. Is one of the + following types: ResourceIdList, JSON, IO[bytes] Required. + :type batch_request: ~azure.monitor.querymetrics._generated.models.ResourceIdList or JSON or + IO[bytes] + :keyword metric_namespace: Metric namespace that contains the requested metric names. Required. + :paramtype metric_namespace: str + :keyword metric_names: The names of the metrics (comma separated) to retrieve. Required. + :paramtype metric_names: list[str] + :keyword start_time: The start time of the query. It is a string in the format + 'yyyy-MM-ddTHH:mm:ss.fffZ'. If you have specified the endtime parameter, then + this parameter is required. + If only starttime is specified, then endtime defaults to the current time. + If no time interval is specified, the default is 1 hour. Default value is None. + :paramtype start_time: str + :keyword end_time: The end time of the query. It is a string in the format + 'yyyy-MM-ddTHH:mm:ss.fffZ'. Default value is None. + :paramtype end_time: str + :keyword interval: The interval (i.e. timegrain) of the query in ISO 8601 duration format. + Defaults to PT1M. Special case for 'FULL' value that returns single datapoint + for entire time span requested. + *Examples: PT15M, PT1H, P1D, FULL*. Default value is None. + :paramtype interval: str + :keyword aggregation: The list of aggregation types (comma separated) to retrieve. *Examples: + average, minimum, maximum*. Default value is None. + :paramtype aggregation: str + :keyword top: The maximum number of records to retrieve per resource ID in the request. + Valid only if filter is specified. + Defaults to 10. Default value is None. + :paramtype top: int + :keyword order_by: The aggregation to use for sorting results and the direction of the sort. + Only one order can be specified. + *Examples: sum asc*. Default value is None. + :paramtype order_by: str + :keyword filter: The filter is used to reduce the set of metric data + returned.
Example:
Metric contains metadata A, B and C.
- Return all + time series of C where A = a1 and B = b1 or b2
**filter=A eq ‘a1’ and B eq + ‘b1’ or B eq ‘b2’ and C eq ‘*’**
- Invalid variant:
**filter=A eq ‘a1’ + and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’**
This is invalid because the logical + or operator cannot separate two different metadata names.
- Return all time + series where A = a1, B = b1 and C = c1:
**filter=A eq ‘a1’ and B eq ‘b1’ and + C eq ‘c1’**
- Return all time series where A = a1
**filter=A eq ‘a1’ and + B eq ‘*’ and C eq ‘*’**. Default value is None. + :paramtype filter: str + :keyword roll_up_by: Dimension name(s) to rollup results by. For example if you only want to + see + metric values with a filter like 'City eq Seattle or City eq Tacoma' but don't + want to see separate values for each city, you can specify 'RollUpBy=City' to + see the results for Seattle and Tacoma rolled up into one timeseries. Default value is None. + :paramtype roll_up_by: str + :return: MetricResultsResponse. The MetricResultsResponse is compatible with MutableMapping + :rtype: ~azure.monitor.querymetrics._generated.models.MetricResultsResponse + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + cls: ClsType[_models.MetricResultsResponse] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(batch_request, (IOBase, bytes)): + _content = batch_request + else: + _content = json.dumps(batch_request, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_monitor_query_metrics_query_resources_request( + subscription_id=subscription_id, + metric_namespace=metric_namespace, + metric_names=metric_names, + start_time=start_time, + end_time=end_time, + interval=interval, + aggregation=aggregation, + top=top, + order_by=order_by, + filter=filter, + roll_up_by=roll_up_by, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _failsafe_deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.MetricResultsResponse, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_operations/_patch.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_operations/_patch.py new file mode 100644 index 000000000000..8bcb627aa475 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_operations/_patch.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_patch.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_patch.py new file mode 100644 index 000000000000..8bcb627aa475 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/aio/_patch.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/models/__init__.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/models/__init__.py new file mode 100644 index 000000000000..5dde9fd6872b --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/models/__init__.py @@ -0,0 +1,52 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + + +from ._models import ( # type: ignore + ErrorAdditionalInfo, + ErrorDetail, + ErrorResponse, + LocalizableString, + MetadataValue, + Metric, + MetricResultsResponse, + MetricResultsResponseValuesItem, + MetricValue, + ResourceIdList, + TimeSeriesElement, +) + +from ._enums import ( # type: ignore + MetricUnit, +) +from ._patch import __all__ as _patch_all +from ._patch import * +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "ErrorAdditionalInfo", + "ErrorDetail", + "ErrorResponse", + "LocalizableString", + "MetadataValue", + "Metric", + "MetricResultsResponse", + "MetricResultsResponseValuesItem", + "MetricValue", + "ResourceIdList", + "TimeSeriesElement", + "MetricUnit", +] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore +_patch_sdk() diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/models/_enums.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/models/_enums.py new file mode 100644 index 000000000000..ef6a54e94943 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/models/_enums.py @@ -0,0 +1,42 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from enum import Enum +from azure.core import CaseInsensitiveEnumMeta + + +class MetricUnit(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The unit of the metric.""" + + COUNT = "Count" + """Unit of raw quantity.""" + BYTES = "Bytes" + """Unit of memory in bytes.""" + SECONDS = "Seconds" + """Unit of time in seconds.""" + COUNT_PER_SECOND = "CountPerSecond" + """Rate unit of raw quantity per second.""" + BYTES_PER_SECOND = "BytesPerSecond" + """Rate unit of memory in bytes per second.""" + PERCENT = "Percent" + """Percentage unit.""" + MILLI_SECONDS = "MilliSeconds" + """Unit of time in 1/1000th of a second.""" + BYTE_SECONDS = "ByteSeconds" + """Unit of data transfer or storage. It is the size of the data in bytes + multiplied by the time it takes to transfer or store the data in seconds.""" + UNSPECIFIED = "Unspecified" + """No specified unit.""" + CORES = "Cores" + """Unit of processing power.""" + MILLI_CORES = "MilliCores" + """Unit of processing power in 1/1000th of a CPU core.""" + NANO_CORES = "NanoCores" + """Unit of processing power in one billionth of a CPU core.""" + BITS_PER_SECOND = "BitsPerSecond" + """Rate unit of binary digits per second.""" diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/models/_models.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/models/_models.py new file mode 100644 index 000000000000..017c0dacae6d --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/models/_models.py @@ -0,0 +1,452 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=useless-super-delegation + +import datetime +from typing import Any, List, Mapping, Optional, TYPE_CHECKING, Union, overload + +from .._utils.model_base import Model as _Model, rest_field + +if TYPE_CHECKING: + from .. import models as _models + + +class ErrorAdditionalInfo(_Model): + """The resource management error additional info. + + :ivar type: The additional info type. + :vartype type: str + :ivar info: The additional info. + :vartype info: any + """ + + type: Optional[str] = rest_field(visibility=["read"]) + """The additional info type.""" + info: Optional[Any] = rest_field(visibility=["read"]) + """The additional info.""" + + +class ErrorDetail(_Model): + """The error detail. + + :ivar code: The error code. + :vartype code: str + :ivar message: The error message. + :vartype message: str + :ivar target: The error target. + :vartype target: str + :ivar details: The error details. + :vartype details: list[~azure.monitor.querymetrics._generated.models.ErrorDetail] + :ivar additional_info: The error additional info. + :vartype additional_info: + list[~azure.monitor.querymetrics._generated.models.ErrorAdditionalInfo] + """ + + code: Optional[str] = rest_field(visibility=["read"]) + """The error code.""" + message: Optional[str] = rest_field(visibility=["read"]) + """The error message.""" + target: Optional[str] = rest_field(visibility=["read"]) + """The error target.""" + details: Optional[List["_models.ErrorDetail"]] = rest_field(visibility=["read"]) + """The error details.""" + additional_info: Optional[List["_models.ErrorAdditionalInfo"]] = rest_field( + name="additionalInfo", visibility=["read"] + ) + """The error additional info.""" + + +class ErrorResponse(_Model): + """Error response. + + :ivar error: The error object. + :vartype error: ~azure.monitor.querymetrics._generated.models.ErrorDetail + """ + + error: Optional["_models.ErrorDetail"] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The error object.""" + + @overload + def __init__( + self, + *, + error: Optional["_models.ErrorDetail"] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class LocalizableString(_Model): + """The localizable string class. + + :ivar value: The invariant value. Required. + :vartype value: str + :ivar localized_value: The display name. + :vartype localized_value: str + """ + + value: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The invariant value. Required.""" + localized_value: Optional[str] = rest_field( + name="localizedValue", visibility=["read", "create", "update", "delete", "query"] + ) + """The display name.""" + + @overload + def __init__( + self, + *, + value: str, + localized_value: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class MetadataValue(_Model): + """Represents a metric metadata value. + + :ivar name: The name of the metadata. + :vartype name: ~azure.monitor.querymetrics._generated.models.LocalizableString + :ivar value: The value of the metadata. + :vartype value: str + """ + + name: Optional["_models.LocalizableString"] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The name of the metadata.""" + value: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The value of the metadata.""" + + @overload + def __init__( + self, + *, + name: Optional["_models.LocalizableString"] = None, + value: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class Metric(_Model): + """The result data of a query. + + :ivar id: The metric Id. Required. + :vartype id: str + :ivar type: The resource type of the metric resource. Required. + :vartype type: str + :ivar name: The name and the display name of the metric, i.e. it is localizable string. + Required. + :vartype name: ~azure.monitor.querymetrics._generated.models.LocalizableString + :ivar display_description: Detailed description of this metric. + :vartype display_description: str + :ivar error_code: 'Success' or the error details on query failures for this metric. + :vartype error_code: str + :ivar error_message: Error message encountered querying this specific metric. + :vartype error_message: str + :ivar unit: The unit of the metric. Required. Known values are: "Count", "Bytes", "Seconds", + "CountPerSecond", "BytesPerSecond", "Percent", "MilliSeconds", "ByteSeconds", "Unspecified", + "Cores", "MilliCores", "NanoCores", and "BitsPerSecond". + :vartype unit: str or ~azure.monitor.querymetrics._generated.models.MetricUnit + :ivar timeseries: The time series returned when a data query is performed. Required. + :vartype timeseries: list[~azure.monitor.querymetrics._generated.models.TimeSeriesElement] + """ + + id: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The metric Id. Required.""" + type: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The resource type of the metric resource. Required.""" + name: "_models.LocalizableString" = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The name and the display name of the metric, i.e. it is localizable string. Required.""" + display_description: Optional[str] = rest_field( + name="displayDescription", visibility=["read", "create", "update", "delete", "query"] + ) + """Detailed description of this metric.""" + error_code: Optional[str] = rest_field(name="errorCode", visibility=["read", "create", "update", "delete", "query"]) + """'Success' or the error details on query failures for this metric.""" + error_message: Optional[str] = rest_field( + name="errorMessage", visibility=["read", "create", "update", "delete", "query"] + ) + """Error message encountered querying this specific metric.""" + unit: Union[str, "_models.MetricUnit"] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The unit of the metric. Required. Known values are: \"Count\", \"Bytes\", \"Seconds\", + \"CountPerSecond\", \"BytesPerSecond\", \"Percent\", \"MilliSeconds\", \"ByteSeconds\", + \"Unspecified\", \"Cores\", \"MilliCores\", \"NanoCores\", and \"BitsPerSecond\".""" + timeseries: List["_models.TimeSeriesElement"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """The time series returned when a data query is performed. Required.""" + + @overload + def __init__( + self, + *, + id: str, # pylint: disable=redefined-builtin + type: str, + name: "_models.LocalizableString", + unit: Union[str, "_models.MetricUnit"], + timeseries: List["_models.TimeSeriesElement"], + display_description: Optional[str] = None, + error_code: Optional[str] = None, + error_message: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class MetricResultsResponse(_Model): + """The metrics result for a resource. + + :ivar values_property: The collection of metric data responses per resource, per metric. + :vartype values_property: + list[~azure.monitor.querymetrics._generated.models.MetricResultsResponseValuesItem] + """ + + values_property: Optional[List["_models.MetricResultsResponseValuesItem"]] = rest_field( + name="values", visibility=["read", "create", "update", "delete", "query"] + ) + """The collection of metric data responses per resource, per metric.""" + + @overload + def __init__( + self, + *, + values_property: Optional[List["_models.MetricResultsResponseValuesItem"]] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class MetricResultsResponseValuesItem(_Model): + """The metric data response for a resource. + + :ivar starttime: The start time, in datetime format, for which the data was retrieved. + Required. + :vartype starttime: str + :ivar endtime: The end time, in datetime format, for which the data was retrieved. Required. + :vartype endtime: str + :ivar interval: The interval (window size) for which the metric data was returned in ISO 8601 + duration format with a special case for 'FULL' value that returns single + datapoint for entire time span requested (*Examples: PT15M, PT1H, P1D, FULL*). + This may be adjusted and different from what was originally requested if + AutoAdjustTimegrain=true is specified. + :vartype interval: str + :ivar namespace: The namespace of the metrics been queried. + :vartype namespace: str + :ivar resourceregion: The region of the resource been queried for metrics. + :vartype resourceregion: str + :ivar resourceid: The resource that has been queried for metrics. + :vartype resourceid: str + :ivar value: The value of the collection. Required. + :vartype value: list[~azure.monitor.querymetrics._generated.models.Metric] + """ + + starttime: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The start time, in datetime format, for which the data was retrieved. Required.""" + endtime: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The end time, in datetime format, for which the data was retrieved. Required.""" + interval: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The interval (window size) for which the metric data was returned in ISO 8601 + duration format with a special case for 'FULL' value that returns single + datapoint for entire time span requested (*Examples: PT15M, PT1H, P1D, FULL*). + This may be adjusted and different from what was originally requested if + AutoAdjustTimegrain=true is specified.""" + namespace: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The namespace of the metrics been queried.""" + resourceregion: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The region of the resource been queried for metrics.""" + resourceid: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The resource that has been queried for metrics.""" + value: List["_models.Metric"] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The value of the collection. Required.""" + + @overload + def __init__( + self, + *, + starttime: str, + endtime: str, + value: List["_models.Metric"], + interval: Optional[str] = None, + namespace: Optional[str] = None, + resourceregion: Optional[str] = None, + resourceid: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class MetricValue(_Model): + """Represents a metric value. + + :ivar time_stamp: The timestamp for the metric value in ISO 8601 format. Required. + :vartype time_stamp: ~datetime.datetime + :ivar average: The average value in the time range. + :vartype average: float + :ivar minimum: The least value in the time range. + :vartype minimum: float + :ivar maximum: The greatest value in the time range. + :vartype maximum: float + :ivar total: The sum of all of the values in the time range. + :vartype total: float + :ivar count: The number of samples in the time range. Can be used to determine the number of + values that contributed to the average value. + :vartype count: float + """ + + time_stamp: datetime.datetime = rest_field( + name="timeStamp", visibility=["read", "create", "update", "delete", "query"], format="rfc3339" + ) + """The timestamp for the metric value in ISO 8601 format. Required.""" + average: Optional[float] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The average value in the time range.""" + minimum: Optional[float] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The least value in the time range.""" + maximum: Optional[float] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The greatest value in the time range.""" + total: Optional[float] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The sum of all of the values in the time range.""" + count: Optional[float] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The number of samples in the time range. Can be used to determine the number of + values that contributed to the average value.""" + + @overload + def __init__( + self, + *, + time_stamp: datetime.datetime, + average: Optional[float] = None, + minimum: Optional[float] = None, + maximum: Optional[float] = None, + total: Optional[float] = None, + count: Optional[float] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class ResourceIdList(_Model): + """The comma separated list of resource IDs to query metrics for. + + :ivar resourceids: The list of resource IDs to query metrics for. + :vartype resourceids: list[str] + """ + + resourceids: Optional[List[str]] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The list of resource IDs to query metrics for.""" + + @overload + def __init__( + self, + *, + resourceids: Optional[List[str]] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class TimeSeriesElement(_Model): + """A time series result type. The discriminator value is always TimeSeries in this + case. + + :ivar metadatavalues: The metadata values returned if $filter was specified in the call. + :vartype metadatavalues: list[~azure.monitor.querymetrics._generated.models.MetadataValue] + :ivar data: An array of data points representing the metric values. This is only returned + if a result type of data is specified. + :vartype data: list[~azure.monitor.querymetrics._generated.models.MetricValue] + """ + + metadatavalues: Optional[List["_models.MetadataValue"]] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """The metadata values returned if $filter was specified in the call.""" + data: Optional[List["_models.MetricValue"]] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """An array of data points representing the metric values. This is only returned + if a result type of data is specified.""" + + @overload + def __init__( + self, + *, + metadatavalues: Optional[List["_models.MetadataValue"]] = None, + data: Optional[List["_models.MetricValue"]] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/models/_patch.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/models/_patch.py new file mode 100644 index 000000000000..8bcb627aa475 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/models/_patch.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/py.typed b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/py.typed new file mode 100644 index 000000000000..e5aff4f83af8 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_generated/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_models.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_models.py new file mode 100644 index 000000000000..dc5ae0095c00 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_models.py @@ -0,0 +1,196 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +# cspell:ignore milli +from collections.abc import Mapping +from datetime import datetime, timedelta +from typing import Any, Optional, List, Dict + +from ._generated._utils.serialization import Deserializer + + +JSON = Mapping[str, Any] + + +class MetricValue: + """Represents a metric value.""" + + timestamp: datetime + """The timestamp for the metric value.""" + average: Optional[float] = None + """The average value in the time range.""" + minimum: Optional[float] = None + """The least value in the time range.""" + maximum: Optional[float] = None + """The greatest value in the time range.""" + total: Optional[float] = None + """The sum of all of the values in the time range.""" + count: Optional[float] = None + """The number of samples in the time range. Can be used to determine the number of values that + contributed to the average value.""" + + def __init__(self, **kwargs: Any) -> None: + self.timestamp = kwargs["timestamp"] + self.average = kwargs.get("average", None) + self.minimum = kwargs.get("minimum", None) + self.maximum = kwargs.get("maximum", None) + self.total = kwargs.get("total", None) + self.count = kwargs.get("count", None) + + @classmethod + def _from_generated(cls, generated): + if not generated: + return cls() + return cls( + timestamp=Deserializer.deserialize_iso(generated.get("timeStamp")), + average=generated.get("average"), + minimum=generated.get("minimum"), + maximum=generated.get("maximum"), + total=generated.get("total"), + count=generated.get("count"), + ) + + +class TimeSeriesElement: + """A time series result type. The discriminator value is always TimeSeries in this case.""" + + metadata_values: Dict[str, str] + """The metadata values returned if $filter was specified in the call.""" + data: List[MetricValue] + """An array of data points representing the metric values. This is only returned if a result + type of data is specified.""" + + def __init__(self, **kwargs: Any) -> None: + self.metadata_values = kwargs.get("metadata_values", {}) + self.data = kwargs.get("data", []) + + @classmethod + def _from_generated(cls, generated) -> "TimeSeriesElement": + if not generated: + return cls() + return cls( + metadata_values={obj["name"]["value"]: obj.get("value") for obj in generated.get("metadatavalues", [])}, + data=[ + MetricValue._from_generated(val) # pylint: disable=protected-access + for val in generated.get("data", []) + ], + ) + + +class Metric: + """The result data of a single metric name.""" + + id: str + """The metric ID.""" + type: str + """The resource type of the metric resource.""" + name: str + """The name of the metric.""" + unit: str + """The unit of the metric. To access these values, use the MetricUnit enum. + Possible values include "Count", "Bytes", "Seconds", "CountPerSecond", "BytesPerSecond", "Percent", + "MilliSeconds", "ByteSeconds", "Unspecified", "Cores", "MilliCores", "NanoCores", "BitsPerSecond".""" + timeseries: List[TimeSeriesElement] + """The time series returned when a data query is performed.""" + display_description: str + """Detailed description of this metric.""" + + def __init__(self, **kwargs: Any) -> None: + self.id = kwargs["id"] + self.type = kwargs["type"] + self.name = kwargs["name"] + self.unit = kwargs["unit"] + self.timeseries = kwargs["timeseries"] + self.display_description = kwargs["display_description"] + + @classmethod + def _from_generated(cls, generated) -> "Metric": + if not generated: + return cls() + return cls( + id=generated.get("id"), + type=generated.get("type"), + name=generated.get("name", {}).get("value"), + unit=generated.get("unit"), + timeseries=[ + TimeSeriesElement._from_generated(t) # pylint: disable=protected-access + for t in generated.get("timeseries", []) + ], + display_description=generated.get("displayDescription"), + ) + + +class MetricsQueryResult: + """The response to a metrics query.""" + + timespan: str + """Required. The timespan for which the data was retrieved. Its value consists of two datetimes + concatenated, separated by '/'. This may be adjusted in the future and returned back from what + was originally requested.""" + metrics: List[Metric] + """Required. The value of the collection.""" + granularity: Optional[timedelta] = None + """The granularity (window size) for which the metric data was returned in. This may be adjusted + in the future and returned back from what was originally requested. This is not present if a + metadata request was made.""" + namespace: Optional[str] = None + """The namespace of the metrics that has been queried.""" + resource_region: Optional[str] = None + """The region of the resource that has been queried for metrics.""" + cost: Optional[int] = None + """The integer value representing the cost of the query, for data case.""" + + def __init__(self, **kwargs: Any) -> None: + self.timespan = kwargs["timespan"] + self.metrics = kwargs["metrics"] + self.granularity = kwargs.get("granularity", None) + self.namespace = kwargs.get("namespace", None) + self.resource_region = kwargs.get("resource_region", None) + self.cost = kwargs.get("cost", None) + + @classmethod + def _from_generated(cls, generated) -> "MetricsQueryResult": + if not generated: + return cls() + granularity = None + if generated.get("interval"): + granularity = Deserializer.deserialize_duration(generated.get("interval")) + if not generated.get("timespan"): + generated["timespan"] = f"{generated.get('starttime')}/{generated.get('endtime')}" + return cls( + cost=generated.get("cost"), + timespan=generated.get("timespan"), + granularity=granularity, + namespace=generated.get("namespace"), + resource_region=generated.get("resourceregion"), + metrics=MetricsList( + metrics=[ + Metric._from_generated(m) for m in generated.get("value", []) # pylint: disable=protected-access + ] + ), + ) + + +class MetricsList(list): + """Custom list for metrics.""" + + def __init__(self, **kwargs: Any) -> None: + self._metrics = kwargs["metrics"] + self._metric_names = {val.name: ind for ind, val in enumerate(self._metrics)} + + def __iter__(self): + return iter(self._metrics) + + def __len__(self): + return len(self._metrics) + + def __repr__(self): + return repr(self._metrics) + + def __getitem__(self, metric): + try: + return self._metrics[metric] + except TypeError: # TypeError: list indices must be integers or slices, not str + return self._metrics[self._metric_names[metric]] diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_utils.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_utils.py new file mode 100644 index 000000000000..0862880c16a6 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_utils.py @@ -0,0 +1,73 @@ +# +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +from datetime import datetime, timedelta, timezone +from typing import Optional, Tuple, Union + +from ._generated._utils.serialization import Serializer + + +def get_timespan_iso8601_endpoints( + timespan: Optional[Union[timedelta, Tuple[datetime, timedelta], Tuple[datetime, datetime]]] = None +) -> Tuple[Optional[str], Optional[str]]: + + if not timespan: + return None, None + start, end, duration = None, None, None + + if isinstance(timespan, timedelta): + duration = timespan + else: + if isinstance(timespan[1], datetime): + start, end = timespan[0], timespan[1] + elif isinstance(timespan[1], timedelta): + start, duration = timespan[0], timespan[1] + else: + raise ValueError("Tuple must be a start datetime with a timedelta or an end datetime.") + + iso_start = None + iso_end = None + if start is not None: + iso_start = Serializer.serialize_iso(start) + if end is not None: + iso_end = Serializer.serialize_iso(end) + elif duration is not None: + iso_end = Serializer.serialize_iso(start + duration) + else: # means that an invalid value None that is provided with start_time + raise ValueError("Duration or end_time cannot be None when provided with start_time.") + else: + # Only duration was provided + if duration is None: + raise ValueError("Duration cannot be None when start_time is None.") + end = datetime.now(timezone.utc) + iso_end = Serializer.serialize_iso(end) + iso_start = Serializer.serialize_iso(end - duration) + + # In some cases with a negative timedelta, the start time will be after the end time. + if iso_start and iso_end and iso_start > iso_end: + return iso_end, iso_start + return iso_start, iso_end + + +def get_subscription_id_from_resource(resource_id: str) -> str: + """Get the subscription ID from the provided resource ID. + + The format of the resource ID is: + /subscriptions/{subscriptionId}/resourceGroups/{group}/providers/{provider}/{type}/{name} + + :param str resource_id: The resource ID to parse. + :returns: The subscription ID. + :rtype: str + """ + if not resource_id: + raise ValueError("Resource ID must not be None or empty.") + + parts = resource_id.split("subscriptions/") + if len(parts) != 2: + raise ValueError("Resource ID must contain a subscription ID.") + + subscription_id = parts[1].split("/")[0] + return subscription_id diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_version.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_version.py new file mode 100644 index 000000000000..88ed1656dc19 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_version.py @@ -0,0 +1,9 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- + +VERSION = "1.0.0" +SDK_MONIKER = f"monitor-querymetrics/{VERSION}" diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/aio/__init__.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/aio/__init__.py new file mode 100644 index 000000000000..585cf3a7ea9f --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/aio/__init__.py @@ -0,0 +1,7 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +from ._client import MetricsClient + +__all__ = ["MetricsClient"] diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/aio/_client.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/aio/_client.py new file mode 100644 index 000000000000..9bde994440ba --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/aio/_client.py @@ -0,0 +1,174 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +from datetime import timedelta, datetime +from json import loads +from typing import Any, List, MutableMapping, Sequence, Optional, Union, Tuple + +import isodate +from azure.core.credentials_async import AsyncTokenCredential +from azure.core.tracing.decorator_async import distributed_trace_async + +from .._generated.aio._client import MonitorQueryMetricsClient +from .._models import MetricsQueryResult +from .._enums import MetricAggregationType +from .._utils import get_timespan_iso8601_endpoints, get_subscription_id_from_resource +from .._version import SDK_MONIKER + +JSON = MutableMapping[str, Any] + + +class MetricsClient: # pylint: disable=client-accepts-api-version-keyword + """MetricsClient should be used for performing metrics queries on multiple monitored resources in the + same region. A credential with authorization at the subscription level is required when using this client. + + :param str endpoint: The regional endpoint to use, for example + https://eastus.metrics.monitor.azure.com. The region should match the region of the requested + resources. For global resources, the region should be 'global'. Required. + :param credential: The credential to authenticate the client. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + :keyword str audience: The audience to use when requesting tokens for Microsoft Entra ID. Defaults to the public + cloud audience (https://metrics.monitor.azure.com). + :keyword api_version: The API version to use for this operation. Default value is "2024-02-01". + Note that overriding this default value may result in unsupported behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: AsyncTokenCredential, **kwargs: Any) -> None: + self._endpoint = endpoint + if not self._endpoint.startswith("https://") and not self._endpoint.startswith("http://"): + self._endpoint = "https://" + self._endpoint + audience = kwargs.pop("audience", "https://metrics.monitor.azure.com") + scope = audience.rstrip("/") + "/.default" + credential_scopes = kwargs.pop("credential_scopes", [scope]) + + kwargs.setdefault("sdk_moniker", SDK_MONIKER) + self._client = MonitorQueryMetricsClient( + credential=credential, endpoint=self._endpoint, credential_scopes=credential_scopes, **kwargs + ) + + @distributed_trace_async + async def query_resources( + self, + *, + resource_ids: Sequence[str], + metric_namespace: str, + metric_names: Sequence[str], + timespan: Optional[Union[timedelta, Tuple[datetime, timedelta], Tuple[datetime, datetime]]] = None, + granularity: Optional[timedelta] = None, + aggregations: Optional[Sequence[Union[MetricAggregationType, str]]] = None, + max_results: Optional[int] = None, + order_by: Optional[str] = None, + filter: Optional[str] = None, + roll_up_by: Optional[str] = None, + **kwargs: Any, + ) -> List[MetricsQueryResult]: + """Lists the metric values for multiple resources. + + :keyword resource_ids: A list of resource IDs to query metrics for. Required. + :paramtype resource_ids: list[str] + :keyword metric_namespace: Metric namespace that contains the requested metric names. Required. + :paramtype metric_namespace: str + :keyword metric_names: The names of the metrics to retrieve. Required. + :paramtype metric_names: list[str] + :keyword timespan: The timespan for which to query the data. This can be a timedelta, + a tuple of a start datetime with timedelta, or a tuple with start and end datetimes. + :paramtype timespan: Optional[Union[~datetime.timedelta, tuple[~datetime.datetime, ~datetime.timedelta], + tuple[~datetime.datetime, ~datetime.datetime]]] + :keyword granularity: The granularity (i.e. timegrain) of the query. + :paramtype granularity: Optional[~datetime.timedelta] + :keyword aggregations: The list of aggregation types to retrieve. Use + `azure.monitor.querymetrics.MetricAggregationType` enum to get each aggregation type. + :paramtype aggregations: Optional[list[Union[~azure.monitor.querymetrics.MetricAggregationType, str]]] + :keyword max_results: The maximum number of records to retrieve. + Valid only if 'filter' is specified. Defaults to 10. + :paramtype max_results: Optional[int] + :keyword order_by: The aggregation to use for sorting results and the direction of the sort. + Only one order can be specified. Examples: 'sum asc', 'maximum desc'. + :paramtype order_by: Optional[str] + :keyword filter: The **filter** is used to reduce the set of metric data returned. Default value is None. + + Example: Metric contains metadata A, B and C. + + - Return all time series of C where A = a1 and B = b1 or b2: + + **filter="A eq 'a1' and B eq 'b1' or B eq 'b2' and C eq '*'"** + + - Invalid variant: + + **filter="A eq 'a1' and B eq 'b1' and C eq '*' or B = 'b2'"**. This is invalid because the + logical 'or' operator cannot separate two different metadata names. + + - Return all time series where A = a1, B = b1 and C = c1: + + **filter="A eq 'a1' and B eq 'b1' and C eq 'c1'"** + + - Return all time series where A = a1: + + **filter="A eq 'a1' and B eq '*' and C eq '*'"** + + - Special case: When dimension name or dimension value uses round brackets. Example: When dimension name + is **dim (test) 1**, instead of using **filter="dim (test) 1 eq '*'"** use + **filter="dim %2528test%2529 1 eq '*'"**. + + When dimension name is **dim (test) 3** and dimension value is + **dim3 (test) val**, instead of using **filter="dim (test) 3 eq 'dim3 (test) val'"**, use **filter="dim + %2528test%2529 3 eq 'dim3 %2528test%2529 val'"**. + :paramtype filter: str + :keyword roll_up_by: Dimension name(s) to rollup results by. For example if you only want to see + metric values with a filter like 'City eq Seattle or City eq Tacoma' but don't want to see + separate values for each city, you can specify 'City' to see the results for Seattle + and Tacoma rolled up into one timeseries. + :paramtype roll_up_by: str + :return: A list of MetricsQueryResult objects. + :rtype: list[~azure.monitor.querymetrics.MetricsQueryResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + if not resource_ids: + raise ValueError("'resource_ids' must be provided and must not be empty.") + + # Metric names with commas need to be encoded. + metric_names = [x.replace(",", "%2") for x in metric_names] + + start_time, end_time = get_timespan_iso8601_endpoints(timespan) + resource_id_json: JSON = {"resourceids": list(resource_ids)} + subscription_id = get_subscription_id_from_resource(resource_ids[0]) + interval = isodate.duration_isoformat(granularity) if granularity else None + + generated = await self._client.query_resources( + subscription_id=subscription_id, + batch_request=resource_id_json, + metric_namespace=metric_namespace, + metric_names=metric_names, + start_time=start_time, + end_time=end_time, + interval=interval, + aggregation=",".join(aggregations) if aggregations else None, + top=max_results, + order_by=order_by, + filter=filter, + roll_up_by=roll_up_by, # cspell:ignore rollupby + **kwargs, + ) + + # In rare cases, the generated value is a JSON string instead of a dict. This potentially stems from a bug in + # the service. This check handles that case. + if isinstance(generated, str): + generated = loads(generated) + + return [ + MetricsQueryResult._from_generated(value) # pylint: disable=protected-access + for value in generated["values"] + ] + + async def close(self) -> None: + return await self._client.close() + + async def __aenter__(self) -> "MetricsClient": + await self._client.__aenter__() + return self + + async def __aexit__(self, *args: Any) -> None: + await self._client.__aexit__(*args) diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/py.typed b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/py.typed new file mode 100644 index 000000000000..e5aff4f83af8 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/monitor/azure-monitor-querymetrics/dev_requirements.txt b/sdk/monitor/azure-monitor-querymetrics/dev_requirements.txt new file mode 100644 index 000000000000..0b4dbf4f9396 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/dev_requirements.txt @@ -0,0 +1,4 @@ +-e ../../../tools/azure-sdk-tools +../../core/azure-core +../../identity/azure-identity +aiohttp>=3.0 diff --git a/sdk/monitor/azure-monitor-querymetrics/sdk_packaging.tom b/sdk/monitor/azure-monitor-querymetrics/sdk_packaging.tom new file mode 100644 index 000000000000..901bc8ccbfa6 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/sdk_packaging.tom @@ -0,0 +1,2 @@ +[packaging] +auto_update = false diff --git a/sdk/monitor/azure-monitor-querymetrics/setup.py b/sdk/monitor/azure-monitor-querymetrics/setup.py new file mode 100644 index 000000000000..556292358fd9 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/setup.py @@ -0,0 +1,72 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + + +import os +import re +from setuptools import setup, find_packages + + +PACKAGE_NAME = "azure-monitor-querymetrics" +PACKAGE_PPRINT_NAME = "Azure Monitor Querymetrics" +PACKAGE_NAMESPACE = "azure.monitor.querymetrics" + +# a.b.c => a/b/c +package_folder_path = PACKAGE_NAMESPACE.replace(".", "/") + +# Version extraction inspired from 'requests' +with open(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") + + +setup( + name=PACKAGE_NAME, + version=version, + description="Microsoft Corporation {} Client Library for Python".format(PACKAGE_PPRINT_NAME), + long_description=open("README.md", "r").read(), + 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/tree/main/sdk", + keywords="azure, azure sdk", + classifiers=[ + "Development Status :: 5 - Production/Stable", + "Programming Language :: Python", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", + "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.monitor", + ] + ), + include_package_data=True, + package_data={ + "azure.monitor.querymetrics": ["py.typed"], + }, + install_requires=[ + "isodate>=0.6.1", + "azure-core>=1.30.0", + "typing-extensions>=4.6.0", + ], + python_requires=">=3.9", +) diff --git a/sdk/monitor/azure-monitor-querymetrics/tests/base_testcase.py b/sdk/monitor/azure-monitor-querymetrics/tests/base_testcase.py new file mode 100644 index 000000000000..db11fe248185 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/tests/base_testcase.py @@ -0,0 +1,40 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See LICENSE.txt in the project root for +# license information. +# ------------------------------------------------------------------------- +import os + +from devtools_testutils import AzureRecordedTestCase + + +ENV_MONITOR_ENVIRONMENT = "MONITOR_ENVIRONMENT" +ENV_MONITOR_RESOURCE_MANAGER_URL = "MONITOR_RESOURCE_MANAGER_URL" +ENV_MONITOR_LOCATION = "MONITOR_LOCATION" + + +METRICS_CLIENT_ENVIRONMENT_AUDIENCE_MAP = { + "AzureCloud": "https://metrics.monitor.azure.com", + "AzureChinaCloud": "https://metrics.monitor.azure.cn", + "AzureUSGovernment": "https://metrics.monitor.azure.us", +} + +TLD_MAP = {"AzureCloud": "com", "AzureChinaCloud": "cn", "AzureUSGovernment": "us"} + + +class MetricsClientTestCase(AzureRecordedTestCase): + + def get_client(self, client_class, credential, endpoint=None): + + environment = os.getenv(ENV_MONITOR_ENVIRONMENT) + kwargs = {} + tld = "com" + if environment: + kwargs["audience"] = METRICS_CLIENT_ENVIRONMENT_AUDIENCE_MAP.get(environment) + tld = TLD_MAP.get(environment, "com") + + if not endpoint: + region = os.getenv(ENV_MONITOR_LOCATION) or "westus2" + kwargs["endpoint"] = f"https://{region}.metrics.monitor.azure.{tld}" + + return self.create_client_from_credential(client_class, credential, **kwargs) diff --git a/sdk/monitor/azure-monitor-querymetrics/tests/conftest.py b/sdk/monitor/azure-monitor-querymetrics/tests/conftest.py new file mode 100644 index 000000000000..4ebfc747d9d4 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/tests/conftest.py @@ -0,0 +1,37 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See LICENSE.txt in the project root for +# license information. +# ------------------------------------------------------------------------- +import pytest + +from devtools_testutils.sanitizers import add_header_regex_sanitizer + + +# Environment variable keys +ENV_METRICS_RESOURCE_ID = "METRICS_RESOURCE_ID" +ENV_SUBSCRIPTION_ID = "MONITOR_SUBSCRIPTION_ID" +ENV_TENANT_ID = "AZURE_MONITOR_TENANT_ID" + +# Fake values +TEST_ID = "00000000-0000-0000-0000-000000000000" +TEST_RESOURCE_ID = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/fake-resource" +TEST_TABLE_NAME = "test-table" + + +@pytest.fixture(scope="session", autouse=True) +def add_sanitizers(test_proxy, environment_variables): + sanitization_mapping = { + ENV_METRICS_RESOURCE_ID: TEST_RESOURCE_ID, + ENV_SUBSCRIPTION_ID: TEST_ID, + ENV_TENANT_ID: TEST_ID, + } + environment_variables.sanitize_batch(sanitization_mapping) + add_header_regex_sanitizer(key="Set-Cookie", value="[set-cookie;]") + + +@pytest.fixture(scope="session") +def monitor_info(environment_variables): + yield { + "metrics_resource_id": environment_variables.get(ENV_METRICS_RESOURCE_ID), + } diff --git a/sdk/monitor/azure-monitor-querymetrics/tests/test_metrics_client.py b/sdk/monitor/azure-monitor-querymetrics/tests/test_metrics_client.py new file mode 100644 index 000000000000..99aab62108e1 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/tests/test_metrics_client.py @@ -0,0 +1,79 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See LICENSE.txt in the project root for +# license information. +# ------------------------------------------------------------------------- +from datetime import timedelta + +from azure.monitor.querymetrics import MetricsClient, MetricAggregationType +from azure.monitor.querymetrics._version import VERSION + +from base_testcase import MetricsClientTestCase + + +METRIC_NAME = "requests/count" +METRIC_RESOURCE_PROVIDER = "Microsoft.Insights/components" + + +class TestMetricsClient(MetricsClientTestCase): + + def test_batch_metrics_auth(self, recorded_test, monitor_info): + client: MetricsClient = self.get_client(MetricsClient, self.get_credential(MetricsClient)) + responses = client.query_resources( + resource_ids=[monitor_info["metrics_resource_id"]], + metric_namespace=METRIC_RESOURCE_PROVIDER, + metric_names=[METRIC_NAME], + aggregations=[MetricAggregationType.COUNT], + ) + assert responses + assert len(responses) == 1 + + def test_batch_metrics_granularity(self, recorded_test, monitor_info): + client: MetricsClient = self.get_client(MetricsClient, self.get_credential(MetricsClient)) + responses = client.query_resources( + resource_ids=[monitor_info["metrics_resource_id"]], + metric_namespace=METRIC_RESOURCE_PROVIDER, + metric_names=[METRIC_NAME], + granularity=timedelta(minutes=5), + aggregations=[MetricAggregationType.COUNT], + ) + assert responses + for response in responses: + assert response.granularity == timedelta(minutes=5) + # Check that metric can be accessed by name + metric = response.metrics[METRIC_NAME] # type: ignore + assert metric.timeseries + for t in metric.timeseries: + assert t.metadata_values is not None + + def test_batch_metrics_filter(self, recorded_test, monitor_info): + client: MetricsClient = self.get_client(MetricsClient, self.get_credential(MetricsClient)) + responses = client.query_resources( + resource_ids=[monitor_info["metrics_resource_id"]], + metric_namespace=METRIC_RESOURCE_PROVIDER, + metric_names=[METRIC_NAME], + filter="request/success eq '0'", + aggregations=[MetricAggregationType.COUNT], + ) + assert responses + for response in responses: + metric = response.metrics[0] + assert metric.name == METRIC_NAME + assert metric.timeseries + for t in metric.timeseries: + assert t.metadata_values is not None + assert t.metadata_values.get("request/success") == "0" + + def test_client_different_endpoint(self): + credential = self.get_credential(MetricsClient) + endpoint = "https://usgovvirginia.metrics.monitor.azure.us" + audience = "https://metrics.monitor.azure.us" + client = MetricsClient(endpoint, credential, audience=audience) + + assert client._endpoint == endpoint + assert client._client._config.authentication_policy + assert f"{audience}/.default" in client._client._config.authentication_policy._scopes + + def test_client_user_agent(self): + client: MetricsClient = self.get_client(MetricsClient, self.get_credential(MetricsClient)) + assert f"monitor-querymetrics/{VERSION}" in client._client._config.user_agent_policy.user_agent diff --git a/sdk/monitor/azure-monitor-querymetrics/tests/test_metrics_client_async.py b/sdk/monitor/azure-monitor-querymetrics/tests/test_metrics_client_async.py new file mode 100644 index 000000000000..09f7140611a4 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/tests/test_metrics_client_async.py @@ -0,0 +1,92 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See LICENSE.txt in the project root for +# license information. +# ------------------------------------------------------------------------- +from datetime import timedelta + +import pytest + +from azure.monitor.querymetrics import MetricAggregationType +from azure.monitor.querymetrics._version import VERSION +from azure.monitor.querymetrics.aio import MetricsClient + + +from base_testcase import MetricsClientTestCase + + +METRIC_NAME = "requests/count" +METRIC_RESOURCE_PROVIDER = "Microsoft.Insights/components" + + +class TestMetricsClientAsync(MetricsClientTestCase): + + @pytest.mark.asyncio + async def test_batch_metrics_auth(self, recorded_test, monitor_info): + client: MetricsClient = self.get_client(MetricsClient, self.get_credential(MetricsClient, is_async=True)) + async with client: + responses = await client.query_resources( + resource_ids=[monitor_info["metrics_resource_id"]], + metric_namespace=METRIC_RESOURCE_PROVIDER, + metric_names=[METRIC_NAME], + aggregations=[MetricAggregationType.COUNT], + ) + assert responses + assert len(responses) == 1 + + @pytest.mark.asyncio + async def test_batch_metrics_granularity(self, recorded_test, monitor_info): + client: MetricsClient = self.get_client(MetricsClient, self.get_credential(MetricsClient, is_async=True)) + async with client: + responses = await client.query_resources( + resource_ids=[monitor_info["metrics_resource_id"]], + metric_namespace=METRIC_RESOURCE_PROVIDER, + metric_names=[METRIC_NAME], + granularity=timedelta(minutes=5), + aggregations=[MetricAggregationType.COUNT], + ) + assert responses + for response in responses: + assert response.granularity == timedelta(minutes=5) + # Check that metric can be accessed by name + metric = response.metrics[METRIC_NAME] # type: ignore + assert metric.timeseries + for t in metric.timeseries: + assert t.metadata_values is not None + + @pytest.mark.asyncio + async def test_batch_metrics_filter(self, recorded_test, monitor_info): + client: MetricsClient = self.get_client(MetricsClient, self.get_credential(MetricsClient, is_async=True)) + async with client: + responses = await client.query_resources( + resource_ids=[monitor_info["metrics_resource_id"]], + metric_namespace=METRIC_RESOURCE_PROVIDER, + metric_names=[METRIC_NAME], + filter="request/success eq '0'", + aggregations=[MetricAggregationType.COUNT], + ) + assert responses + for response in responses: + metric = response.metrics[0] + assert metric.name == METRIC_NAME + assert metric.timeseries + for t in metric.timeseries: + assert t.metadata_values is not None + assert t.metadata_values.get("request/success") == "0" + + @pytest.mark.asyncio + async def test_client_different_endpoint(self): + credential = self.get_credential(MetricsClient, is_async=True) + endpoint = "https://usgovvirginia.metrics.monitor.azure.us" + audience = "https://metrics.monitor.azure.us" + client = MetricsClient(endpoint, credential, audience=audience) + + assert client._endpoint == endpoint + assert client._client._config.authentication_policy + assert f"{audience}/.default" in client._client._config.authentication_policy._scopes + + @pytest.mark.asyncio + async def test_client_user_agent(self): + client: MetricsClient = self.get_client(MetricsClient, self.get_credential(MetricsClient, is_async=True)) + async with client: + assert f"monitor-querymetrics/{VERSION}" in client._client._config.user_agent_policy.user_agent diff --git a/sdk/monitor/azure-monitor-querymetrics/tsp-location.yaml b/sdk/monitor/azure-monitor-querymetrics/tsp-location.yaml new file mode 100644 index 000000000000..003e3b0a1879 --- /dev/null +++ b/sdk/monitor/azure-monitor-querymetrics/tsp-location.yaml @@ -0,0 +1,4 @@ +directory: specification/monitor/Monitor.Query.Metrics +commit: f1dc99dad0b0d61849393cfa14604c1a1a7b729b +repo: Azure/azure-rest-api-specs +additionalDirectories: diff --git a/sdk/monitor/ci.yml b/sdk/monitor/ci.yml index 127e01083b28..f595588c33e5 100644 --- a/sdk/monitor/ci.yml +++ b/sdk/monitor/ci.yml @@ -39,3 +39,5 @@ extends: safeName: azuremonitorquery - name: azure-monitor-ingestion safeName: azuremonitoringestion + - name: azure-monitor-querymetrics + safeName: azuremonitorquerymetrics From 8664d2c0481c0ee4908710f756a1191e6fba83be Mon Sep 17 00:00:00 2001 From: Paul Van Eck Date: Tue, 22 Jul 2025 20:47:06 +0000 Subject: [PATCH 2/2] Update docstrings Signed-off-by: Paul Van Eck --- .../azure/monitor/querymetrics/_client.py | 3 +-- .../azure/monitor/querymetrics/aio/_client.py | 3 +-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_client.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_client.py index 2a8b1fccfb3f..132e0237b8fd 100644 --- a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_client.py +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/_client.py @@ -31,9 +31,8 @@ class MetricsClient: # pylint: disable=client-accepts-api-version-keyword :type credential: ~azure.core.credentials.TokenCredential :keyword str audience: The audience to use when requesting tokens for Microsoft Entra ID. Defaults to the public cloud audience (https://metrics.monitor.azure.com). - :keyword api_version: The API version to use for this operation. Default value is "2024-02-01". + :keyword str api_version: The API version to use for this operation. Default value is "2024-02-01". Note that overriding this default value may result in unsupported behavior. - :paramtype api_version: str """ def __init__(self, endpoint: str, credential: TokenCredential, **kwargs: Any) -> None: diff --git a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/aio/_client.py b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/aio/_client.py index 9bde994440ba..000dd071cde8 100644 --- a/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/aio/_client.py +++ b/sdk/monitor/azure-monitor-querymetrics/azure/monitor/querymetrics/aio/_client.py @@ -31,9 +31,8 @@ class MetricsClient: # pylint: disable=client-accepts-api-version-keyword :type credential: ~azure.core.credentials_async.AsyncTokenCredential :keyword str audience: The audience to use when requesting tokens for Microsoft Entra ID. Defaults to the public cloud audience (https://metrics.monitor.azure.com). - :keyword api_version: The API version to use for this operation. Default value is "2024-02-01". + :keyword str api_version: The API version to use for this operation. Default value is "2024-02-01". Note that overriding this default value may result in unsupported behavior. - :paramtype api_version: str """ def __init__(self, endpoint: str, credential: AsyncTokenCredential, **kwargs: Any) -> None: