-
Notifications
You must be signed in to change notification settings - Fork 259
/
ProvisioningDeviceClient.xml
278 lines (278 loc) · 23.9 KB
/
ProvisioningDeviceClient.xml
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
<Type Name="ProvisioningDeviceClient" FullName="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient">
<TypeSignature Language="C#" Value="public class ProvisioningDeviceClient" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ProvisioningDeviceClient extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient" />
<TypeSignature Language="VB.NET" Value="Public Class ProvisioningDeviceClient" />
<TypeSignature Language="F#" Value="type ProvisioningDeviceClient = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>1.16.3.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
<AssemblyVersion>1.17.1.0</AssemblyVersion>
<AssemblyVersion>1.18.0.0</AssemblyVersion>
<AssemblyVersion>1.19.0.0</AssemblyVersion>
<AssemblyVersion>1.19.1.0</AssemblyVersion>
<AssemblyVersion>1.19.2.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The client for provisioning devices using Azure Device Provisioning Service.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ProvisioningDeviceClient (string globalDeviceEndpoint, string idScope, Microsoft.Azure.Devices.Provisioning.Client.AuthenticationProvider authenticationProvider, Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientOptions options = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string globalDeviceEndpoint, string idScope, class Microsoft.Azure.Devices.Provisioning.Client.AuthenticationProvider authenticationProvider, class Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient.#ctor(System.String,System.String,Microsoft.Azure.Devices.Provisioning.Client.AuthenticationProvider,Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (globalDeviceEndpoint As String, idScope As String, authenticationProvider As AuthenticationProvider, Optional options As ProvisioningClientOptions = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient : string * string * Microsoft.Azure.Devices.Provisioning.Client.AuthenticationProvider * Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientOptions -> Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient" Usage="new Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient (globalDeviceEndpoint, idScope, authenticationProvider, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="globalDeviceEndpoint" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="idScope" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="authenticationProvider" Type="Microsoft.Azure.Devices.Provisioning.Client.AuthenticationProvider" Index="2" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="options" Type="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientOptions" Index="3" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="globalDeviceEndpoint">The GlobalDeviceEndpoint for the Device Provisioning Service.</param>
<param name="idScope">The IDScope for the Device Provisioning Service.</param>
<param name="authenticationProvider">The security provider instance.</param>
<param name="options">The options that allow configuration of the provisioning device client instance during initialization.</param>
<summary>
Creates an instance of this class.
</summary>
<returns>An instance of the ProvisioningDeviceClient</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Create">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient Create (string globalDeviceEndpoint, string idScope, Microsoft.Azure.Devices.Shared.SecurityProvider securityProvider, Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportHandler transport);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient Create(string globalDeviceEndpoint, string idScope, class Microsoft.Azure.Devices.Shared.SecurityProvider securityProvider, class Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportHandler transport) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient.Create(System.String,System.String,Microsoft.Azure.Devices.Shared.SecurityProvider,Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportHandler)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Create (globalDeviceEndpoint As String, idScope As String, securityProvider As SecurityProvider, transport As ProvisioningTransportHandler) As ProvisioningDeviceClient" />
<MemberSignature Language="F#" Value="static member Create : string * string * Microsoft.Azure.Devices.Shared.SecurityProvider * Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportHandler -> Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient" Usage="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient.Create (globalDeviceEndpoint, idScope, securityProvider, transport)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>1.19.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="globalDeviceEndpoint" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="idScope" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="securityProvider" Type="Microsoft.Azure.Devices.Shared.SecurityProvider" Index="2" FrameworkAlternate="azure-dotnet" />
<Parameter Name="transport" Type="Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportHandler" Index="3" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="globalDeviceEndpoint">The GlobalDeviceEndpoint for the Device Provisioning Service.</param>
<param name="idScope">The IDScope for the Device Provisioning Service.</param>
<param name="securityProvider">The security provider instance.</param>
<param name="transport">The type of transport (e.g. HTTP, AMQP, MQTT).</param>
<summary>
Creates an instance of the Device Provisioning Client.
</summary>
<returns>An instance of the ProvisioningDeviceClient</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ProductInfo">
<MemberSignature Language="C#" Value="public string ProductInfo { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ProductInfo" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient.ProductInfo" />
<MemberSignature Language="VB.NET" Value="Public Property ProductInfo As String" />
<MemberSignature Language="F#" Value="member this.ProductInfo : string with get, set" Usage="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient.ProductInfo" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>1.19.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Stores product information that will be appended to the user agent string that is sent to IoT hub.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RegisterAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult> RegisterAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult> RegisterAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient.RegisterAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function RegisterAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of DeviceRegistrationResult)" />
<MemberSignature Language="F#" Value="member this.RegisterAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult>" Usage="provisioningDeviceClient.RegisterAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>1.19.1.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">The cancellation token.</param>
<summary>
Registers the current device using the Device Provisioning Service and assigns it to an IoT hub.
</summary>
<returns>The registration result.</returns>
<remarks>
Due to the AMQP library used by this library uses not accepting cancellation tokens, the provided cancellation token will only be checked
for cancellation in between AMQP operations, and not during. In order to have a timeout for this operation that is checked during AMQP operations
(such as opening the connection), you must use <see cref="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient.RegisterAsync(System.TimeSpan)" /> instead. MQTT and HTTPS connections do not have the same
behavior as AMQP connections in this regard. MQTT and HTTPS connections will check this cancellation token for cancellation during their protocol level operations.
</remarks>
</Docs>
</Member>
<Member MemberName="RegisterAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult> RegisterAsync (TimeSpan timeout);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult> RegisterAsync(valuetype System.TimeSpan timeout) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient.RegisterAsync(System.TimeSpan)" />
<MemberSignature Language="VB.NET" Value="Public Function RegisterAsync (timeout As TimeSpan) As Task(Of DeviceRegistrationResult)" />
<MemberSignature Language="F#" Value="member this.RegisterAsync : TimeSpan -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult>" Usage="provisioningDeviceClient.RegisterAsync timeout" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>1.19.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="timeout" Type="System.TimeSpan" Index="0" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="timeout">The maximum amount of time to allow this operation to run for before timing out.</param>
<summary>
Registers the current device using the Device Provisioning Service and assigns it to an IoT hub.
</summary>
<returns>The registration result.</returns>
<remarks>
Due to the AMQP library used by this library uses not accepting cancellation tokens, this overload and <see cref="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient.RegisterAsync(Microsoft.Azure.Devices.Provisioning.Client.ProvisioningRegistrationAdditionalData,System.TimeSpan)" />
are the only overloads for this method that allow for a specified timeout to be respected in the middle of an AMQP operation such as opening
the AMQP connection. MQTT and HTTPS connections do not share that same limitation, though.
</remarks>
</Docs>
</Member>
<Member MemberName="RegisterAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult> RegisterAsync (Microsoft.Azure.Devices.Provisioning.Client.ProvisioningRegistrationAdditionalData data, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult> RegisterAsync(class Microsoft.Azure.Devices.Provisioning.Client.ProvisioningRegistrationAdditionalData data, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient.RegisterAsync(Microsoft.Azure.Devices.Provisioning.Client.ProvisioningRegistrationAdditionalData,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function RegisterAsync (data As ProvisioningRegistrationAdditionalData, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DeviceRegistrationResult)" />
<MemberSignature Language="F#" Value="member this.RegisterAsync : Microsoft.Azure.Devices.Provisioning.Client.ProvisioningRegistrationAdditionalData * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult>" Usage="provisioningDeviceClient.RegisterAsync (data, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>1.19.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningRegistrationAdditionalData" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="data">
The optional additional data that is passed through to the custom allocation policy webhook if
a custom allocation policy webhook is setup for this enrollment.
</param>
<param name="cancellationToken">The cancellation token.</param>
<summary>
Registers the current device using the Device Provisioning Service and assigns it to an IoT hub.
</summary>
<returns>The registration result.</returns>
<remarks>
Due to the AMQP library used by this library uses not accepting cancellation tokens, the provided cancellation token will only be checked
for cancellation in between AMQP operations, and not during. In order to have a timeout for this operation that is checked during AMQP operations
(such as opening the connection), you must use <see cref="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient.RegisterAsync(Microsoft.Azure.Devices.Provisioning.Client.ProvisioningRegistrationAdditionalData,System.TimeSpan)">this overload</see> instead.
MQTT and HTTPS connections do not have the same behavior as AMQP connections in this regard. MQTT and HTTPS connections will check this cancellation
token for cancellation during their protocol level operations.
</remarks>
</Docs>
</Member>
<Member MemberName="RegisterAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult> RegisterAsync (Microsoft.Azure.Devices.Provisioning.Client.ProvisioningRegistrationAdditionalData data, TimeSpan timeout);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult> RegisterAsync(class Microsoft.Azure.Devices.Provisioning.Client.ProvisioningRegistrationAdditionalData data, valuetype System.TimeSpan timeout) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient.RegisterAsync(Microsoft.Azure.Devices.Provisioning.Client.ProvisioningRegistrationAdditionalData,System.TimeSpan)" />
<MemberSignature Language="VB.NET" Value="Public Function RegisterAsync (data As ProvisioningRegistrationAdditionalData, timeout As TimeSpan) As Task(Of DeviceRegistrationResult)" />
<MemberSignature Language="F#" Value="member this.RegisterAsync : Microsoft.Azure.Devices.Provisioning.Client.ProvisioningRegistrationAdditionalData * TimeSpan -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult>" Usage="provisioningDeviceClient.RegisterAsync (data, timeout)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>1.19.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningRegistrationAdditionalData" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="timeout" Type="System.TimeSpan" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="data">
The optional additional data that is passed through to the custom allocation policy webhook if
a custom allocation policy webhook is setup for this enrollment.
</param>
<param name="timeout">The maximum amount of time to allow this operation to run for before timing out.</param>
<summary>
Registers the current device using the Device Provisioning Service and assigns it to an IoT hub.
</summary>
<returns>The registration result.</returns>
<remarks>
Due to the AMQP library used by this library uses not accepting cancellation tokens, this overload and <see cref="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient.RegisterAsync(System.TimeSpan)" />
are the only overloads for this method that allow for a specified timeout to be respected in the middle of an AMQP operation such as opening
the AMQP connection. MQTT and HTTPS connections do not share that same limitation, though.
</remarks>
</Docs>
</Member>
<Member MemberName="RegisterAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult> RegisterAsync (Microsoft.Azure.Devices.Provisioning.Client.RegistrationRequestPayload data, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult> RegisterAsync(class Microsoft.Azure.Devices.Provisioning.Client.RegistrationRequestPayload data, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningDeviceClient.RegisterAsync(Microsoft.Azure.Devices.Provisioning.Client.RegistrationRequestPayload,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function RegisterAsync (data As RegistrationRequestPayload, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DeviceRegistrationResult)" />
<MemberSignature Language="F#" Value="member this.RegisterAsync : Microsoft.Azure.Devices.Provisioning.Client.RegistrationRequestPayload * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult>" Usage="provisioningDeviceClient.RegisterAsync (data, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="Microsoft.Azure.Devices.Provisioning.Client.RegistrationRequestPayload" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="data">
The optional additional data that is passed through to the custom allocation policy webhook if
a custom allocation policy webhook is setup for this enrollment.
</param>
<param name="cancellationToken">The cancellation token.</param>
<summary>
Registers the current device using the Device Provisioning Service and assigns it to an IoT hub.
</summary>
<returns>The registration result.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>