-
Notifications
You must be signed in to change notification settings - Fork 250
/
Copy pathazure.iot.deviceprovisioning.aio.DeviceProvisioningClient.yml
129 lines (106 loc) · 4.51 KB
/
azure.iot.deviceprovisioning.aio.DeviceProvisioningClient.yml
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
### YamlMime:PythonClass
uid: azure.iot.deviceprovisioning.aio.DeviceProvisioningClient
name: DeviceProvisioningClient
fullName: azure.iot.deviceprovisioning.aio.DeviceProvisioningClient
module: azure.iot.deviceprovisioning.aio
summary: 'API for connecting to, and conducting operations on a Device Provisioning
Service instance
azure.iot.deviceprovisioningservice.aio.operations.EnrollmentOperations
:ivar enrollment_group: EnrollmentGroupOperations operations
:vartype enrollment_group:
azure.iot.deviceprovisioningservice.aio.operations.EnrollmentGroupOperations
:ivar device_registration_state: DeviceRegistrationStateOperations operations
:vartype device_registration_state:
azure.iot.deviceprovisioningservice.aio.operations.DeviceRegistrationStateOperations'
constructor:
syntax: 'DeviceProvisioningClient(endpoint: str, credential: AzureNamedKeyCredential
| AzureSasCredential | AsyncTokenCredential, *, api_version: str | ApiVersion
= ApiVersion.V2021_10_01, **kwargs: Any)'
parameters:
- name: endpoint
description: The HTTP endpoint of the Device Provisioning Service instance
isRequired: true
types:
- <xref:str>
- name: credential
description: The credential type used to authenticate with the Device Provisioning
Service instance
isRequired: true
types:
- <xref:azure.core.credentials.AzureNamedKeyCredential>
- <xref:azure.core.credentials.AzureSasCredential>
- <xref:azure.core.credentials_async.AsyncTokenCredential>
keywordOnlyParameters:
- name: api_version
description: '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.'
defaultValue: ApiVersion.V2021_10_01
types:
- <xref:str>
- <xref:azure.iot.deviceprovisioning.ApiVersion>
variables:
- description: EnrollmentOperations operations
name: enrollment
methods:
- uid: azure.iot.deviceprovisioning.aio.DeviceProvisioningClient.close
name: close
signature: async close() -> None
- uid: azure.iot.deviceprovisioning.aio.DeviceProvisioningClient.from_connection_string
name: from_connection_string
summary: Create a Provisioning Service Client from a connection string
signature: 'from_connection_string(connection_string: str, *, api_version: str |
ApiVersion = ApiVersion.V2021_10_01, **kwargs: Any) -> DeviceProvisioningClient'
parameters:
- name: connection_string
description: The connection string for the Device Provisioning Service instance
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: api_version
description: '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.'
defaultValue: ApiVersion.V2021_10_01
types:
- <xref:str>
- <xref:azure.iot.deviceprovisioning.ApiVersion>
return:
description: A new instance of <xref:azure.iot.deviceprovisioningservice.aio.DeviceProvisioningClient>
types:
- <xref:azure.iot.deviceprovisioning.aio.DeviceProvisioningClient>
exceptions:
- type: ValueError if connection string is invalid
- uid: azure.iot.deviceprovisioning.aio.DeviceProvisioningClient.send_request
name: send_request
summary: '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 = await client.send_request(request)
<AsyncHttpResponse: 200 OK>
```
For more information on this code flow, see [https://aka.ms/azsdk/dpcodegen/python/send_request](https://aka.ms/azsdk/dpcodegen/python/send_request)'
signature: 'send_request(request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHttpResponse]'
parameters:
- name: request
description: The network request you want to make. Required.
isRequired: true
types:
- <xref:azure.core.rest.HttpRequest>
keywordOnlyParameters:
- name: stream
description: Whether the response payload will be streamed. Defaults to False.
types:
- <xref:bool>
return:
description: The response of your network call. Does not do error handling on
your response.
types:
- <xref:azure.core.rest.AsyncHttpResponse>