Skip to content

Commit 4852059

Browse files
author
SDKAuto
committed
CodeGen from PR 3512 in test-repo-billy/azure-rest-api-specs
Merge ebceec76145d194c964938918bd28860cd8a6dc3 into 8df52d62be2e13ba064fd9c0c7874dd6751c8f4f
1 parent b2b0c35 commit 4852059

31 files changed

+6278
-0
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Release History
2+
3+
## 1.0.0b1 (1970-01-01)
4+
5+
- Initial version
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Copyright (c) Microsoft Corporation.
2+
3+
MIT License
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
include *.md
2+
include LICENSE
3+
include livemetrics/py.typed
4+
recursive-include tests *.py
5+
recursive-include samples *.py *.md
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
2+
3+
# Livemetrics client library for Python
4+
<!-- write necessary description of service -->
5+
6+
## Getting started
7+
8+
### Install the package
9+
10+
```bash
11+
python -m pip install livemetrics
12+
```
13+
14+
#### Prequisites
15+
16+
- Python 3.8 or later is required to use this package.
17+
- You need an [Azure subscription][azure_sub] to use this package.
18+
- An existing Livemetrics instance.
19+
#### Create with an Azure Active Directory Credential
20+
To use an [Azure Active Directory (AAD) token credential][authenticate_with_token],
21+
provide an instance of the desired credential type obtained from the
22+
[azure-identity][azure_identity_credentials] library.
23+
24+
To authenticate with AAD, you must first [pip][pip] install [`azure-identity`][azure_identity_pip]
25+
26+
After setup, you can choose which type of [credential][azure_identity_credentials] from azure.identity to use.
27+
As an example, [DefaultAzureCredential][default_azure_credential] can be used to authenticate the client:
28+
29+
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
30+
`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`
31+
32+
Use the returned token credential to authenticate the client:
33+
34+
```python
35+
>>> from livemetrics import LiveMetricsClient
36+
>>> from azure.identity import DefaultAzureCredential
37+
>>> client = LiveMetricsClient(endpoint='<endpoint>', credential=DefaultAzureCredential())
38+
```
39+
40+
## Examples
41+
42+
```python
43+
>>> from livemetrics import LiveMetricsClient
44+
>>> from azure.identity import DefaultAzureCredential
45+
>>> from azure.core.exceptions import HttpResponseError
46+
47+
>>> client = LiveMetricsClient(endpoint='<endpoint>', credential=DefaultAzureCredential())
48+
>>> try:
49+
<!-- write test code here -->
50+
except HttpResponseError as e:
51+
print('service responds error: {}'.format(e.response.json()))
52+
53+
```
54+
55+
## Contributing
56+
57+
This project welcomes contributions and suggestions. Most contributions require
58+
you to agree to a Contributor License Agreement (CLA) declaring that you have
59+
the right to, and actually do, grant us the rights to use your contribution.
60+
For details, visit https://cla.microsoft.com.
61+
62+
When you submit a pull request, a CLA-bot will automatically determine whether
63+
you need to provide a CLA and decorate the PR appropriately (e.g., label,
64+
comment). Simply follow the instructions provided by the bot. You will only
65+
need to do this once across all repos using our CLA.
66+
67+
This project has adopted the
68+
[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information,
69+
see the Code of Conduct FAQ or contact [email protected] with any
70+
additional questions or comments.
71+
72+
<!-- LINKS -->
73+
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
74+
[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token
75+
[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials
76+
[azure_identity_pip]: https://pypi.org/project/azure-identity/
77+
[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential
78+
[pip]: https://pypi.org/project/pip/
79+
[azure_sub]: https://azure.microsoft.com/free/
80+
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
-e ../../../tools/azure-sdk-tools
2+
../../core/azure-core
3+
../../identity/azure-identity
4+
aiohttp
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# coding=utf-8
2+
# --------------------------------------------------------------------------
3+
# Copyright (c) Microsoft Corporation. All rights reserved.
4+
# Licensed under the MIT License. See License.txt in the project root for license information.
5+
# Code generated by Microsoft (R) Python Code Generator.
6+
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
7+
# --------------------------------------------------------------------------
8+
9+
from ._client import LiveMetricsClient
10+
from ._version import VERSION
11+
12+
__version__ = VERSION
13+
14+
try:
15+
from ._patch import __all__ as _patch_all
16+
from ._patch import * # pylint: disable=unused-wildcard-import
17+
except ImportError:
18+
_patch_all = []
19+
from ._patch import patch_sdk as _patch_sdk
20+
21+
__all__ = [
22+
"LiveMetricsClient",
23+
]
24+
__all__.extend([p for p in _patch_all if p not in __all__])
25+
26+
_patch_sdk()
Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# coding=utf-8
2+
# --------------------------------------------------------------------------
3+
# Copyright (c) Microsoft Corporation. All rights reserved.
4+
# Licensed under the MIT License. See License.txt in the project root for license information.
5+
# Code generated by Microsoft (R) Python Code Generator.
6+
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
7+
# --------------------------------------------------------------------------
8+
9+
from copy import deepcopy
10+
from typing import Any, TYPE_CHECKING
11+
from typing_extensions import Self
12+
13+
from azure.core import PipelineClient
14+
from azure.core.pipeline import policies
15+
from azure.core.rest import HttpRequest, HttpResponse
16+
17+
from ._configuration import LiveMetricsClientConfiguration
18+
from ._operations import LiveMetricsClientOperationsMixin
19+
from ._serialization import Deserializer, Serializer
20+
21+
if TYPE_CHECKING:
22+
# pylint: disable=unused-import,ungrouped-imports
23+
from azure.core.credentials import TokenCredential
24+
25+
26+
class LiveMetricsClient(LiveMetricsClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword
27+
"""Live Metrics REST APIs.
28+
29+
:param credential: Credential used to authenticate requests to the service. Required.
30+
:type credential: ~azure.core.credentials.TokenCredential
31+
:keyword endpoint: The endpoint of the Live Metrics service. Default value is
32+
"https://global.livediagnostics.monitor.azure.com".
33+
:paramtype endpoint: str
34+
:keyword api_version: The API version to use for this operation. Default value is
35+
"2024-04-01-preview". Note that overriding this default value may result in unsupported
36+
behavior.
37+
:paramtype api_version: str
38+
"""
39+
40+
def __init__(
41+
self,
42+
credential: "TokenCredential",
43+
*,
44+
endpoint: str = "https://global.livediagnostics.monitor.azure.com",
45+
**kwargs: Any
46+
) -> None:
47+
_endpoint = "{endpoint}"
48+
self._config = LiveMetricsClientConfiguration(credential=credential, endpoint=endpoint, **kwargs)
49+
_policies = kwargs.pop("policies", None)
50+
if _policies is None:
51+
_policies = [
52+
policies.RequestIdPolicy(**kwargs),
53+
self._config.headers_policy,
54+
self._config.user_agent_policy,
55+
self._config.proxy_policy,
56+
policies.ContentDecodePolicy(**kwargs),
57+
self._config.redirect_policy,
58+
self._config.retry_policy,
59+
self._config.authentication_policy,
60+
self._config.custom_hook_policy,
61+
self._config.logging_policy,
62+
policies.DistributedTracingPolicy(**kwargs),
63+
policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None,
64+
self._config.http_logging_policy,
65+
]
66+
self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs)
67+
68+
self._serialize = Serializer()
69+
self._deserialize = Deserializer()
70+
self._serialize.client_side_validation = False
71+
72+
def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse:
73+
"""Runs the network request through the client's chained policies.
74+
75+
>>> from azure.core.rest import HttpRequest
76+
>>> request = HttpRequest("GET", "https://www.example.org/")
77+
<HttpRequest [GET], url: 'https://www.example.org/'>
78+
>>> response = client.send_request(request)
79+
<HttpResponse: 200 OK>
80+
81+
For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request
82+
83+
:param request: The network request you want to make. Required.
84+
:type request: ~azure.core.rest.HttpRequest
85+
:keyword bool stream: Whether the response payload will be streamed. Defaults to False.
86+
:return: The response of your network call. Does not do error handling on your response.
87+
:rtype: ~azure.core.rest.HttpResponse
88+
"""
89+
90+
request_copy = deepcopy(request)
91+
path_format_arguments = {
92+
"endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"),
93+
}
94+
95+
request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments)
96+
return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore
97+
98+
def close(self) -> None:
99+
self._client.close()
100+
101+
def __enter__(self) -> Self:
102+
self._client.__enter__()
103+
return self
104+
105+
def __exit__(self, *exc_details: Any) -> None:
106+
self._client.__exit__(*exc_details)
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# coding=utf-8
2+
# --------------------------------------------------------------------------
3+
# Copyright (c) Microsoft Corporation. All rights reserved.
4+
# Licensed under the MIT License. See License.txt in the project root for license information.
5+
# Code generated by Microsoft (R) Python Code Generator.
6+
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
7+
# --------------------------------------------------------------------------
8+
9+
from typing import Any, TYPE_CHECKING
10+
11+
from azure.core.pipeline import policies
12+
13+
from ._version import VERSION
14+
15+
if TYPE_CHECKING:
16+
# pylint: disable=unused-import,ungrouped-imports
17+
from azure.core.credentials import TokenCredential
18+
19+
20+
class LiveMetricsClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long
21+
"""Configuration for LiveMetricsClient.
22+
23+
Note that all parameters used to create this instance are saved as instance
24+
attributes.
25+
26+
:param credential: Credential used to authenticate requests to the service. Required.
27+
:type credential: ~azure.core.credentials.TokenCredential
28+
:param endpoint: The endpoint of the Live Metrics service. Default value is
29+
"https://global.livediagnostics.monitor.azure.com".
30+
:type endpoint: str
31+
:keyword api_version: The API version to use for this operation. Default value is
32+
"2024-04-01-preview". Note that overriding this default value may result in unsupported
33+
behavior.
34+
:paramtype api_version: str
35+
"""
36+
37+
def __init__(
38+
self,
39+
credential: "TokenCredential",
40+
endpoint: str = "https://global.livediagnostics.monitor.azure.com",
41+
**kwargs: Any
42+
) -> None:
43+
api_version: str = kwargs.pop("api_version", "2024-04-01-preview")
44+
45+
if credential is None:
46+
raise ValueError("Parameter 'credential' must not be None.")
47+
48+
self.credential = credential
49+
self.endpoint = endpoint
50+
self.api_version = api_version
51+
self.credential_scopes = kwargs.pop("credential_scopes", ["https://monitor.azure.com/.default"])
52+
kwargs.setdefault("sdk_moniker", "livemetrics/{}".format(VERSION))
53+
self.polling_interval = kwargs.get("polling_interval", 30)
54+
self._configure(**kwargs)
55+
56+
def _configure(self, **kwargs: Any) -> None:
57+
self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs)
58+
self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs)
59+
self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs)
60+
self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs)
61+
self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs)
62+
self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs)
63+
self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs)
64+
self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs)
65+
self.authentication_policy = kwargs.get("authentication_policy")
66+
if self.credential and not self.authentication_policy:
67+
self.authentication_policy = policies.BearerTokenCredentialPolicy(
68+
self.credential, *self.credential_scopes, **kwargs
69+
)

0 commit comments

Comments
 (0)