-
Notifications
You must be signed in to change notification settings - Fork 256
/
AuthenticationProviderX509.xml
120 lines (120 loc) · 8.15 KB
/
AuthenticationProviderX509.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
<Type Name="AuthenticationProviderX509" FullName="Microsoft.Azure.Devices.Provisioning.Client.AuthenticationProviderX509">
<TypeSignature Language="C#" Value="public class AuthenticationProviderX509 : Microsoft.Azure.Devices.Provisioning.Client.AuthenticationProvider" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AuthenticationProviderX509 extends Microsoft.Azure.Devices.Provisioning.Client.AuthenticationProvider" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.Provisioning.Client.AuthenticationProviderX509" />
<TypeSignature Language="VB.NET" Value="Public Class AuthenticationProviderX509
Inherits AuthenticationProvider" />
<TypeSignature Language="F#" Value="type AuthenticationProviderX509 = class
 inherit AuthenticationProvider" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Devices.Provisioning.Client.AuthenticationProvider</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The device authentication for using an X509 certificate object.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AuthenticationProviderX509 (System.Security.Cryptography.X509Certificates.X509Certificate2 clientCertificate, System.Security.Cryptography.X509Certificates.X509Certificate2Collection certificateChain = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Security.Cryptography.X509Certificates.X509Certificate2 clientCertificate, class System.Security.Cryptography.X509Certificates.X509Certificate2Collection certificateChain) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.AuthenticationProviderX509.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2,System.Security.Cryptography.X509Certificates.X509Certificate2Collection)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (clientCertificate As X509Certificate2, Optional certificateChain As X509Certificate2Collection = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.Provisioning.Client.AuthenticationProviderX509 : System.Security.Cryptography.X509Certificates.X509Certificate2 * System.Security.Cryptography.X509Certificates.X509Certificate2Collection -> Microsoft.Azure.Devices.Provisioning.Client.AuthenticationProviderX509" Usage="new Microsoft.Azure.Devices.Provisioning.Client.AuthenticationProviderX509 (clientCertificate, certificateChain)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="clientCertificate" Type="System.Security.Cryptography.X509Certificates.X509Certificate2" />
<Parameter Name="certificateChain" Type="System.Security.Cryptography.X509Certificates.X509Certificate2Collection" />
</Parameters>
<Docs>
<param name="clientCertificate">
The client certificate used for authentication. 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.
</param>
<param name="certificateChain">
The certificate chain leading to the root certificate uploaded to the device provisioning service.
</param>
<summary>
Creates an instance of this class.
</summary>
<remarks>
Ensure that you dispose any supplied <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /> after you are done using it to ensure there are no memory leaks.
</remarks>
</Docs>
</Member>
<Member MemberName="CertificateChain">
<MemberSignature Language="C#" Value="public System.Security.Cryptography.X509Certificates.X509Certificate2Collection CertificateChain { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Security.Cryptography.X509Certificates.X509Certificate2Collection CertificateChain" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Client.AuthenticationProviderX509.CertificateChain" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CertificateChain As X509Certificate2Collection" />
<MemberSignature Language="F#" Value="member this.CertificateChain : System.Security.Cryptography.X509Certificates.X509Certificate2Collection" Usage="Microsoft.Azure.Devices.Provisioning.Client.AuthenticationProviderX509.CertificateChain" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Security.Cryptography.X509Certificates.X509Certificate2Collection</ReturnType>
</ReturnValue>
<Docs>
<summary>
The certificate trust chain that will end in the Trusted Root installed on the server side.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ClientCertificate">
<MemberSignature Language="C#" Value="public System.Security.Cryptography.X509Certificates.X509Certificate2 ClientCertificate { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Security.Cryptography.X509Certificates.X509Certificate2 ClientCertificate" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Client.AuthenticationProviderX509.ClientCertificate" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ClientCertificate As X509Certificate2" />
<MemberSignature Language="F#" Value="member this.ClientCertificate : System.Security.Cryptography.X509Certificates.X509Certificate2" Usage="Microsoft.Azure.Devices.Provisioning.Client.AuthenticationProviderX509.ClientCertificate" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Security.Cryptography.X509Certificates.X509Certificate2</ReturnType>
</ReturnValue>
<Docs>
<summary>
The client certificate used for TLS device authentication.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetRegistrationId">
<MemberSignature Language="C#" Value="public override string GetRegistrationId ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string GetRegistrationId() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.AuthenticationProviderX509.GetRegistrationId" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetRegistrationId () As String" />
<MemberSignature Language="F#" Value="override this.GetRegistrationId : unit -> string" Usage="authenticationProviderX509.GetRegistrationId " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
</Type>