/
ConfidentialClientApplicationOptions.xml
141 lines (141 loc) · 8.08 KB
/
ConfidentialClientApplicationOptions.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
<Type Name="ConfidentialClientApplicationOptions" FullName="Microsoft.Identity.Client.ConfidentialClientApplicationOptions">
<TypeSignature Language="C#" Value="public class ConfidentialClientApplicationOptions : Microsoft.Identity.Client.ApplicationOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ConfidentialClientApplicationOptions extends Microsoft.Identity.Client.ApplicationOptions" />
<TypeSignature Language="DocId" Value="T:Microsoft.Identity.Client.ConfidentialClientApplicationOptions" />
<TypeSignature Language="VB.NET" Value="Public Class ConfidentialClientApplicationOptions
Inherits ApplicationOptions" />
<TypeSignature Language="F#" Value="type ConfidentialClientApplicationOptions = class
 inherit ApplicationOptions" />
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.48.1.0</AssemblyVersion>
<AssemblyVersion>4.49.1.0</AssemblyVersion>
<AssemblyVersion>4.51.0.0</AssemblyVersion>
<AssemblyVersion>4.52.0.0</AssemblyVersion>
<AssemblyVersion>4.53.0.0</AssemblyVersion>
<AssemblyVersion>4.54.0.0</AssemblyVersion>
<AssemblyVersion>4.54.1.0</AssemblyVersion>
<AssemblyVersion>4.55.0.0</AssemblyVersion>
<AssemblyVersion>4.56.0.0</AssemblyVersion>
<AssemblyVersion>4.57.0.0</AssemblyVersion>
<AssemblyVersion>4.58.0.0</AssemblyVersion>
<AssemblyVersion>4.58.1.0</AssemblyVersion>
<AssemblyVersion>4.59.0.0</AssemblyVersion>
<AssemblyVersion>4.60.0.0</AssemblyVersion>
<AssemblyVersion>4.60.1.0</AssemblyVersion>
<AssemblyVersion>4.60.2.0</AssemblyVersion>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Identity.Client.ApplicationOptions</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Configuration options for a confidential client application
(web app / web API / daemon app). See https://aka.ms/msal-net/application-configuration
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ConfidentialClientApplicationOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.ConfidentialClientApplicationOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AzureRegion">
<MemberSignature Language="C#" Value="public string AzureRegion { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string AzureRegion" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.ConfidentialClientApplicationOptions.AzureRegion" />
<MemberSignature Language="VB.NET" Value="Public Property AzureRegion As String" />
<MemberSignature Language="F#" Value="member this.AzureRegion : string with get, set" Usage="Microsoft.Identity.Client.ConfidentialClientApplicationOptions.AzureRegion" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Instructs MSAL.NET to use an Azure regional token service.
This setting should be set to either the string with the region (preferred) or to
"TryAutoDetect" and MSAL.NET will attempt to auto-detect the region.
</summary>
<value>To be added.</value>
<remarks>
Region names as per <see href="https://learn.microsoft.com/dotnet/api/microsoft.azure.management.resourcemanager.fluent.core.region?view=azure-dotnet-legacy">Region class documentation</see>.
Not all auth flows can use the regional token service.
Service To Service (client credential flow) tokens can be obtained from the regional service.
Requires configuration at the tenant level.
Auto-detection works on a limited number of Azure artifacts (VMs, Azure functions).
If auto-detection fails, the non-regional endpoint will be used.
If an invalid region name is provided, the non-regional endpoint MIGHT be used or the token request MIGHT fail.
See https://aka.ms/msal-net-region-discovery for more details.
</remarks>
</Docs>
</Member>
<Member MemberName="ClientSecret">
<MemberSignature Language="C#" Value="public string ClientSecret { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ClientSecret" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.ConfidentialClientApplicationOptions.ClientSecret" />
<MemberSignature Language="VB.NET" Value="Public Property ClientSecret As String" />
<MemberSignature Language="F#" Value="member this.ClientSecret : string with get, set" Usage="Microsoft.Identity.Client.ConfidentialClientApplicationOptions.ClientSecret" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Client secret for the confidential client application. This secret (application password)
is provided by the application registration portal, or provided to Azure AD during the
application registration with PowerShell AzureAD, PowerShell AzureRM, or Azure CLI.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnableCacheSynchronization">
<MemberSignature Language="C#" Value="public bool EnableCacheSynchronization { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool EnableCacheSynchronization" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.ConfidentialClientApplicationOptions.EnableCacheSynchronization" />
<MemberSignature Language="VB.NET" Value="Public Property EnableCacheSynchronization As Boolean" />
<MemberSignature Language="F#" Value="member this.EnableCacheSynchronization : bool with get, set" Usage="Microsoft.Identity.Client.ConfidentialClientApplicationOptions.EnableCacheSynchronization" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
When set to <c>true</c>, MSAL will lock cache access at the <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplication" /> level, i.e.
the block of code between BeforeAccessAsync and AfterAccessAsync callbacks will be synchronized.
Apps can set this flag to <c>false</c> to enable an optimistic cache locking strategy, which may result in better performance
at the cost of cache consistency.
Setting this flag to <c>false</c> is only recommended for apps which create a new <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplication" /> per request.
</summary>
<value>To be added.</value>
<remarks>
This flag is <c>true</c> by default. The default behavior is recommended.
</remarks>
</Docs>
</Member>
</Members>
</Type>