-
Notifications
You must be signed in to change notification settings - Fork 255
/
AuthenticationWithTokenRefresh.xml
314 lines (314 loc) · 19.4 KB
/
AuthenticationWithTokenRefresh.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
<Type Name="AuthenticationWithTokenRefresh" FullName="Microsoft.Azure.Devices.Client.AuthenticationWithTokenRefresh">
<TypeSignature Language="C#" Value="public abstract class AuthenticationWithTokenRefresh : IDisposable, Microsoft.Azure.Devices.Client.IAuthenticationMethod" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit AuthenticationWithTokenRefresh extends System.Object implements class Microsoft.Azure.Devices.Client.IAuthenticationMethod, class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.Client.AuthenticationWithTokenRefresh" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class AuthenticationWithTokenRefresh
Implements IAuthenticationMethod, IDisposable" />
<TypeSignature Language="F#" Value="type AuthenticationWithTokenRefresh = 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 shared access signature token and allows for token refresh.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AuthenticationWithTokenRefresh (int suggestedTimeToLiveSeconds, int timeBufferPercentage);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 suggestedTimeToLiveSeconds, int32 timeBufferPercentage) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Client.AuthenticationWithTokenRefresh.#ctor(System.Int32,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (suggestedTimeToLiveSeconds As Integer, timeBufferPercentage As Integer)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.Client.AuthenticationWithTokenRefresh : int * int -> Microsoft.Azure.Devices.Client.AuthenticationWithTokenRefresh" Usage="new Microsoft.Azure.Devices.Client.AuthenticationWithTokenRefresh (suggestedTimeToLiveSeconds, timeBufferPercentage)" />
<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="suggestedTimeToLiveSeconds" Type="System.Int32" />
<Parameter Name="timeBufferPercentage" Type="System.Int32" />
</Parameters>
<Docs>
<param name="suggestedTimeToLiveSeconds">Token time to live suggested value. The implementations of this abstract
may choose to ignore this value.</param>
<param name="timeBufferPercentage">Time buffer before expiry when the token should be renewed expressed as
a percentage of the time to live.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Devices.Client.AuthenticationWithTokenRefresh" /> class.
</summary>
<remarks>
This constructor will create an authentication method instance that will be disposed when its
associated device/ module client instance is disposed. To reuse the authentication method instance across
multiple client instance lifetimes, use the <see cref="M:Microsoft.Azure.Devices.Client.AuthenticationWithTokenRefresh.#ctor(System.Int32,System.Int32,System.Boolean)" />
constructor and set <c>disposeWithClient</c> to <c>false</c>.
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AuthenticationWithTokenRefresh (int suggestedTimeToLiveSeconds, int timeBufferPercentage, bool disposeWithClient);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 suggestedTimeToLiveSeconds, int32 timeBufferPercentage, bool disposeWithClient) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Client.AuthenticationWithTokenRefresh.#ctor(System.Int32,System.Int32,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (suggestedTimeToLiveSeconds As Integer, timeBufferPercentage As Integer, disposeWithClient As Boolean)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.Client.AuthenticationWithTokenRefresh : int * int * bool -> Microsoft.Azure.Devices.Client.AuthenticationWithTokenRefresh" Usage="new Microsoft.Azure.Devices.Client.AuthenticationWithTokenRefresh (suggestedTimeToLiveSeconds, timeBufferPercentage, disposeWithClient)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="suggestedTimeToLiveSeconds" Type="System.Int32" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="timeBufferPercentage" Type="System.Int32" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="disposeWithClient" Type="System.Boolean" Index="2" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="disposeWithClient">To be added.</param>
<param name="suggestedTimeToLiveSeconds">Token time to live suggested value. The implementations of this abstract
may choose to ignore this value.</param>
<param name="timeBufferPercentage">Time buffer before expiry when the token should be renewed expressed as
a percentage of the time to live.</param>
<param name="disposeWithClient ">
<c>true</c> if the authentication method should be disposed of by the client
when the client using this instance is itself disposed; <c>false</c> if you intend to reuse the authentication method.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Devices.Client.AuthenticationWithTokenRefresh" /> class.
</summary>
<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.AuthenticationWithTokenRefresh.Dispose" />
<MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="authenticationWithTokenRefresh.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>
Dispose resources
</summary>
<remarks>To be added.</remarks>
</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.Client.AuthenticationWithTokenRefresh.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="authenticationWithTokenRefresh.Dispose disposing" />
<MemberType>Method</MemberType>
<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>
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
<summary>
Releases the unmanaged resources used by the Component and optionally releases the managed resources.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExpiresOn">
<MemberSignature Language="C#" Value="public DateTime ExpiresOn { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime ExpiresOn" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.AuthenticationWithTokenRefresh.ExpiresOn" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ExpiresOn As DateTime" />
<MemberSignature Language="F#" Value="member this.ExpiresOn : DateTime" Usage="Microsoft.Azure.Devices.Client.AuthenticationWithTokenRefresh.ExpiresOn" />
<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.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a snapshot of the UTC token expiry time.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetTokenAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<string> GetTokenAsync (string iotHub);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<string> GetTokenAsync(string iotHub) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Client.AuthenticationWithTokenRefresh.GetTokenAsync(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function GetTokenAsync (iotHub As String) As Task(Of String)" />
<MemberSignature Language="F#" Value="member this.GetTokenAsync : string -> System.Threading.Tasks.Task<string>" Usage="authenticationWithTokenRefresh.GetTokenAsync iotHub" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.String></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="iotHub" Type="System.String" />
</Parameters>
<Docs>
<param name="iotHub">To be added.</param>
<summary>
Gets a snapshot of the security token associated with the device. This call is thread-safe.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsExpiring">
<MemberSignature Language="C#" Value="public bool IsExpiring { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsExpiring" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.AuthenticationWithTokenRefresh.IsExpiring" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsExpiring As Boolean" />
<MemberSignature Language="F#" Value="member this.IsExpiring : bool" Usage="Microsoft.Azure.Devices.Client.AuthenticationWithTokenRefresh.IsExpiring" />
<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.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a snapshot expiry state.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Populate">
<MemberSignature Language="C#" Value="public virtual 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.AuthenticationWithTokenRefresh.Populate(Microsoft.Azure.Devices.Client.IotHubConnectionStringBuilder)" />
<MemberSignature Language="VB.NET" Value="Public Overridable 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="authenticationWithTokenRefresh.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 an <see cref="T:Microsoft.Azure.Devices.Client.IotHubConnectionStringBuilder" /> instance based on a snapshot of 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>
<Member MemberName="RefreshesOn">
<MemberSignature Language="C#" Value="public DateTime RefreshesOn { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime RefreshesOn" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.AuthenticationWithTokenRefresh.RefreshesOn" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property RefreshesOn As DateTime" />
<MemberSignature Language="F#" Value="member this.RefreshesOn : DateTime" Usage="Microsoft.Azure.Devices.Client.AuthenticationWithTokenRefresh.RefreshesOn" />
<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.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a snapshot of the UTC token refresh time.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SafeCreateNewToken">
<MemberSignature Language="C#" Value="protected abstract System.Threading.Tasks.Task<string> SafeCreateNewToken (string iotHub, int suggestedTimeToLive);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Threading.Tasks.Task`1<string> SafeCreateNewToken(string iotHub, int32 suggestedTimeToLive) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Client.AuthenticationWithTokenRefresh.SafeCreateNewToken(System.String,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Function SafeCreateNewToken (iotHub As String, suggestedTimeToLive As Integer) As Task(Of String)" />
<MemberSignature Language="F#" Value="abstract member SafeCreateNewToken : string * int -> System.Threading.Tasks.Task<string>" Usage="authenticationWithTokenRefresh.SafeCreateNewToken (iotHub, suggestedTimeToLive)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.String></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="iotHub" Type="System.String" />
<Parameter Name="suggestedTimeToLive" Type="System.Int32" />
</Parameters>
<Docs>
<param name="iotHub">The IoT hub domain name.</param>
<param name="suggestedTimeToLive">The suggested TTL.</param>
<summary>
Creates a new token with a suggested TTL. This method is thread-safe.
</summary>
<returns>The token string.</returns>
<remarks>This is an asynchronous method and should be awaited.</remarks>
</Docs>
</Member>
</Members>
</Type>