1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
# 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 typing import TYPE_CHECKING, Any, Union
from azure.core.credentials import AzureNamedKeyCredential, AzureSasCredential
from azure.core.pipeline import Pipeline
from azure.core.pipeline.policies import (
BearerTokenCredentialPolicy,
ContentDecodePolicy,
DistributedTracingPolicy,
HeadersPolicy,
HttpLoggingPolicy,
NetworkTraceLoggingPolicy,
RetryPolicy,
UserAgentPolicy,
)
from azure.core.pipeline.transport import (
RequestsTransport,
) # pylint: disable=no-name-in-module
from azure.core.utils import parse_connection_string
from ._api_version import DEFAULT_VERSION, ApiVersion
from ._auth import SasCredentialPolicy, SharedKeyCredentialPolicy
from ._client import DeviceProvisioningClient as GeneratedDeviceProvisioningClient
from ._version import VERSION
if TYPE_CHECKING:
# pylint: disable=unused-import,ungrouped-imports
from azure.core.credentials import TokenCredential
class DeviceProvisioningClient(
GeneratedDeviceProvisioningClient
): # pylint: disable=client-accepts-api-version-keyword
"""
API for connecting to, and conducting operations on a Device Provisioning Service instance
:param str endpoint: The HTTP endpoint of the Device Provisioning Service instance
:param credential: The credential type used to authenticate with the Device Provisioning Service instance
:type credential:
~azure.core.credentials.AzureNamedKeyCredential or
~azure.core.credentials.AzureSasCredential or
~azure.core.credentials.TokenCredential
:keyword api_version: The Device Provisioning Service API version to use for requests. Default value is the most
recent service version that is compatible with the current SDK. Setting to an older version may result
in reduced feature compatibility.
:paramtype api_version: str or ApiVersion
:ivar enrollment: EnrollmentOperations operations
:vartype enrollment:
~azure.iot.deviceprovisioningservice.operations.EnrollmentOperations
:ivar enrollment_group: EnrollmentGroupOperations operations
:vartype enrollment_group:
~azure.iot.deviceprovisioningservice.operations.EnrollmentGroupOperations
:ivar device_registration_state: DeviceRegistrationStateOperations operations
:vartype device_registration_state:
~azure.iot.deviceprovisioningservice.operations.DeviceRegistrationStateOperations
"""
def __init__(
self,
endpoint: str,
credential: Union[
"TokenCredential", "AzureNamedKeyCredential", "AzureSasCredential"
],
*,
api_version: Union[str, ApiVersion] = DEFAULT_VERSION,
**kwargs,
) -> None:
self._pipeline = self._create_pipeline(
credential=credential, base_url=endpoint, **kwargs
)
# Validate endpoint
try:
if not endpoint.lower().startswith("http"):
endpoint = "https://" + endpoint
except AttributeError:
raise ValueError("Endpoint URL must be a string.")
endpoint = endpoint.rstrip("/")
# Validate api-version
try:
api_version = ApiVersion(api_version).value
except ValueError:
raise ValueError(f"Invalid api-version {api_version} specified")
# Generate base client
super().__init__(
credential=credential, # type: ignore
endpoint=endpoint,
pipeline=self._pipeline,
api_version=api_version,
**kwargs,
)
@classmethod
def from_connection_string(
cls,
connection_string: str,
*,
api_version: Union[str, ApiVersion] = DEFAULT_VERSION,
**kwargs: Any,
) -> "DeviceProvisioningClient":
"""
Create a Provisioning Service Client from a connection string
:param str connection_string: The connection string for the Device Provisioning Service
:keyword api_version: The Device Provisioning Service API version to use for requests. Default value is the most
recent service version that is compatible with the current SDK. Setting to an older version may result
in reduced feature compatibility.
:paramtype api_version: str or ApiVersion
:return: A new instance of :class:`DeviceProvisioningClient
<azure.iot.deviceprovisioningservice.DeviceProvisioningClient>`
:rtype: :class:`DeviceProvisioningClient
<azure.iot.deviceprovisioningservice.DeviceProvisioningClient>`
:raises: ValueError if connection string is invalid
"""
cs_args = parse_connection_string(connection_string)
for k in ["hostname", "sharedaccesskeyname", "sharedaccesskey"]:
if not cs_args.get(k):
raise ValueError(f"IoT DPS connection string has missing property: {k}")
host_name, shared_access_key_name, shared_access_key = (
cs_args["hostname"],
cs_args["sharedaccesskeyname"],
cs_args["sharedaccesskey"],
)
# Create credential from keys
credential = AzureNamedKeyCredential(
name=shared_access_key_name, key=shared_access_key
)
return cls(endpoint=host_name, credential=credential, api_version=api_version, **kwargs) # type: ignore
def _create_pipeline(
self,
credential: Union[
"TokenCredential", "AzureNamedKeyCredential", "AzureSasCredential"
],
base_url: str,
**kwargs,
) -> Pipeline:
transport = kwargs.get("transport") or RequestsTransport(**kwargs)
user_agent_policy = kwargs.get("user_agent_policy") or UserAgentPolicy(
sdk_moniker=f"az-iot-dps-python/{VERSION}", **kwargs
)
# Choose appropriate credential policy
self._credential_policy = None # type: ignore
if hasattr(credential, "get_token"):
self._credential_policy = BearerTokenCredentialPolicy( # type: ignore
credential, "https://azure-devices-provisioning.net/.default" # type: ignore
)
elif isinstance(credential, AzureSasCredential):
self._credential_policy = SasCredentialPolicy(credential=credential) # type: ignore
elif isinstance(credential, AzureNamedKeyCredential):
name = credential.named_key.name
key = credential.named_key.key
self._credential_policy = SharedKeyCredentialPolicy( # type: ignore
endpoint=base_url, key=key, policy_name=name
)
elif credential is not None:
raise TypeError(f"Unsupported credential: {type(credential)}")
policies = [
user_agent_policy,
self._credential_policy, # type: ignore
HeadersPolicy(**kwargs),
UserAgentPolicy(**kwargs),
ContentDecodePolicy(**kwargs),
RetryPolicy(**kwargs),
HttpLoggingPolicy(**kwargs),
DistributedTracingPolicy(**kwargs),
NetworkTraceLoggingPolicy(**kwargs),
]
# add additional policies from kwargs
if kwargs.get("_additional_pipeline_policies"):
policies.extend([kwargs.get("_additional_pipeline_policies")])
return Pipeline(transport, policies=policies) # type: ignore
__all__ = ["DeviceProvisioningClient"]
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
"""
|
