Skip to content

Commit 22fda36

Browse files
authored
code and test (#35162)
Co-authored-by: azure-sdk <PythonSdkPipelines>
1 parent 1cde44b commit 22fda36

Some content is hidden

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

56 files changed

+9720
-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 (2024-04-22)
4+
5+
* Initial Release
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: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
include _meta.json
2+
recursive-include tests *.py *.json
3+
recursive-include samples *.py *.md
4+
include *.md
5+
include azure/__init__.py
6+
include azure/mgmt/__init__.py
7+
include LICENSE
8+
include azure/mgmt/deviceregistry/py.typed
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Microsoft Azure SDK for Python
2+
3+
This is the Microsoft Azure Deviceregistry Management Client Library.
4+
This package has been tested with Python 3.8+.
5+
For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).
6+
7+
## _Disclaimer_
8+
9+
_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_
10+
11+
## Getting started
12+
13+
### Prerequisites
14+
15+
- Python 3.8+ is required to use this package.
16+
- [Azure subscription](https://azure.microsoft.com/free/)
17+
18+
### Install the package
19+
20+
```bash
21+
pip install azure-mgmt-deviceregistry
22+
pip install azure-identity
23+
```
24+
25+
### Authentication
26+
27+
By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configure of following environment variables.
28+
29+
- `AZURE_CLIENT_ID` for Azure client ID.
30+
- `AZURE_TENANT_ID` for Azure tenant ID.
31+
- `AZURE_CLIENT_SECRET` for Azure client secret.
32+
33+
In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.
34+
35+
With above configuration, client can be authenticated by following code:
36+
37+
```python
38+
from azure.identity import DefaultAzureCredential
39+
from azure.mgmt.deviceregistry import DeviceRegistryMgmtClient
40+
import os
41+
42+
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
43+
client = DeviceRegistryMgmtClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
44+
```
45+
46+
## Examples
47+
48+
Code samples for this package can be found at:
49+
- [Search Deviceregistry Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com
50+
- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)
51+
52+
53+
## Troubleshooting
54+
55+
## Next steps
56+
57+
## Provide Feedback
58+
59+
If you encounter any bugs or have suggestions, please file an issue in the
60+
[Issues](https://github.com/Azure/azure-sdk-for-python/issues)
61+
section of the project.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"commit": "1f6e89637068d59b5ae935de9a88d5742d12f8e6",
3+
"repository_url": "https://github.com/Azure/azure-rest-api-specs",
4+
"autorest": "3.9.7",
5+
"use": [
6+
"@autorest/[email protected]",
7+
"@autorest/[email protected]"
8+
],
9+
"autorest_command": "autorest specification/deviceregistry/resource-manager/readme.md --generate-sample=True --include-x-ms-examples-original-file=True --python --python-sdks-folder=/home/vsts/work/1/azure-sdk-for-python/sdk --use=@autorest/[email protected] --use=@autorest/[email protected] --version=3.9.7 --version-tolerant=False",
10+
"readme": "specification/deviceregistry/resource-manager/readme.md"
11+
}
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__)
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__)
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) AutoRest Code Generator.
6+
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
7+
# --------------------------------------------------------------------------
8+
9+
from ._device_registry_mgmt_client import DeviceRegistryMgmtClient
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+
"DeviceRegistryMgmtClient",
23+
]
24+
__all__.extend([p for p in _patch_all if p not in __all__])
25+
26+
_patch_sdk()
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
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) AutoRest 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+
from azure.mgmt.core.policies import ARMChallengeAuthenticationPolicy, ARMHttpLoggingPolicy
13+
14+
from ._version import VERSION
15+
16+
if TYPE_CHECKING:
17+
# pylint: disable=unused-import,ungrouped-imports
18+
from azure.core.credentials import TokenCredential
19+
20+
21+
class DeviceRegistryMgmtClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long
22+
"""Configuration for DeviceRegistryMgmtClient.
23+
24+
Note that all parameters used to create this instance are saved as instance
25+
attributes.
26+
27+
:param credential: Credential needed for the client to connect to Azure. Required.
28+
:type credential: ~azure.core.credentials.TokenCredential
29+
:param subscription_id: The ID of the target subscription. Required.
30+
:type subscription_id: str
31+
:keyword api_version: Api Version. Default value is "2023-11-01-preview". Note that overriding
32+
this default value may result in unsupported behavior.
33+
:paramtype api_version: str
34+
"""
35+
36+
def __init__(self, credential: "TokenCredential", subscription_id: str, **kwargs: Any) -> None:
37+
api_version: str = kwargs.pop("api_version", "2023-11-01-preview")
38+
39+
if credential is None:
40+
raise ValueError("Parameter 'credential' must not be None.")
41+
if subscription_id is None:
42+
raise ValueError("Parameter 'subscription_id' must not be None.")
43+
44+
self.credential = credential
45+
self.subscription_id = subscription_id
46+
self.api_version = api_version
47+
self.credential_scopes = kwargs.pop("credential_scopes", ["https://management.azure.com/.default"])
48+
kwargs.setdefault("sdk_moniker", "mgmt-deviceregistry/{}".format(VERSION))
49+
self.polling_interval = kwargs.get("polling_interval", 30)
50+
self._configure(**kwargs)
51+
52+
def _configure(self, **kwargs: Any) -> None:
53+
self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs)
54+
self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs)
55+
self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs)
56+
self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs)
57+
self.http_logging_policy = kwargs.get("http_logging_policy") or ARMHttpLoggingPolicy(**kwargs)
58+
self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs)
59+
self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs)
60+
self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs)
61+
self.authentication_policy = kwargs.get("authentication_policy")
62+
if self.credential and not self.authentication_policy:
63+
self.authentication_policy = ARMChallengeAuthenticationPolicy(
64+
self.credential, *self.credential_scopes, **kwargs
65+
)
Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
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) AutoRest 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+
12+
from azure.core.pipeline import policies
13+
from azure.core.rest import HttpRequest, HttpResponse
14+
from azure.mgmt.core import ARMPipelineClient
15+
from azure.mgmt.core.policies import ARMAutoResourceProviderRegistrationPolicy
16+
17+
from . import models as _models
18+
from ._configuration import DeviceRegistryMgmtClientConfiguration
19+
from ._serialization import Deserializer, Serializer
20+
from .operations import AssetEndpointProfilesOperations, AssetsOperations, OperationStatusOperations, Operations
21+
22+
if TYPE_CHECKING:
23+
# pylint: disable=unused-import,ungrouped-imports
24+
from azure.core.credentials import TokenCredential
25+
26+
27+
class DeviceRegistryMgmtClient: # pylint: disable=client-accepts-api-version-keyword
28+
"""Microsoft.DeviceRegistry Resource Provider management API.
29+
30+
:ivar operations: Operations operations
31+
:vartype operations: azure.mgmt.deviceregistry.operations.Operations
32+
:ivar asset_endpoint_profiles: AssetEndpointProfilesOperations operations
33+
:vartype asset_endpoint_profiles:
34+
azure.mgmt.deviceregistry.operations.AssetEndpointProfilesOperations
35+
:ivar assets: AssetsOperations operations
36+
:vartype assets: azure.mgmt.deviceregistry.operations.AssetsOperations
37+
:ivar operation_status: OperationStatusOperations operations
38+
:vartype operation_status: azure.mgmt.deviceregistry.operations.OperationStatusOperations
39+
:param credential: Credential needed for the client to connect to Azure. Required.
40+
:type credential: ~azure.core.credentials.TokenCredential
41+
:param subscription_id: The ID of the target subscription. Required.
42+
:type subscription_id: str
43+
:param base_url: Service URL. Default value is "https://management.azure.com".
44+
:type base_url: str
45+
:keyword api_version: Api Version. Default value is "2023-11-01-preview". Note that overriding
46+
this default value may result in unsupported behavior.
47+
:paramtype api_version: str
48+
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
49+
Retry-After header is present.
50+
"""
51+
52+
def __init__(
53+
self,
54+
credential: "TokenCredential",
55+
subscription_id: str,
56+
base_url: str = "https://management.azure.com",
57+
**kwargs: Any
58+
) -> None:
59+
self._config = DeviceRegistryMgmtClientConfiguration(
60+
credential=credential, subscription_id=subscription_id, **kwargs
61+
)
62+
_policies = kwargs.pop("policies", None)
63+
if _policies is None:
64+
_policies = [
65+
policies.RequestIdPolicy(**kwargs),
66+
self._config.headers_policy,
67+
self._config.user_agent_policy,
68+
self._config.proxy_policy,
69+
policies.ContentDecodePolicy(**kwargs),
70+
ARMAutoResourceProviderRegistrationPolicy(),
71+
self._config.redirect_policy,
72+
self._config.retry_policy,
73+
self._config.authentication_policy,
74+
self._config.custom_hook_policy,
75+
self._config.logging_policy,
76+
policies.DistributedTracingPolicy(**kwargs),
77+
policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None,
78+
self._config.http_logging_policy,
79+
]
80+
self._client: ARMPipelineClient = ARMPipelineClient(base_url=base_url, policies=_policies, **kwargs)
81+
82+
client_models = {k: v for k, v in _models.__dict__.items() if isinstance(v, type)}
83+
self._serialize = Serializer(client_models)
84+
self._deserialize = Deserializer(client_models)
85+
self._serialize.client_side_validation = False
86+
self.operations = Operations(self._client, self._config, self._serialize, self._deserialize)
87+
self.asset_endpoint_profiles = AssetEndpointProfilesOperations(
88+
self._client, self._config, self._serialize, self._deserialize
89+
)
90+
self.assets = AssetsOperations(self._client, self._config, self._serialize, self._deserialize)
91+
self.operation_status = OperationStatusOperations(
92+
self._client, self._config, self._serialize, self._deserialize
93+
)
94+
95+
def _send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse:
96+
"""Runs the network request through the client's chained policies.
97+
98+
>>> from azure.core.rest import HttpRequest
99+
>>> request = HttpRequest("GET", "https://www.example.org/")
100+
<HttpRequest [GET], url: 'https://www.example.org/'>
101+
>>> response = client._send_request(request)
102+
<HttpResponse: 200 OK>
103+
104+
For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request
105+
106+
:param request: The network request you want to make. Required.
107+
:type request: ~azure.core.rest.HttpRequest
108+
:keyword bool stream: Whether the response payload will be streamed. Defaults to False.
109+
:return: The response of your network call. Does not do error handling on your response.
110+
:rtype: ~azure.core.rest.HttpResponse
111+
"""
112+
113+
request_copy = deepcopy(request)
114+
request_copy.url = self._client.format_url(request_copy.url)
115+
return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore
116+
117+
def close(self) -> None:
118+
self._client.close()
119+
120+
def __enter__(self) -> "DeviceRegistryMgmtClient":
121+
self._client.__enter__()
122+
return self
123+
124+
def __exit__(self, *exc_details: Any) -> None:
125+
self._client.__exit__(*exc_details)

0 commit comments

Comments
 (0)