Skip to content

Commit 0a61195

Browse files
author
SDKAuto
committed
CodeGen from PR 34523 in Azure/azure-rest-api-specs
Merge 6c6fda2d1ae8e880f5a38193403763711a06b966 into 011ecc5633300a5eefe43dde748f269d39e96458
1 parent cca51a6 commit 0a61195

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+6015
-0
lines changed

‎sdk/contosowidgetmanager/azure-contoso-widgetmanager/CHANGELOG.md‎

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

‎sdk/contosowidgetmanager/azure-contoso-widgetmanager/LICENSE‎

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.

‎sdk/contosowidgetmanager/azure-contoso-widgetmanager/MANIFEST.in‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
include *.md
2+
include LICENSE
3+
include azure/contoso/widgetmanager/py.typed
4+
recursive-include tests *.py
5+
recursive-include samples *.py *.md
6+
include azure/__init__.py
7+
include azure/contoso/__init__.py

‎sdk/contosowidgetmanager/azure-contoso-widgetmanager/README.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Azure Contoso Widgetmanager client library for Python
2+
<!-- write necessary description of service -->
3+
4+
## Getting started
5+
6+
### Install the package
7+
8+
```bash
9+
python -m pip install azure-contoso-widgetmanager
10+
```
11+
12+
#### Prequisites
13+
14+
- Python 3.9 or later is required to use this package.
15+
- You need an [Azure subscription][azure_sub] to use this package.
16+
- An existing Azure Contoso Widgetmanager instance.
17+
18+
#### Create with an Azure Active Directory Credential
19+
To use an [Azure Active Directory (AAD) token credential][authenticate_with_token],
20+
provide an instance of the desired credential type obtained from the
21+
[azure-identity][azure_identity_credentials] library.
22+
23+
To authenticate with AAD, you must first [pip][pip] install [`azure-identity`][azure_identity_pip]
24+
25+
After setup, you can choose which type of [credential][azure_identity_credentials] from azure.identity to use.
26+
As an example, [DefaultAzureCredential][default_azure_credential] can be used to authenticate the client:
27+
28+
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
29+
`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`
30+
31+
Use the returned token credential to authenticate the client:
32+
33+
```python
34+
>>> from azure.contoso.widgetmanager import WidgetManagerClient
35+
>>> from azure.identity import DefaultAzureCredential
36+
>>> client = WidgetManagerClient(endpoint='<endpoint>', credential=DefaultAzureCredential())
37+
```
38+
39+
## Examples
40+
41+
```python
42+
>>> from azure.contoso.widgetmanager import WidgetManagerClient
43+
>>> from azure.identity import DefaultAzureCredential
44+
>>> from azure.core.exceptions import HttpResponseError
45+
46+
>>> client = WidgetManagerClient(endpoint='<endpoint>', credential=DefaultAzureCredential())
47+
>>> try:
48+
<!-- write test code here -->
49+
except HttpResponseError as e:
50+
print('service responds error: {}'.format(e.response.json()))
51+
52+
```
53+
54+
## Contributing
55+
56+
This project welcomes contributions and suggestions. Most contributions require
57+
you to agree to a Contributor License Agreement (CLA) declaring that you have
58+
the right to, and actually do, grant us the rights to use your contribution.
59+
For details, visit https://cla.microsoft.com.
60+
61+
When you submit a pull request, a CLA-bot will automatically determine whether
62+
you need to provide a CLA and decorate the PR appropriately (e.g., label,
63+
comment). Simply follow the instructions provided by the bot. You will only
64+
need to do this once across all repos using our CLA.
65+
66+
This project has adopted the
67+
[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information,
68+
see the Code of Conduct FAQ or contact [email protected] with any
69+
additional questions or comments.
70+
71+
<!-- LINKS -->
72+
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
73+
[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token
74+
[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials
75+
[azure_identity_pip]: https://pypi.org/project/azure-identity/
76+
[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential
77+
[pip]: https://pypi.org/project/pip/
78+
[azure_sub]: https://azure.microsoft.com/free/

‎sdk/contosowidgetmanager/azure-contoso-widgetmanager/_meta.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"commit": "54e27ae277e7fb673cc65c4390c5e91505bb8a38",
3+
"repository_url": "https://github.com/Azure/azure-rest-api-specs",
4+
"typespec_src": "specification/contosowidgetmanager/Contoso.WidgetManager",
5+
"@azure-tools/typespec-python": "0.44.1"
6+
}

‎sdk/contosowidgetmanager/azure-contoso-widgetmanager/apiview-properties.json‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"CrossLanguagePackageId": "Azure.Contoso.WidgetManager",
3+
"CrossLanguageDefinitionId": {
4+
"azure.contoso.widgetmanager.models.FakedSharedModel": "FakedSharedModel",
5+
"azure.contoso.widgetmanager.models.ResourceOperationStatusWidgetSuiteWidgetSuiteError": "Azure.Core.ResourceOperationStatus",
6+
"azure.contoso.widgetmanager.models.WidgetSuite": "Azure.Contoso.WidgetManager.WidgetSuite",
7+
"azure.contoso.widgetmanager.models.OperationState": "Azure.Core.Foundations.OperationState",
8+
"azure.contoso.widgetmanager.operations.WidgetsOperations.get_widget": "Azure.Contoso.WidgetManager.Widgets.getWidget",
9+
"azure.contoso.widgetmanager.aio.operations.WidgetsOperations.get_widget": "Azure.Contoso.WidgetManager.Widgets.getWidget",
10+
"azure.contoso.widgetmanager.operations.WidgetsOperations.get_widget_operation_status": "Azure.Contoso.WidgetManager.Widgets.getWidgetOperationStatus",
11+
"azure.contoso.widgetmanager.aio.operations.WidgetsOperations.get_widget_operation_status": "Azure.Contoso.WidgetManager.Widgets.getWidgetOperationStatus",
12+
"azure.contoso.widgetmanager.operations.WidgetsOperations.begin_create_or_update_widget": "Azure.Contoso.WidgetManager.Widgets.createOrUpdateWidget",
13+
"azure.contoso.widgetmanager.aio.operations.WidgetsOperations.begin_create_or_update_widget": "Azure.Contoso.WidgetManager.Widgets.createOrUpdateWidget",
14+
"azure.contoso.widgetmanager.operations.WidgetsOperations.begin_delete_widget": "Azure.Contoso.WidgetManager.Widgets.deleteWidget",
15+
"azure.contoso.widgetmanager.aio.operations.WidgetsOperations.begin_delete_widget": "Azure.Contoso.WidgetManager.Widgets.deleteWidget",
16+
"azure.contoso.widgetmanager.operations.WidgetsOperations.list_widgets": "Azure.Contoso.WidgetManager.Widgets.listWidgets",
17+
"azure.contoso.widgetmanager.aio.operations.WidgetsOperations.list_widgets": "Azure.Contoso.WidgetManager.Widgets.listWidgets"
18+
}
19+
}

‎sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/__init__.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore

‎sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/__init__.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore

‎sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/__init__.py‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
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+
# pylint: disable=wrong-import-position
9+
10+
from typing import TYPE_CHECKING
11+
12+
if TYPE_CHECKING:
13+
from ._patch import * # pylint: disable=unused-wildcard-import
14+
15+
from ._client import WidgetManagerClient # type: ignore
16+
from ._version import VERSION
17+
18+
__version__ = VERSION
19+
20+
try:
21+
from ._patch import __all__ as _patch_all
22+
from ._patch import *
23+
except ImportError:
24+
_patch_all = []
25+
from ._patch import patch_sdk as _patch_sdk
26+
27+
__all__ = [
28+
"WidgetManagerClient",
29+
]
30+
__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore
31+
32+
_patch_sdk()

‎sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/_client.py‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
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 WidgetManagerClientConfiguration
18+
from ._utils.serialization import Deserializer, Serializer
19+
from .operations import WidgetsOperations
20+
21+
if TYPE_CHECKING:
22+
from azure.core.credentials import TokenCredential
23+
24+
25+
class WidgetManagerClient:
26+
"""WidgetManagerClient.
27+
28+
:ivar widgets: WidgetsOperations operations
29+
:vartype widgets: azure.contoso.widgetmanager.operations.WidgetsOperations
30+
:param endpoint: Service host. Required.
31+
:type endpoint: str
32+
:param credential: Credential used to authenticate requests to the service. Required.
33+
:type credential: ~azure.core.credentials.TokenCredential
34+
:keyword api_version: The API version to use for this operation. Default value is "2022-12-01".
35+
Note that overriding this default value may result in unsupported behavior.
36+
:paramtype api_version: str
37+
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
38+
Retry-After header is present.
39+
"""
40+
41+
def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None:
42+
_endpoint = "{endpoint}"
43+
self._config = WidgetManagerClientConfiguration(endpoint=endpoint, credential=credential, **kwargs)
44+
45+
_policies = kwargs.pop("policies", None)
46+
if _policies is None:
47+
_policies = [
48+
policies.RequestIdPolicy(**kwargs),
49+
self._config.headers_policy,
50+
self._config.user_agent_policy,
51+
self._config.proxy_policy,
52+
policies.ContentDecodePolicy(**kwargs),
53+
self._config.redirect_policy,
54+
self._config.retry_policy,
55+
self._config.authentication_policy,
56+
self._config.custom_hook_policy,
57+
self._config.logging_policy,
58+
policies.DistributedTracingPolicy(**kwargs),
59+
policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None,
60+
self._config.http_logging_policy,
61+
]
62+
self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs)
63+
64+
self._serialize = Serializer()
65+
self._deserialize = Deserializer()
66+
self._serialize.client_side_validation = False
67+
self.widgets = WidgetsOperations(self._client, self._config, self._serialize, self._deserialize)
68+
69+
def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse:
70+
"""Runs the network request through the client's chained policies.
71+
72+
>>> from azure.core.rest import HttpRequest
73+
>>> request = HttpRequest("GET", "https://www.example.org/")
74+
<HttpRequest [GET], url: 'https://www.example.org/'>
75+
>>> response = client.send_request(request)
76+
<HttpResponse: 200 OK>
77+
78+
For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request
79+
80+
:param request: The network request you want to make. Required.
81+
:type request: ~azure.core.rest.HttpRequest
82+
:keyword bool stream: Whether the response payload will be streamed. Defaults to False.
83+
:return: The response of your network call. Does not do error handling on your response.
84+
:rtype: ~azure.core.rest.HttpResponse
85+
"""
86+
87+
request_copy = deepcopy(request)
88+
path_format_arguments = {
89+
"endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True),
90+
}
91+
92+
request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments)
93+
return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore
94+
95+
def close(self) -> None:
96+
self._client.close()
97+
98+
def __enter__(self) -> Self:
99+
self._client.__enter__()
100+
return self
101+
102+
def __exit__(self, *exc_details: Any) -> None:
103+
self._client.__exit__(*exc_details)

0 commit comments

Comments
 (0)