-
Notifications
You must be signed in to change notification settings - Fork 261
/
ProvisioningClientTransportSettings.xml
187 lines (185 loc) · 10.7 KB
/
ProvisioningClientTransportSettings.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
<Type Name="ProvisioningClientTransportSettings" FullName="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportSettings">
<TypeSignature Language="C#" Value="public abstract class ProvisioningClientTransportSettings" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ProvisioningClientTransportSettings extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportSettings" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class ProvisioningClientTransportSettings" />
<TypeSignature Language="F#" Value="type ProvisioningClientTransportSettings = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Base class used to define various transport-specific settings for IoT hub device and module clients.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ProvisioningClientTransportSettings ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportSettings.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Protocol">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportProtocol Protocol { get; protected set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportProtocol Protocol" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportSettings.Protocol" />
<MemberSignature Language="VB.NET" Value="Public Property Protocol As ProvisioningClientTransportProtocol" />
<MemberSignature Language="F#" Value="member this.Protocol : Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportProtocol with get, set" Usage="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportSettings.Protocol" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportProtocol</ReturnType>
</ReturnValue>
<Docs>
<summary>
The configured transport protocol.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Proxy">
<MemberSignature Language="C#" Value="public System.Net.IWebProxy Proxy { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.IWebProxy Proxy" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportSettings.Proxy" />
<MemberSignature Language="VB.NET" Value="Public Property Proxy As IWebProxy" />
<MemberSignature Language="F#" Value="member this.Proxy : System.Net.IWebProxy with get, set" Usage="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportSettings.Proxy" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.IWebProxy</ReturnType>
</ReturnValue>
<Docs>
<summary>
The web proxy that will be used to connect to IoT hub using a web socket connection for AMQP or MQTT protocol.
</summary>
<value>To be added.</value>
<remarks>
If you wish to bypass OS-specified proxy settings, set this to <see cref="M:System.Net.GlobalProxySelection.GetEmptyWebProxy" />.
</remarks>
<example>
To set a proxy you must instantiate an instance of the <see cref="T:System.Net.WebProxy" /> class--or any class that derives from <see cref="T:System.Net.IWebProxy" />.
The snippet below shows a method that returns a device using a proxy that connects to localhost on port 8888.
<c>
ProvisioningDeviceClient GetProvisioningDeviceClient()
{
var proxy = new WebProxy("localhost", "8888");
var mqttSettings = new ProvisioningClientMqttSettings()
{
Proxy = proxy
};
var optionsWithProxy = new ProvisioningClientOptions(mqttSettings);
return new ProvisioningDeviceClient(
"global endpoint",
"your id scope",
securityProvider,
optionsWithProxy);
}
</c></example>
</Docs>
</Member>
<Member MemberName="RemoteCertificateValidationCallback">
<MemberSignature Language="C#" Value="public System.Net.Security.RemoteCertificateValidationCallback RemoteCertificateValidationCallback { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.Security.RemoteCertificateValidationCallback RemoteCertificateValidationCallback" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportSettings.RemoteCertificateValidationCallback" />
<MemberSignature Language="VB.NET" Value="Public Property RemoteCertificateValidationCallback As RemoteCertificateValidationCallback" />
<MemberSignature Language="F#" Value="member this.RemoteCertificateValidationCallback : System.Net.Security.RemoteCertificateValidationCallback with get, set" Usage="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportSettings.RemoteCertificateValidationCallback" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Security.RemoteCertificateValidationCallback</ReturnType>
</ReturnValue>
<Docs>
<summary>
A callback for remote certificate validation.
</summary>
<value>To be added.</value>
<remarks>
If incorrectly implemented, your device may fail to connect to IoT hub and/or be open to security vulnerabilities.
<para>
This feature is only applicable for MQTT over TCP, MQTT over web socket, AMQP
over TCP. AMQP web socket communication does not support this feature. For users who want
this support over AMQP websocket, you must instead provide a <see cref="T:System.Net.WebSockets.ClientWebSocket" />
instance with the desired callback and other websocket options (eg. proxy, keep-alive etc.) set.
</para></remarks>
</Docs>
</Member>
<Member MemberName="SslProtocols">
<MemberSignature Language="C#" Value="public System.Security.Authentication.SslProtocols SslProtocols { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Security.Authentication.SslProtocols SslProtocols" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportSettings.SslProtocols" />
<MemberSignature Language="VB.NET" Value="Public Property SslProtocols As SslProtocols" />
<MemberSignature Language="F#" Value="member this.SslProtocols : System.Security.Authentication.SslProtocols with get, set" Usage="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportSettings.SslProtocols" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Security.Authentication.SslProtocols</ReturnType>
</ReturnValue>
<Docs>
<summary>
The version of TLS to use by default.
</summary>
<value>To be added.</value>
<remarks>
Defaults to "None", which means let the OS decide the proper TLS version (SChannel in Windows / OpenSSL in Linux).
</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportSettings.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="provisioningClientTransportSettings.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</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.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>