-
Notifications
You must be signed in to change notification settings - Fork 256
/
DigitalTwinClient.xml
372 lines (372 loc) · 29.3 KB
/
DigitalTwinClient.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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
<Type Name="DigitalTwinClient" FullName="Microsoft.Azure.Devices.DigitalTwinClient">
<TypeSignature Language="C#" Value="public class DigitalTwinClient : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DigitalTwinClient extends System.Object implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.DigitalTwinClient" />
<TypeSignature Language="VB.NET" Value="Public Class DigitalTwinClient
Implements IDisposable" />
<TypeSignature Language="F#" Value="type DigitalTwinClient = class
 interface IDisposable" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.31.0.0</AssemblyVersion>
<AssemblyVersion>1.32.0.0</AssemblyVersion>
<AssemblyVersion>1.33.0.0</AssemblyVersion>
<AssemblyVersion>1.34.0.0</AssemblyVersion>
<AssemblyVersion>1.35.0.0</AssemblyVersion>
<AssemblyVersion>1.36.0.0</AssemblyVersion>
<AssemblyVersion>1.37.0.0</AssemblyVersion>
<AssemblyVersion>1.37.1.0</AssemblyVersion>
<AssemblyVersion>1.38.0.0</AssemblyVersion>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
This client contains methods to retrieve and update digital twin information, and invoke commands
on a digital twin device.
</summary>
<remarks>
For more information, see <see href="https://github.com/Azure/azure-iot-sdk-csharp#iot-hub-service-sdk" />.
<para>
This client creates lifetime long instances of <see cref="T:System.Net.Http.HttpClient" /> that are tied to the URI of the
IoT hub specified, configure any proxy settings, and connection lease timeout.
For that reason, the instances are not static and an application using this client
should create and save it for all use. Repeated creation may cause
<see href="https://docs.microsoft.com/azure/architecture/antipatterns/improper-instantiation/">socket exhaustion</see>.
</para></remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DigitalTwinClient ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.DigitalTwinClient.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Creates an instance of <see cref="T:Microsoft.Azure.Devices.DigitalTwinClient" />, provided for unit testing purposes only.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Create">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Devices.DigitalTwinClient Create (string hostName, Azure.AzureSasCredential credential, params System.Net.Http.DelegatingHandler[] handlers);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Devices.DigitalTwinClient Create(string hostName, class Azure.AzureSasCredential credential, class System.Net.Http.DelegatingHandler[] handlers) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.DigitalTwinClient.Create(System.String,Azure.AzureSasCredential,System.Net.Http.DelegatingHandler[])" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Create (hostName As String, credential As AzureSasCredential, ParamArray handlers As DelegatingHandler()) As DigitalTwinClient" />
<MemberSignature Language="F#" Value="static member Create : string * Azure.AzureSasCredential * System.Net.Http.DelegatingHandler[] -> Microsoft.Azure.Devices.DigitalTwinClient" Usage="Microsoft.Azure.Devices.DigitalTwinClient.Create (hostName, credential, handlers)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.DigitalTwinClient</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="hostName" Type="System.String" />
<Parameter Name="credential" Type="Azure.AzureSasCredential" />
<Parameter Name="handlers" Type="System.Net.Http.DelegatingHandler[]">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ParamArray]</AttributeName>
<AttributeName Language="F#">[<System.ParamArray>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="hostName">IoT hub host name.</param>
<param name="credential">Credential that generates a SAS token to authenticate with IoT hub. See <see cref="T:Azure.AzureSasCredential" />.</param>
<param name="handlers">The delegating handlers to add to the http client pipeline. You can add handlers for tracing, implementing a retry strategy, routing requests through a proxy, etc.</param>
<summary>
Creates DigitalTwinClient using a shared access signature provided and refreshed as necessary by the caller.
</summary>
<returns>A DigitalTwinsClient instance.</returns>
<remarks>
Users may wish to build their own shared access signature (SAS) tokens rather than give the shared key to the SDK and let it manage signing and renewal.
The <see cref="T:Azure.AzureSasCredential" /> object gives the SDK access to the SAS token, while the caller can update it as necessary using the
<see cref="M:Azure.AzureSasCredential.Update(System.String)" /> method.
</remarks>
</Docs>
</Member>
<Member MemberName="Create">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Devices.DigitalTwinClient Create (string hostName, Azure.Core.TokenCredential credential, params System.Net.Http.DelegatingHandler[] handlers);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Devices.DigitalTwinClient Create(string hostName, class Azure.Core.TokenCredential credential, class System.Net.Http.DelegatingHandler[] handlers) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.DigitalTwinClient.Create(System.String,Azure.Core.TokenCredential,System.Net.Http.DelegatingHandler[])" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Create (hostName As String, credential As TokenCredential, ParamArray handlers As DelegatingHandler()) As DigitalTwinClient" />
<MemberSignature Language="F#" Value="static member Create : string * Azure.Core.TokenCredential * System.Net.Http.DelegatingHandler[] -> Microsoft.Azure.Devices.DigitalTwinClient" Usage="Microsoft.Azure.Devices.DigitalTwinClient.Create (hostName, credential, handlers)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.DigitalTwinClient</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="hostName" Type="System.String" />
<Parameter Name="credential" Type="Azure.Core.TokenCredential" />
<Parameter Name="handlers" Type="System.Net.Http.DelegatingHandler[]">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ParamArray]</AttributeName>
<AttributeName Language="F#">[<System.ParamArray>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="hostName">IoT hub host name.</param>
<param name="credential">Azure Active Directory (AAD) credentials to authenticate with IoT hub. See <see cref="T:Azure.Core.TokenCredential" /></param>
<param name="handlers">
The delegating handlers to add to the http client pipeline. You can add handlers for tracing,
implementing a retry strategy, routing requests through a proxy, etc.
</param>
<summary>
Creates DigitalTwinClient, authenticating using an identity in Azure Active Directory (AAD).
</summary>
<returns>A DigitalTwinsClient instance.</returns>
<remarks>
For more about information on the options of authenticating using a derived instance of <see cref="T:Azure.Core.TokenCredential" />, see
<see href="https://docs.microsoft.com/dotnet/api/overview/azure/identity-readme" />.
For more information on configuring IoT hub with Azure Active Directory, see
<see href="https://docs.microsoft.com/azure/iot-hub/iot-hub-dev-guide-azure-ad-rbac" /></remarks>
</Docs>
</Member>
<Member MemberName="CreateFromConnectionString">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Devices.DigitalTwinClient CreateFromConnectionString (string connectionString, params System.Net.Http.DelegatingHandler[] handlers);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Devices.DigitalTwinClient CreateFromConnectionString(string connectionString, class System.Net.Http.DelegatingHandler[] handlers) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.DigitalTwinClient.CreateFromConnectionString(System.String,System.Net.Http.DelegatingHandler[])" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CreateFromConnectionString (connectionString As String, ParamArray handlers As DelegatingHandler()) As DigitalTwinClient" />
<MemberSignature Language="F#" Value="static member CreateFromConnectionString : string * System.Net.Http.DelegatingHandler[] -> Microsoft.Azure.Devices.DigitalTwinClient" Usage="Microsoft.Azure.Devices.DigitalTwinClient.CreateFromConnectionString (connectionString, handlers)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.DigitalTwinClient</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="connectionString" Type="System.String" />
<Parameter Name="handlers" Type="System.Net.Http.DelegatingHandler[]">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ParamArray]</AttributeName>
<AttributeName Language="F#">[<System.ParamArray>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="connectionString">The IoT hub's connection string.</param>
<param name="handlers">
The delegating handlers to add to the http client pipeline.
You can add handlers for tracing, implementing a retry strategy, routing requests through a proxy, etc.
</param>
<summary>
Creates DigitalTwinClient from an IoT hub connection string.
</summary>
<returns>A DigitalTwinsClient instance.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.DigitalTwinClient.Dispose" />
<MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="digitalTwinClient.Dispose " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.DigitalTwinClient.Dispose(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Sub Dispose (disposing As Boolean)" />
<MemberSignature Language="F#" Value="abstract member Dispose : bool -> unit
override this.Dispose : bool -> unit" Usage="digitalTwinClient.Dispose disposing" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="disposing">
<c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
<summary>
Releases unmanaged and - optionally - managed resources.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetDigitalTwinAsync<T>">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<T,Microsoft.Azure.Devices.DigitalTwinGetHeaders>> GetDigitalTwinAsync<T> (string digitalTwinId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`2<!!T, class Microsoft.Azure.Devices.DigitalTwinGetHeaders>> GetDigitalTwinAsync<T>(string digitalTwinId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.DigitalTwinClient.GetDigitalTwinAsync``1(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDigitalTwinAsync(Of T) (digitalTwinId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of T, DigitalTwinGetHeaders))" />
<MemberSignature Language="F#" Value="abstract member GetDigitalTwinAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<'T, Microsoft.Azure.Devices.DigitalTwinGetHeaders>>
override this.GetDigitalTwinAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<'T, Microsoft.Azure.Devices.DigitalTwinGetHeaders>>" Usage="digitalTwinClient.GetDigitalTwinAsync (digitalTwinId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<T,Microsoft.Azure.Devices.DigitalTwinGetHeaders>></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="digitalTwinId" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="digitalTwinId">The Id of the digital twin.</param>
<param name="cancellationToken">The cancellation token.</param>
<summary>
Gets a strongly-typed digital twin.
</summary>
<returns>The application/json digital twin and the http response.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="InvokeCommandAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.Devices.DigitalTwinCommandResponse,Microsoft.Azure.Devices.DigitalTwinInvokeCommandHeaders>> InvokeCommandAsync (string digitalTwinId, string commandName, string payload = default, Microsoft.Azure.Devices.DigitalTwinInvokeCommandRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`2<class Microsoft.Azure.Devices.DigitalTwinCommandResponse, class Microsoft.Azure.Devices.DigitalTwinInvokeCommandHeaders>> InvokeCommandAsync(string digitalTwinId, string commandName, string payload, class Microsoft.Azure.Devices.DigitalTwinInvokeCommandRequestOptions requestOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.DigitalTwinClient.InvokeCommandAsync(System.String,System.String,System.String,Microsoft.Azure.Devices.DigitalTwinInvokeCommandRequestOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function InvokeCommandAsync (digitalTwinId As String, commandName As String, Optional payload As String = Nothing, Optional requestOptions As DigitalTwinInvokeCommandRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of DigitalTwinCommandResponse, DigitalTwinInvokeCommandHeaders))" />
<MemberSignature Language="F#" Value="abstract member InvokeCommandAsync : string * string * string * Microsoft.Azure.Devices.DigitalTwinInvokeCommandRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.Devices.DigitalTwinCommandResponse, Microsoft.Azure.Devices.DigitalTwinInvokeCommandHeaders>>
override this.InvokeCommandAsync : string * string * string * Microsoft.Azure.Devices.DigitalTwinInvokeCommandRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.Devices.DigitalTwinCommandResponse, Microsoft.Azure.Devices.DigitalTwinInvokeCommandHeaders>>" Usage="digitalTwinClient.InvokeCommandAsync (digitalTwinId, commandName, payload, requestOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.Devices.DigitalTwinCommandResponse,Microsoft.Azure.Devices.DigitalTwinInvokeCommandHeaders>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="digitalTwinId" Type="System.String" />
<Parameter Name="commandName" Type="System.String" />
<Parameter Name="payload" Type="System.String" />
<Parameter Name="requestOptions" Type="Microsoft.Azure.Devices.DigitalTwinInvokeCommandRequestOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="digitalTwinId">The Id of the digital twin.</param>
<param name="commandName">The command to be invoked.</param>
<param name="payload">The command payload.</param>
<param name="requestOptions">The optional settings for this request.</param>
<param name="cancellationToken">The cancellationToken.</param>
<summary>
Invoke a command on a digital twin.
</summary>
<returns>The application/json command invocation response and the http response. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="InvokeComponentCommandAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.Devices.DigitalTwinCommandResponse,Microsoft.Azure.Devices.DigitalTwinInvokeCommandHeaders>> InvokeComponentCommandAsync (string digitalTwinId, string componentName, string commandName, string payload = default, Microsoft.Azure.Devices.DigitalTwinInvokeCommandRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`2<class Microsoft.Azure.Devices.DigitalTwinCommandResponse, class Microsoft.Azure.Devices.DigitalTwinInvokeCommandHeaders>> InvokeComponentCommandAsync(string digitalTwinId, string componentName, string commandName, string payload, class Microsoft.Azure.Devices.DigitalTwinInvokeCommandRequestOptions requestOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.DigitalTwinClient.InvokeComponentCommandAsync(System.String,System.String,System.String,System.String,Microsoft.Azure.Devices.DigitalTwinInvokeCommandRequestOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function InvokeComponentCommandAsync (digitalTwinId As String, componentName As String, commandName As String, Optional payload As String = Nothing, Optional requestOptions As DigitalTwinInvokeCommandRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of DigitalTwinCommandResponse, DigitalTwinInvokeCommandHeaders))" />
<MemberSignature Language="F#" Value="abstract member InvokeComponentCommandAsync : string * string * string * string * Microsoft.Azure.Devices.DigitalTwinInvokeCommandRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.Devices.DigitalTwinCommandResponse, Microsoft.Azure.Devices.DigitalTwinInvokeCommandHeaders>>
override this.InvokeComponentCommandAsync : string * string * string * string * Microsoft.Azure.Devices.DigitalTwinInvokeCommandRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.Devices.DigitalTwinCommandResponse, Microsoft.Azure.Devices.DigitalTwinInvokeCommandHeaders>>" Usage="digitalTwinClient.InvokeComponentCommandAsync (digitalTwinId, componentName, commandName, payload, requestOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.Devices.DigitalTwinCommandResponse,Microsoft.Azure.Devices.DigitalTwinInvokeCommandHeaders>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="digitalTwinId" Type="System.String" />
<Parameter Name="componentName" Type="System.String" />
<Parameter Name="commandName" Type="System.String" />
<Parameter Name="payload" Type="System.String" />
<Parameter Name="requestOptions" Type="Microsoft.Azure.Devices.DigitalTwinInvokeCommandRequestOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="digitalTwinId">The Id of the digital twin.</param>
<param name="componentName">The component name under which the command is defined.</param>
<param name="commandName">The command to be invoked.</param>
<param name="payload">The command payload.</param>
<param name="requestOptions">The optional settings for this request.</param>
<param name="cancellationToken">The cancellationToken.</param>
<summary>
Invoke a command on a component of a digital twin.
</summary>
<returns>The application/json command invocation response and the http response.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UpdateDigitalTwinAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationHeaderResponse<Microsoft.Azure.Devices.DigitalTwinUpdateHeaders>> UpdateDigitalTwinAsync (string digitalTwinId, string digitalTwinUpdateOperations, Microsoft.Azure.Devices.DigitalTwinUpdateRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationHeaderResponse`1<class Microsoft.Azure.Devices.DigitalTwinUpdateHeaders>> UpdateDigitalTwinAsync(string digitalTwinId, string digitalTwinUpdateOperations, class Microsoft.Azure.Devices.DigitalTwinUpdateRequestOptions requestOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.DigitalTwinClient.UpdateDigitalTwinAsync(System.String,System.String,Microsoft.Azure.Devices.DigitalTwinUpdateRequestOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateDigitalTwinAsync (digitalTwinId As String, digitalTwinUpdateOperations As String, Optional requestOptions As DigitalTwinUpdateRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationHeaderResponse(Of DigitalTwinUpdateHeaders))" />
<MemberSignature Language="F#" Value="abstract member UpdateDigitalTwinAsync : string * string * Microsoft.Azure.Devices.DigitalTwinUpdateRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationHeaderResponse<Microsoft.Azure.Devices.DigitalTwinUpdateHeaders>>
override this.UpdateDigitalTwinAsync : string * string * Microsoft.Azure.Devices.DigitalTwinUpdateRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationHeaderResponse<Microsoft.Azure.Devices.DigitalTwinUpdateHeaders>>" Usage="digitalTwinClient.UpdateDigitalTwinAsync (digitalTwinId, digitalTwinUpdateOperations, requestOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationHeaderResponse<Microsoft.Azure.Devices.DigitalTwinUpdateHeaders>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="digitalTwinId" Type="System.String" />
<Parameter Name="digitalTwinUpdateOperations" Type="System.String" />
<Parameter Name="requestOptions" Type="Microsoft.Azure.Devices.DigitalTwinUpdateRequestOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="digitalTwinId">The Id of the digital twin.</param>
<param name="digitalTwinUpdateOperations">The application/json-patch+json operations to be performed on the specified digital twin.</param>
<param name="requestOptions">The optional settings for this request.</param>
<param name="cancellationToken">The cancellationToken.</param>
<summary>
Updates a digital twin.
</summary>
<returns>The http response.</returns>
<remarks>
For further information on how to create the json-patch, see <see href="https://docs.microsoft.com/azure/iot-pnp/howto-manage-digital-twin" />.
</remarks>
</Docs>
</Member>
</Members>
</Type>