-
Notifications
You must be signed in to change notification settings - Fork 256
/
ClientTwin.xml
727 lines (727 loc) · 39.4 KB
/
ClientTwin.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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
<Type Name="ClientTwin" FullName="Microsoft.Azure.Devices.ClientTwin">
<TypeSignature Language="C#" Value="public class ClientTwin" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ClientTwin extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.ClientTwin" />
<TypeSignature Language="VB.NET" Value="Public Class ClientTwin" />
<TypeSignature Language="F#" Value="type ClientTwin = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Devices.ClientTwinJsonConverter))]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Devices.ClientTwinJsonConverter))>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Properties of a device or module stored on the service.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ClientTwin ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.ClientTwin.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Creates an instance of this class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ClientTwin (Microsoft.Azure.Devices.ClientTwinDocument twinProperties);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Azure.Devices.ClientTwinDocument twinProperties) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.ClientTwin.#ctor(Microsoft.Azure.Devices.ClientTwinDocument)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (twinProperties As ClientTwinDocument)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.ClientTwin : Microsoft.Azure.Devices.ClientTwinDocument -> Microsoft.Azure.Devices.ClientTwin" Usage="new Microsoft.Azure.Devices.ClientTwin twinProperties" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="twinProperties" Type="Microsoft.Azure.Devices.ClientTwinDocument" />
</Parameters>
<Docs>
<param name="twinProperties">Properties of the twin.</param>
<summary>
Creates an instance of this class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ClientTwin (string deviceId);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string deviceId) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.ClientTwin.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (deviceId As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.ClientTwin : string -> Microsoft.Azure.Devices.ClientTwin" Usage="new Microsoft.Azure.Devices.ClientTwin deviceId" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="deviceId" Type="System.String" />
</Parameters>
<Docs>
<param name="deviceId">The unique Id of the device to which the twin belongs.</param>
<summary>
Creates an instance of this class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AuthenticationType">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.ClientAuthenticationType? AuthenticationType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Microsoft.Azure.Devices.ClientAuthenticationType> AuthenticationType" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ClientTwin.AuthenticationType" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property AuthenticationType As Nullable(Of ClientAuthenticationType)" />
<MemberSignature Language="F#" Value="member this.AuthenticationType : Nullable<Microsoft.Azure.Devices.ClientAuthenticationType>" Usage="Microsoft.Azure.Devices.ClientTwin.AuthenticationType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate)]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue(null)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue(null)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<Microsoft.Azure.Devices.ClientAuthenticationType></ReturnType>
</ReturnValue>
<Docs>
<summary>
Corresponding device's authentication type.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Capabilities">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.ClientCapabilities Capabilities { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Devices.ClientCapabilities Capabilities" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ClientTwin.Capabilities" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Capabilities As ClientCapabilities" />
<MemberSignature Language="F#" Value="member this.Capabilities : Microsoft.Azure.Devices.ClientCapabilities" Usage="Microsoft.Azure.Devices.ClientTwin.Capabilities" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.ClientCapabilities</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the twin capabilities.
</summary>
<value>To be added.</value>
<remarks>
Twin capabilities are read only.
</remarks>
</Docs>
</Member>
<Member MemberName="CloudToDeviceMessageCount">
<MemberSignature Language="C#" Value="public int? CloudToDeviceMessageCount { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> CloudToDeviceMessageCount" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ClientTwin.CloudToDeviceMessageCount" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CloudToDeviceMessageCount As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.CloudToDeviceMessageCount : Nullable<int>" Usage="Microsoft.Azure.Devices.ClientTwin.CloudToDeviceMessageCount" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate)]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue(null)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue(null)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Number of messages sent to the corresponding device from the cloud.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Configurations">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary<string,Microsoft.Azure.Devices.ConfigurationInfo> Configurations { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2<string, class Microsoft.Azure.Devices.ConfigurationInfo> Configurations" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ClientTwin.Configurations" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Configurations As IDictionary(Of String, ConfigurationInfo)" />
<MemberSignature Language="F#" Value="member this.Configurations : System.Collections.Generic.IDictionary<string, Microsoft.Azure.Devices.ConfigurationInfo>" Usage="Microsoft.Azure.Devices.ClientTwin.Configurations" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IDictionary<System.String,Microsoft.Azure.Devices.ConfigurationInfo></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the twin configuration properties.
</summary>
<value>To be added.</value>
<remarks>
Configuration properties are read only.
</remarks>
</Docs>
</Member>
<Member MemberName="ConnectionState">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.ClientConnectionState? ConnectionState { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Microsoft.Azure.Devices.ClientConnectionState> ConnectionState" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ClientTwin.ConnectionState" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ConnectionState As Nullable(Of ClientConnectionState)" />
<MemberSignature Language="F#" Value="member this.ConnectionState : Nullable<Microsoft.Azure.Devices.ClientConnectionState>" Usage="Microsoft.Azure.Devices.ClientTwin.ConnectionState" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate)]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue(null)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue(null)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<Microsoft.Azure.Devices.ClientConnectionState></ReturnType>
</ReturnValue>
<Docs>
<summary>
Corresponding device's connection state.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeviceId">
<MemberSignature Language="C#" Value="public string DeviceId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DeviceId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ClientTwin.DeviceId" />
<MemberSignature Language="VB.NET" Value="Public Property DeviceId As String" />
<MemberSignature Language="F#" Value="member this.DeviceId : string with get, set" Usage="Microsoft.Azure.Devices.ClientTwin.DeviceId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets and sets the twin Id.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeviceScope">
<MemberSignature Language="C#" Value="public string DeviceScope { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DeviceScope" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ClientTwin.DeviceScope" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property DeviceScope As String" />
<MemberSignature Language="F#" Value="member this.DeviceScope : string" Usage="Microsoft.Azure.Devices.ClientTwin.DeviceScope" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate)]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue(null)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue(null)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The scope of the device. Auto-generated and immutable for edge devices and modifiable in leaf devices to create child/parent relationship.
</summary>
<value>To be added.</value>
<remarks>
For more information, see <see href="https://docs.microsoft.com/azure/iot-edge/iot-edge-as-gateway?view=iotedge-2020-11#parent-and-child-relationships" />.
</remarks>
</Docs>
</Member>
<Member MemberName="ETag">
<MemberSignature Language="C#" Value="public Azure.ETag ETag { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.ETag ETag" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ClientTwin.ETag" />
<MemberSignature Language="VB.NET" Value="Public Property ETag As ETag" />
<MemberSignature Language="F#" Value="member this.ETag : Azure.ETag with get, set" Usage="Microsoft.Azure.Devices.ClientTwin.ETag" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Devices.NewtonsoftJsonETagConverter))]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Devices.NewtonsoftJsonETagConverter))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="etag")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="etag")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Azure.ETag</ReturnType>
</ReturnValue>
<Docs>
<summary>
Twin's ETag.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LastActiveOnUtc">
<MemberSignature Language="C#" Value="public DateTimeOffset? LastActiveOnUtc { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTimeOffset> LastActiveOnUtc" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ClientTwin.LastActiveOnUtc" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property LastActiveOnUtc As Nullable(Of DateTimeOffset)" />
<MemberSignature Language="F#" Value="member this.LastActiveOnUtc : Nullable<DateTimeOffset>" Usage="Microsoft.Azure.Devices.ClientTwin.LastActiveOnUtc" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate)]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue(null)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue(null)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTimeOffset></ReturnType>
</ReturnValue>
<Docs>
<summary>
Time when the corresponding device was last active.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ModelId">
<MemberSignature Language="C#" Value="public string ModelId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ModelId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ClientTwin.ModelId" />
<MemberSignature Language="VB.NET" Value="Public Property ModelId As String" />
<MemberSignature Language="F#" Value="member this.ModelId : string with get, set" Usage="Microsoft.Azure.Devices.ClientTwin.ModelId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The DTDL model Id of the device or module.
</summary>
<value>To be added.</value>
<remarks>
The value will be null for a non-pnp device.
The value will be null for a pnp device until the device connects and registers with the model Id.
</remarks>
</Docs>
</Member>
<Member MemberName="ModuleId">
<MemberSignature Language="C#" Value="public string ModuleId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ModuleId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ClientTwin.ModuleId" />
<MemberSignature Language="VB.NET" Value="Public Property ModuleId As String" />
<MemberSignature Language="F#" Value="member this.ModuleId : string with get, set" Usage="Microsoft.Azure.Devices.ClientTwin.ModuleId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets and sets the twin module Id.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ParentScopes">
<MemberSignature Language="C#" Value="public virtual System.Collections.Generic.IReadOnlyList<string> ParentScopes { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyList`1<string> ParentScopes" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ClientTwin.ParentScopes" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property ParentScopes As IReadOnlyList(Of String)" />
<MemberSignature Language="F#" Value="member this.ParentScopes : System.Collections.Generic.IReadOnlyList<string>" Usage="Microsoft.Azure.Devices.ClientTwin.ParentScopes" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore)]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
The scopes of the upper level edge devices if applicable. Only available for edge devices.
</summary>
<value>To be added.</value>
<remarks>
For more information, see <see href="https://docs.microsoft.com/azure/iot-edge/iot-edge-as-gateway?view=iotedge-2020-11#parent-and-child-relationships" />.
</remarks>
</Docs>
</Member>
<Member MemberName="Properties">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.ClientTwinDocument Properties { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Devices.ClientTwinDocument Properties" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ClientTwin.Properties" />
<MemberSignature Language="VB.NET" Value="Public Property Properties As ClientTwinDocument" />
<MemberSignature Language="F#" Value="member this.Properties : Microsoft.Azure.Devices.ClientTwinDocument with get, set" Usage="Microsoft.Azure.Devices.ClientTwin.Properties" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.ClientTwinDocument</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets and sets the twin properties.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ShouldSerializeConfigurations">
<MemberSignature Language="C#" Value="public bool ShouldSerializeConfigurations ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool ShouldSerializeConfigurations() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.ClientTwin.ShouldSerializeConfigurations" />
<MemberSignature Language="VB.NET" Value="Public Function ShouldSerializeConfigurations () As Boolean" />
<MemberSignature Language="F#" Value="member this.ShouldSerializeConfigurations : unit -> bool" Usage="clientTwin.ShouldSerializeConfigurations " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
For use in serialization.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ShouldSerializeParentScopes">
<MemberSignature Language="C#" Value="public bool ShouldSerializeParentScopes ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool ShouldSerializeParentScopes() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.ClientTwin.ShouldSerializeParentScopes" />
<MemberSignature Language="VB.NET" Value="Public Function ShouldSerializeParentScopes () As Boolean" />
<MemberSignature Language="F#" Value="member this.ShouldSerializeParentScopes : unit -> bool" Usage="clientTwin.ShouldSerializeParentScopes " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
For use in serialization.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ShouldSerializeTags">
<MemberSignature Language="C#" Value="public bool ShouldSerializeTags ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool ShouldSerializeTags() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.ClientTwin.ShouldSerializeTags" />
<MemberSignature Language="VB.NET" Value="Public Function ShouldSerializeTags () As Boolean" />
<MemberSignature Language="F#" Value="member this.ShouldSerializeTags : unit -> bool" Usage="clientTwin.ShouldSerializeTags " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
For use in serialization.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Status">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.ClientStatus? Status { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Microsoft.Azure.Devices.ClientStatus> Status" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ClientTwin.Status" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Status As Nullable(Of ClientStatus)" />
<MemberSignature Language="F#" Value="member this.Status : Nullable<Microsoft.Azure.Devices.ClientStatus>" Usage="Microsoft.Azure.Devices.ClientTwin.Status" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate)]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue(null)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue(null)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<Microsoft.Azure.Devices.ClientStatus></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the corresponding device's status.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StatusReason">
<MemberSignature Language="C#" Value="public string StatusReason { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string StatusReason" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ClientTwin.StatusReason" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property StatusReason As String" />
<MemberSignature Language="F#" Value="member this.StatusReason : string" Usage="Microsoft.Azure.Devices.ClientTwin.StatusReason" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate)]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue(null)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue(null)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Reason, if any, for the corresponding device to be in specified status.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StatusUpdatedOnUtc">
<MemberSignature Language="C#" Value="public DateTimeOffset? StatusUpdatedOnUtc { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTimeOffset> StatusUpdatedOnUtc" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ClientTwin.StatusUpdatedOnUtc" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property StatusUpdatedOnUtc As Nullable(Of DateTimeOffset)" />
<MemberSignature Language="F#" Value="member this.StatusUpdatedOnUtc : Nullable<DateTimeOffset>" Usage="Microsoft.Azure.Devices.ClientTwin.StatusUpdatedOnUtc" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate)]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue(null)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue(null)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTimeOffset></ReturnType>
</ReturnValue>
<Docs>
<summary>
Time when the corresponding device's status was last updated.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Tags">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary<string,object> Tags { get; protected internal set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2<string, object> Tags" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ClientTwin.Tags" />
<MemberSignature Language="VB.NET" Value="Public Property Tags As IDictionary(Of String, Object)" />
<MemberSignature Language="F#" Value="member this.Tags : System.Collections.Generic.IDictionary<string, obj> with get, set" Usage="Microsoft.Azure.Devices.ClientTwin.Tags" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IDictionary<System.String,System.Object></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets and sets the twin tags.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Version">
<MemberSignature Language="C#" Value="public long? Version { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int64> Version" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ClientTwin.Version" />
<MemberSignature Language="VB.NET" Value="Public Property Version As Nullable(Of Long)" />
<MemberSignature Language="F#" Value="member this.Version : Nullable<int64> with get, set" Usage="Microsoft.Azure.Devices.ClientTwin.Version" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate)]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue(null)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue(null)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int64></ReturnType>
</ReturnValue>
<Docs>
<summary>
Twin's version.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="X509Thumbprint">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.X509Thumbprint X509Thumbprint { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Devices.X509Thumbprint X509Thumbprint" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ClientTwin.X509Thumbprint" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property X509Thumbprint As X509Thumbprint" />
<MemberSignature Language="F#" Value="member this.X509Thumbprint : Microsoft.Azure.Devices.X509Thumbprint" Usage="Microsoft.Azure.Devices.ClientTwin.X509Thumbprint" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate)]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue(null)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue(null)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.X509Thumbprint</ReturnType>
</ReturnValue>
<Docs>
<summary>
Corresponding device's X509 thumbprint.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>