-
Notifications
You must be signed in to change notification settings - Fork 264
/
DeviceCodeCredentialOptions.xml
258 lines (258 loc) · 15.9 KB
/
DeviceCodeCredentialOptions.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
<Type Name="DeviceCodeCredentialOptions" FullName="Azure.Identity.DeviceCodeCredentialOptions">
<TypeSignature Language="C#" Value="public class DeviceCodeCredentialOptions : Azure.Identity.TokenCredentialOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DeviceCodeCredentialOptions extends Azure.Identity.TokenCredentialOptions" />
<TypeSignature Language="DocId" Value="T:Azure.Identity.DeviceCodeCredentialOptions" />
<TypeSignature Language="VB.NET" Value="Public Class DeviceCodeCredentialOptions
Inherits TokenCredentialOptions" />
<TypeSignature Language="F#" Value="type DeviceCodeCredentialOptions = class
 inherit TokenCredentialOptions" />
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.4.1.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>1.6.0.0</AssemblyVersion>
<AssemblyVersion>1.6.1.0</AssemblyVersion>
<AssemblyVersion>1.7.0.0</AssemblyVersion>
<AssemblyVersion>1.8.0.0</AssemblyVersion>
<AssemblyVersion>1.8.1.0</AssemblyVersion>
<AssemblyVersion>1.8.2.0</AssemblyVersion>
<AssemblyVersion>1.9.0.0</AssemblyVersion>
<AssemblyVersion>1.10.0.0</AssemblyVersion>
<AssemblyVersion>1.10.1.0</AssemblyVersion>
<AssemblyVersion>1.10.2.0</AssemblyVersion>
<AssemblyVersion>1.10.3.0</AssemblyVersion>
<AssemblyVersion>1.10.4.0</AssemblyVersion>
<AssemblyVersion>1.11.0.0</AssemblyVersion>
<AssemblyVersion>1.11.1.0</AssemblyVersion>
<AssemblyVersion>1.11.2.0</AssemblyVersion>
<AssemblyVersion>1.11.3.0</AssemblyVersion>
<AssemblyVersion>1.11.4.0</AssemblyVersion>
<AssemblyVersion>1.12.0.0</AssemblyVersion>
<AssemblyVersion>1.12.1.0</AssemblyVersion>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
<AssemblyVersion>1.13.1.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.Identity.TokenCredentialOptions</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Options to configure the <see cref="T:Azure.Identity.DeviceCodeCredential" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DeviceCodeCredentialOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.DeviceCodeCredentialOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
<AssemblyVersion>1.13.1.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AdditionallyAllowedTenants">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> AdditionallyAllowedTenants { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> AdditionallyAllowedTenants" />
<MemberSignature Language="DocId" Value="P:Azure.Identity.DeviceCodeCredentialOptions.AdditionallyAllowedTenants" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property AdditionallyAllowedTenants As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.AdditionallyAllowedTenants : System.Collections.Generic.IList<string>" Usage="Azure.Identity.DeviceCodeCredentialOptions.AdditionallyAllowedTenants" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
<AssemblyVersion>1.13.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Specifies tenants in addition to the specified <see cref="P:Azure.Identity.DeviceCodeCredentialOptions.TenantId" /> for which the credential may acquire tokens.
Add the wildcard value "*" to allow the credential to acquire tokens for any tenant the logged in account can access.
If no value is specified for <see cref="P:Azure.Identity.DeviceCodeCredentialOptions.TenantId" />, this option will have no effect, and the credential will acquire tokens for any requested tenant.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AuthenticationRecord">
<MemberSignature Language="C#" Value="public Azure.Identity.AuthenticationRecord AuthenticationRecord { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Identity.AuthenticationRecord AuthenticationRecord" />
<MemberSignature Language="DocId" Value="P:Azure.Identity.DeviceCodeCredentialOptions.AuthenticationRecord" />
<MemberSignature Language="VB.NET" Value="Public Property AuthenticationRecord As AuthenticationRecord" />
<MemberSignature Language="F#" Value="member this.AuthenticationRecord : Azure.Identity.AuthenticationRecord with get, set" Usage="Azure.Identity.DeviceCodeCredentialOptions.AuthenticationRecord" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
<AssemblyVersion>1.13.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Identity.AuthenticationRecord</ReturnType>
</ReturnValue>
<Docs>
<summary>
The <see cref="T:Azure.Identity.AuthenticationRecord" /> captured from a previous authentication.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ClientId">
<MemberSignature Language="C#" Value="public string ClientId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ClientId" />
<MemberSignature Language="DocId" Value="P:Azure.Identity.DeviceCodeCredentialOptions.ClientId" />
<MemberSignature Language="VB.NET" Value="Public Property ClientId As String" />
<MemberSignature Language="F#" Value="member this.ClientId : string with get, set" Usage="Azure.Identity.DeviceCodeCredentialOptions.ClientId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
<AssemblyVersion>1.13.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The client ID of the application used to authenticate the user. If not specified the user will be authenticated with an Azure development application.
It is recommended that developers register their applications and assign appropriate roles. For more information, visit <see href="https://aka.ms/azsdk/identity/AppRegistrationAndRoleAssignment" />.
If not specified, users will authenticate to an Azure development application, which is not recommended for production scenarios.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeviceCodeCallback">
<MemberSignature Language="C#" Value="public Func<Azure.Identity.DeviceCodeInfo,System.Threading.CancellationToken,System.Threading.Tasks.Task> DeviceCodeCallback { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Func`3<valuetype Azure.Identity.DeviceCodeInfo, valuetype System.Threading.CancellationToken, class System.Threading.Tasks.Task> DeviceCodeCallback" />
<MemberSignature Language="DocId" Value="P:Azure.Identity.DeviceCodeCredentialOptions.DeviceCodeCallback" />
<MemberSignature Language="VB.NET" Value="Public Property DeviceCodeCallback As Func(Of DeviceCodeInfo, CancellationToken, Task)" />
<MemberSignature Language="F#" Value="member this.DeviceCodeCallback : Func<Azure.Identity.DeviceCodeInfo, System.Threading.CancellationToken, System.Threading.Tasks.Task> with get, set" Usage="Azure.Identity.DeviceCodeCredentialOptions.DeviceCodeCallback" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
<AssemblyVersion>1.13.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Func<Azure.Identity.DeviceCodeInfo,System.Threading.CancellationToken,System.Threading.Tasks.Task></ReturnType>
</ReturnValue>
<Docs>
<summary>
The callback which will be executed to display the device code login details to the user. In not specified the device code and login instructions will be printed to the console.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DisableAutomaticAuthentication">
<MemberSignature Language="C#" Value="public bool DisableAutomaticAuthentication { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool DisableAutomaticAuthentication" />
<MemberSignature Language="DocId" Value="P:Azure.Identity.DeviceCodeCredentialOptions.DisableAutomaticAuthentication" />
<MemberSignature Language="VB.NET" Value="Public Property DisableAutomaticAuthentication As Boolean" />
<MemberSignature Language="F#" Value="member this.DisableAutomaticAuthentication : bool with get, set" Usage="Azure.Identity.DeviceCodeCredentialOptions.DisableAutomaticAuthentication" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
<AssemblyVersion>1.13.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Prevents the <see cref="T:Azure.Identity.DeviceCodeCredential" /> from automatically prompting the user. If automatic authentication is disabled a AuthenticationRequiredException will be thrown from <see cref="M:Azure.Identity.DeviceCodeCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" /> and <see cref="M:Azure.Identity.DeviceCodeCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" /> in the case that
user interaction is necessary. The application is responsible for handling this exception, and calling <see cref="M:Azure.Identity.DeviceCodeCredential.Authenticate(System.Threading.CancellationToken)" /> or <see cref="M:Azure.Identity.DeviceCodeCredential.AuthenticateAsync(System.Threading.CancellationToken)" /> to authenticate the user interactively.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DisableInstanceDiscovery">
<MemberSignature Language="C#" Value="public bool DisableInstanceDiscovery { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool DisableInstanceDiscovery" />
<MemberSignature Language="DocId" Value="P:Azure.Identity.DeviceCodeCredentialOptions.DisableInstanceDiscovery" />
<MemberSignature Language="VB.NET" Value="Public Property DisableInstanceDiscovery As Boolean" />
<MemberSignature Language="F#" Value="member this.DisableInstanceDiscovery : bool with get, set" Usage="Azure.Identity.DeviceCodeCredentialOptions.DisableInstanceDiscovery" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
<AssemblyVersion>1.13.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the setting which determines whether or not instance discovery is performed when attempting to authenticate.
Setting this to true will completely disable both instance discovery and authority validation.
This functionality is intended for use in scenarios where the metadata endpoint cannot be reached, such as in private clouds or Azure Stack.
The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority.
By setting this to <c>true</c>, the validation of the authority is disabled.
As a result, it is crucial to ensure that the configured authority host is valid and trustworthy."
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TenantId">
<MemberSignature Language="C#" Value="public string TenantId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string TenantId" />
<MemberSignature Language="DocId" Value="P:Azure.Identity.DeviceCodeCredentialOptions.TenantId" />
<MemberSignature Language="VB.NET" Value="Public Property TenantId As String" />
<MemberSignature Language="F#" Value="member this.TenantId : string with get, set" Usage="Azure.Identity.DeviceCodeCredentialOptions.TenantId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
<AssemblyVersion>1.13.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The tenant ID the user will be authenticated to. If not specified the user will be authenticated to their home tenant.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TokenCachePersistenceOptions">
<MemberSignature Language="C#" Value="public Azure.Identity.TokenCachePersistenceOptions TokenCachePersistenceOptions { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Identity.TokenCachePersistenceOptions TokenCachePersistenceOptions" />
<MemberSignature Language="DocId" Value="P:Azure.Identity.DeviceCodeCredentialOptions.TokenCachePersistenceOptions" />
<MemberSignature Language="VB.NET" Value="Public Property TokenCachePersistenceOptions As TokenCachePersistenceOptions" />
<MemberSignature Language="F#" Value="member this.TokenCachePersistenceOptions : Azure.Identity.TokenCachePersistenceOptions with get, set" Usage="Azure.Identity.DeviceCodeCredentialOptions.TokenCachePersistenceOptions" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
<AssemblyVersion>1.13.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Identity.TokenCachePersistenceOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>
Specifies the <see cref="P:Azure.Identity.DeviceCodeCredentialOptions.TokenCachePersistenceOptions" /> to be used by the credential. If not options are specified, the token cache will not be persisted to disk.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>