forked from Azure/azure-sdk-for-python
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CodeGen from PR 31871 in Azure/azure-rest-api-specs
Merge e374fad5ed22490dc710e28ca4219b55176e6862 into bf420af156ea90b4226e96582bdb4c9647491ae6
- Loading branch information
SDKAuto
committed
Dec 20, 2024
1 parent
ce16093
commit a903246
Showing
46 changed files
with
7,313 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Release History | ||
|
||
## 1.0.0b1 (1970-01-01) | ||
|
||
- Initial version |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
include _meta.json | ||
recursive-include tests *.py *.json | ||
recursive-include samples *.py *.md | ||
include *.md | ||
include azure/__init__.py | ||
include azure/mgmt/__init__.py | ||
include LICENSE | ||
include azure/mgmt/contoso/py.typed |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
# Microsoft Azure SDK for Python | ||
|
||
This is the Microsoft Azure MyService Management Client Library. | ||
This package has been tested with Python 3.8+. | ||
For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all). | ||
|
||
## _Disclaimer_ | ||
|
||
_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_ | ||
|
||
## Getting started | ||
|
||
### Prerequisites | ||
|
||
- Python 3.8+ is required to use this package. | ||
- [Azure subscription](https://azure.microsoft.com/free/) | ||
|
||
### Install the package | ||
|
||
```bash | ||
pip install azure-mgmt-contoso | ||
pip install azure-identity | ||
``` | ||
|
||
### Authentication | ||
|
||
By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configure of following environment variables. | ||
|
||
- `AZURE_CLIENT_ID` for Azure client ID. | ||
- `AZURE_TENANT_ID` for Azure tenant ID. | ||
- `AZURE_CLIENT_SECRET` for Azure client secret. | ||
|
||
In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`. | ||
|
||
With above configuration, client can be authenticated by following code: | ||
|
||
```python | ||
from azure.identity import DefaultAzureCredential | ||
from azure.mgmt.contoso import | ||
import os | ||
|
||
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID") | ||
client = (credential=DefaultAzureCredential(), subscription_id=sub_id) | ||
``` | ||
|
||
## Examples | ||
|
||
Code samples for this package can be found at: | ||
- [Search MyService Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com | ||
- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples) | ||
|
||
|
||
## Troubleshooting | ||
|
||
## Next steps | ||
|
||
## Provide Feedback | ||
|
||
If you encounter any bugs or have suggestions, please file an issue in the | ||
[Issues](https://github.com/Azure/azure-sdk-for-python/issues) | ||
section of the project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"commit": "e8a3a3f12fc3579429d278d83bfc1676f878e866", | ||
"repository_url": "https://github.com/Azure/azure-rest-api-specs", | ||
"typespec_src": "specification/contosowidgetmanager/Contoso.Management", | ||
"@azure-tools/typespec-python": "0.37.2" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
__path__ = __import__("pkgutil").extend_path(__path__, __name__) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
__path__ = __import__("pkgutil").extend_path(__path__, __name__) |
32 changes: 32 additions & 0 deletions
32
sdk/contoso/azure-mgmt-contoso/azure/mgmt/contoso/__init__.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 ContosoClient # 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__ = [ | ||
"ContosoClient", | ||
] | ||
__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore | ||
|
||
_patch_sdk() |
118 changes: 118 additions & 0 deletions
118
sdk/contoso/azure-mgmt-contoso/azure/mgmt/contoso/_client.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,118 @@ | ||
# 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.pipeline import policies | ||
from azure.core.rest import HttpRequest, HttpResponse | ||
from azure.mgmt.core import ARMPipelineClient | ||
from azure.mgmt.core.policies import ARMAutoResourceProviderRegistrationPolicy | ||
|
||
from ._configuration import ContosoClientConfiguration | ||
from ._serialization import Deserializer, Serializer | ||
from .operations import EmployeesOperations, Operations | ||
|
||
if TYPE_CHECKING: | ||
from azure.core.credentials import TokenCredential | ||
|
||
|
||
class ContosoClient: | ||
"""Microsoft.Contoso Resource Provider management API. | ||
:ivar operations: Operations operations | ||
:vartype operations: azure.mgmt.contoso.operations.Operations | ||
:ivar employees: EmployeesOperations operations | ||
:vartype employees: azure.mgmt.contoso.operations.EmployeesOperations | ||
:param credential: Credential used to authenticate requests to the service. Required. | ||
:type credential: ~azure.core.credentials.TokenCredential | ||
:param subscription_id: The ID of the target subscription. The value must be an UUID. Required. | ||
:type subscription_id: str | ||
:param base_url: Service host. Default value is "https://management.azure.com". | ||
:type base_url: str | ||
:keyword api_version: The API version to use for this operation. Default value is | ||
"2021-10-01-preview". Note that overriding this default value may result in unsupported | ||
behavior. | ||
:paramtype api_version: str | ||
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no | ||
Retry-After header is present. | ||
""" | ||
|
||
def __init__( | ||
self, | ||
credential: "TokenCredential", | ||
subscription_id: str, | ||
base_url: str = "https://management.azure.com", | ||
**kwargs: Any | ||
) -> None: | ||
_endpoint = "{endpoint}" | ||
self._config = ContosoClientConfiguration( | ||
credential=credential, subscription_id=subscription_id, base_url=base_url, **kwargs | ||
) | ||
_policies = kwargs.pop("policies", None) | ||
if _policies is None: | ||
_policies = [ | ||
policies.RequestIdPolicy(**kwargs), | ||
self._config.headers_policy, | ||
self._config.user_agent_policy, | ||
self._config.proxy_policy, | ||
policies.ContentDecodePolicy(**kwargs), | ||
ARMAutoResourceProviderRegistrationPolicy(), | ||
self._config.redirect_policy, | ||
self._config.retry_policy, | ||
self._config.authentication_policy, | ||
self._config.custom_hook_policy, | ||
self._config.logging_policy, | ||
policies.DistributedTracingPolicy(**kwargs), | ||
policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, | ||
self._config.http_logging_policy, | ||
] | ||
self._client: ARMPipelineClient = ARMPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) | ||
|
||
self._serialize = Serializer() | ||
self._deserialize = Deserializer() | ||
self._serialize.client_side_validation = False | ||
self.operations = Operations(self._client, self._config, self._serialize, self._deserialize) | ||
self.employees = EmployeesOperations(self._client, self._config, self._serialize, self._deserialize) | ||
|
||
def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: | ||
"""Runs the network request through the client's chained policies. | ||
>>> from azure.core.rest import HttpRequest | ||
>>> request = HttpRequest("GET", "https://www.example.org/") | ||
<HttpRequest [GET], url: 'https://www.example.org/'> | ||
>>> response = client.send_request(request) | ||
<HttpResponse: 200 OK> | ||
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.base_url", self._config.base_url, "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) |
74 changes: 74 additions & 0 deletions
74
sdk/contoso/azure-mgmt-contoso/azure/mgmt/contoso/_configuration.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# coding=utf-8 | ||
# -------------------------------------------------------------------------- | ||
# Copyright (c) Microsoft Corporation. All rights reserved. | ||
# Licensed under the MIT License. See License.txt in the project root for license information. | ||
# Code generated by Microsoft (R) Python Code Generator. | ||
# Changes may cause incorrect behavior and will be lost if the code is regenerated. | ||
# -------------------------------------------------------------------------- | ||
|
||
from typing import Any, TYPE_CHECKING | ||
|
||
from azure.core.pipeline import policies | ||
from azure.mgmt.core.policies import ARMChallengeAuthenticationPolicy, ARMHttpLoggingPolicy | ||
|
||
from ._version import VERSION | ||
|
||
if TYPE_CHECKING: | ||
from azure.core.credentials import TokenCredential | ||
|
||
|
||
class ContosoClientConfiguration: # pylint: disable=too-many-instance-attributes | ||
"""Configuration for ContosoClient. | ||
Note that all parameters used to create this instance are saved as instance | ||
attributes. | ||
:param credential: Credential used to authenticate requests to the service. Required. | ||
:type credential: ~azure.core.credentials.TokenCredential | ||
:param subscription_id: The ID of the target subscription. The value must be an UUID. Required. | ||
:type subscription_id: str | ||
:param base_url: Service host. Default value is "https://management.azure.com". | ||
:type base_url: str | ||
:keyword api_version: The API version to use for this operation. Default value is | ||
"2021-10-01-preview". Note that overriding this default value may result in unsupported | ||
behavior. | ||
:paramtype api_version: str | ||
""" | ||
|
||
def __init__( | ||
self, | ||
credential: "TokenCredential", | ||
subscription_id: str, | ||
base_url: str = "https://management.azure.com", | ||
**kwargs: Any | ||
) -> None: | ||
api_version: str = kwargs.pop("api_version", "2021-10-01-preview") | ||
|
||
if credential is None: | ||
raise ValueError("Parameter 'credential' must not be None.") | ||
if subscription_id is None: | ||
raise ValueError("Parameter 'subscription_id' must not be None.") | ||
|
||
self.credential = credential | ||
self.subscription_id = subscription_id | ||
self.base_url = base_url | ||
self.api_version = api_version | ||
self.credential_scopes = kwargs.pop("credential_scopes", ["https://management.azure.com/.default"]) | ||
kwargs.setdefault("sdk_moniker", "mgmt-contoso/{}".format(VERSION)) | ||
self.polling_interval = kwargs.get("polling_interval", 30) | ||
self._configure(**kwargs) | ||
|
||
def _configure(self, **kwargs: Any) -> None: | ||
self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) | ||
self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) | ||
self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) | ||
self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) | ||
self.http_logging_policy = kwargs.get("http_logging_policy") or ARMHttpLoggingPolicy(**kwargs) | ||
self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) | ||
self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) | ||
self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) | ||
self.authentication_policy = kwargs.get("authentication_policy") | ||
if self.credential and not self.authentication_policy: | ||
self.authentication_policy = ARMChallengeAuthenticationPolicy( | ||
self.credential, *self.credential_scopes, **kwargs | ||
) |
Oops, something went wrong.