/
DeviceAuthenticationWithX509Certificate.xml
201 lines (201 loc) · 13.3 KB
/
DeviceAuthenticationWithX509Certificate.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
<Type Name="DeviceAuthenticationWithX509Certificate" FullName="Microsoft.Azure.Devices.Client.DeviceAuthenticationWithX509Certificate">
<TypeSignature Language="C#" Value="public sealed class DeviceAuthenticationWithX509Certificate : IDisposable, Microsoft.Azure.Devices.Client.IAuthenticationMethod" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit DeviceAuthenticationWithX509Certificate extends System.Object implements class Microsoft.Azure.Devices.Client.IAuthenticationMethod, class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.Client.DeviceAuthenticationWithX509Certificate" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class DeviceAuthenticationWithX509Certificate
Implements IAuthenticationMethod, IDisposable" />
<TypeSignature Language="F#" Value="type DeviceAuthenticationWithX509Certificate = class
 interface IAuthenticationMethod
 interface IDisposable" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.31.2.0</AssemblyVersion>
<AssemblyVersion>1.32.0.0</AssemblyVersion>
<AssemblyVersion>1.36.0.0</AssemblyVersion>
<AssemblyVersion>1.36.1.0</AssemblyVersion>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.37.0.0</AssemblyVersion>
<AssemblyVersion>1.37.1.0</AssemblyVersion>
<AssemblyVersion>1.37.2.0</AssemblyVersion>
<AssemblyVersion>1.38.0.0</AssemblyVersion>
<AssemblyVersion>1.39.0.0</AssemblyVersion>
<AssemblyVersion>1.40.0.0</AssemblyVersion>
<AssemblyVersion>1.41.0.0</AssemblyVersion>
<AssemblyVersion>1.41.1.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Azure.Devices.Client.IAuthenticationMethod</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Authentication method that uses a X.509 certificate
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DeviceAuthenticationWithX509Certificate (string deviceId, System.Security.Cryptography.X509Certificates.X509Certificate2 certificate, System.Security.Cryptography.X509Certificates.X509Certificate2Collection chainCertificates = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string deviceId, class System.Security.Cryptography.X509Certificates.X509Certificate2 certificate, class System.Security.Cryptography.X509Certificates.X509Certificate2Collection chainCertificates) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Client.DeviceAuthenticationWithX509Certificate.#ctor(System.String,System.Security.Cryptography.X509Certificates.X509Certificate2,System.Security.Cryptography.X509Certificates.X509Certificate2Collection)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (deviceId As String, certificate As X509Certificate2, Optional chainCertificates As X509Certificate2Collection = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.Client.DeviceAuthenticationWithX509Certificate : string * System.Security.Cryptography.X509Certificates.X509Certificate2 * System.Security.Cryptography.X509Certificates.X509Certificate2Collection -> Microsoft.Azure.Devices.Client.DeviceAuthenticationWithX509Certificate" Usage="new Microsoft.Azure.Devices.Client.DeviceAuthenticationWithX509Certificate (deviceId, certificate, chainCertificates)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="deviceId" Type="System.String" />
<Parameter Name="certificate" Type="System.Security.Cryptography.X509Certificates.X509Certificate2" />
<Parameter Name="chainCertificates" Type="System.Security.Cryptography.X509Certificates.X509Certificate2Collection" />
</Parameters>
<Docs>
<param name="deviceId">Device Identifier.</param>
<param name="certificate">X.509 Certificate.</param>
<param name="chainCertificates">Certificates in the device certificate chain.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Devices.Client.DeviceAuthenticationWithX509Certificate" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Certificate">
<MemberSignature Language="C#" Value="public System.Security.Cryptography.X509Certificates.X509Certificate2 Certificate { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Security.Cryptography.X509Certificates.X509Certificate2 Certificate" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.DeviceAuthenticationWithX509Certificate.Certificate" />
<MemberSignature Language="VB.NET" Value="Public Property Certificate As X509Certificate2" />
<MemberSignature Language="F#" Value="member this.Certificate : System.Security.Cryptography.X509Certificates.X509Certificate2 with get, set" Usage="Microsoft.Azure.Devices.Client.DeviceAuthenticationWithX509Certificate.Certificate" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Security.Cryptography.X509Certificates.X509Certificate2</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the X.509 certificate associated with this device.
The private key should be available in the <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /> object,
or should be available in the certificate store of the system where the client will be authenticated from.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ChainCertificates">
<MemberSignature Language="C#" Value="public System.Security.Cryptography.X509Certificates.X509Certificate2Collection ChainCertificates { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Security.Cryptography.X509Certificates.X509Certificate2Collection ChainCertificates" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.DeviceAuthenticationWithX509Certificate.ChainCertificates" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ChainCertificates As X509Certificate2Collection" />
<MemberSignature Language="F#" Value="member this.ChainCertificates : System.Security.Cryptography.X509Certificates.X509Certificate2Collection" Usage="Microsoft.Azure.Devices.Client.DeviceAuthenticationWithX509Certificate.ChainCertificates" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Security.Cryptography.X509Certificates.X509Certificate2Collection</ReturnType>
</ReturnValue>
<Docs>
<summary>
Full chain of certificates from the one used to sign the device certificate to the one uploaded to the
service. Private keys are not required for these certificates.
This is only supported on AMQP_Tcp_Only and Mqtt_Tcp_Only
</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.Client.DeviceAuthenticationWithX509Certificate.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.Client.DeviceAuthenticationWithX509Certificate.DeviceId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the device identifier.
</summary>
<value>To be added.</value>
<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.Client.DeviceAuthenticationWithX509Certificate.Dispose" />
<MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="deviceAuthenticationWithX509Certificate.Dispose " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
The <see cref="P:Microsoft.Azure.Devices.Client.DeviceAuthenticationWithX509Certificate.Certificate" /> managed resource should be disposed by the user.
This library intentionally does not dispose it here since the user might want to
reuse the certificate instance elsewhere for some other operation.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Populate">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.Client.IotHubConnectionStringBuilder Populate (Microsoft.Azure.Devices.Client.IotHubConnectionStringBuilder iotHubConnectionStringBuilder);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Devices.Client.IotHubConnectionStringBuilder Populate(class Microsoft.Azure.Devices.Client.IotHubConnectionStringBuilder iotHubConnectionStringBuilder) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Client.DeviceAuthenticationWithX509Certificate.Populate(Microsoft.Azure.Devices.Client.IotHubConnectionStringBuilder)" />
<MemberSignature Language="VB.NET" Value="Public Function Populate (iotHubConnectionStringBuilder As IotHubConnectionStringBuilder) As IotHubConnectionStringBuilder" />
<MemberSignature Language="F#" Value="abstract member Populate : Microsoft.Azure.Devices.Client.IotHubConnectionStringBuilder -> Microsoft.Azure.Devices.Client.IotHubConnectionStringBuilder
override this.Populate : Microsoft.Azure.Devices.Client.IotHubConnectionStringBuilder -> Microsoft.Azure.Devices.Client.IotHubConnectionStringBuilder" Usage="deviceAuthenticationWithX509Certificate.Populate iotHubConnectionStringBuilder" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.Devices.Client.IAuthenticationMethod.Populate(Microsoft.Azure.Devices.Client.IotHubConnectionStringBuilder)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.Client.IotHubConnectionStringBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="iotHubConnectionStringBuilder" Type="Microsoft.Azure.Devices.Client.IotHubConnectionStringBuilder" />
</Parameters>
<Docs>
<param name="iotHubConnectionStringBuilder">Instance to populate.</param>
<summary>
Populates a supplied instance based on the properties of the current instance.
</summary>
<returns>The populated <see cref="T:Microsoft.Azure.Devices.Client.IotHubConnectionStringBuilder" /> instance.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>