-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
ProtectedConfiguration.xml
286 lines (256 loc) · 16.4 KB
/
ProtectedConfiguration.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
<Type Name="ProtectedConfiguration" FullName="System.Configuration.ProtectedConfiguration">
<TypeSignature Language="C#" Value="public static class ProtectedConfiguration" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit ProtectedConfiguration extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Configuration.ProtectedConfiguration" />
<TypeSignature Language="VB.NET" Value="Public Class ProtectedConfiguration" />
<TypeSignature Language="F#" Value="type ProtectedConfiguration = class" />
<TypeSignature Language="C++ CLI" Value="public ref class ProtectedConfiguration abstract sealed" />
<AssemblyInfo>
<AssemblyName>System.Configuration</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Configuration.ConfigurationManager</AssemblyName>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeForwardingChain>
<TypeForwarding From="System.Configuration.ConfigurationManager" FromVersion="9.0.0.0" To="System.Configuration" ToVersion="4.0.0.0" FrameworkAlternate="netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
</TypeForwardingChain>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides access to the protected-configuration providers for the current application's configuration file.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Configuration.ProtectedConfiguration> class allows you to obtain information about the providers available to protect sensitive configuration data. You typically use the standard providers, but you can also create custom providers by deriving from the <xref:System.Configuration.ProtectedConfigurationProvider> class.
For more information about protected configuration, see [Encrypting Configuration Information Using Protected Configuration](https://learn.microsoft.com/previous-versions/aspnet/53tyfkaw(v=vs.100)).
## Examples
The following example shows how to use the <xref:System.Configuration.ProtectedConfiguration> class to retrieve a collection of protected-configuration providers and discover their provider name, RSA provider name, and section names.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Configuration.ProtectedConfiguration/CS/ProtectedConfiguration.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Configuration.ProtectedConfiguration/VB/ProtectedConfiguration.vb" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Configuration.ProtectedConfigurationProvider" />
<altmember cref="T:System.Configuration.ProtectedConfigurationSection" />
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/hh8x3tas(v=vs.100)">Overview of Protected Configuration</related>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/53tyfkaw(v=vs.100)">Encrypting Configuration Information Using Protected Configuration</related>
</Docs>
<Members>
<Member MemberName="DataProtectionProviderName">
<MemberSignature Language="C#" Value="public const string DataProtectionProviderName;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string DataProtectionProviderName" />
<MemberSignature Language="DocId" Value="F:System.Configuration.ProtectedConfiguration.DataProtectionProviderName" />
<MemberSignature Language="VB.NET" Value="Public Const DataProtectionProviderName As String " />
<MemberSignature Language="F#" Value="val mutable DataProtectionProviderName : string" Usage="System.Configuration.ProtectedConfiguration.DataProtectionProviderName" />
<MemberSignature Language="C++ CLI" Value="public: System::String ^ DataProtectionProviderName;" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Configuration</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Configuration.ConfigurationManager</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>The name of the data protection provider.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This a constant string variable that contains the name of the data-protection provider made available by the system to protect a configuration section.
## Examples
The following example shows how to use the <xref:System.Configuration.ProtectedConfiguration.DataProtectionProviderName> property to retrieve the name of the current data-protection provider.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Configuration.ProtectedConfiguration/CS/ProtectedConfiguration.cs" id="Snippet4":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Configuration.ProtectedConfiguration/VB/ProtectedConfiguration.vb" id="Snippet4":::
]]></format>
</remarks>
<altmember cref="T:System.Configuration.ProtectedConfigurationProvider" />
<altmember cref="T:System.Configuration.DpapiProtectedConfigurationProvider" />
</Docs>
</Member>
<Member MemberName="DefaultProvider">
<MemberSignature Language="C#" Value="public static string DefaultProvider { get; }" />
<MemberSignature Language="ILAsm" Value=".property string DefaultProvider" />
<MemberSignature Language="DocId" Value="P:System.Configuration.ProtectedConfiguration.DefaultProvider" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property DefaultProvider As String" />
<MemberSignature Language="F#" Value="static member DefaultProvider : string" Usage="System.Configuration.ProtectedConfiguration.DefaultProvider" />
<MemberSignature Language="C++ CLI" Value="public:
 static property System::String ^ DefaultProvider { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Configuration</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Configuration.ConfigurationManager</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the name of the default protected-configuration provider.</summary>
<value>The name of the default protected-configuration provider.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The default provider is identified by the `defaultProvider` attribute of the `<configProtectedData>` configuration-file element. The value must correspond to the name of one of the providers added in the `<providers>` subsection of the `<configProtectedData>` section. The `<configProtectedData>` section can also be accessed through an instance of the <xref:System.Configuration.ProtectedConfigurationSection> class.
]]></format>
</remarks>
<altmember cref="T:System.Configuration.ProtectedConfigurationProvider" />
<altmember cref="T:System.Configuration.ProtectedConfigurationSection" />
</Docs>
</Member>
<Member MemberName="ProtectedDataSectionName">
<MemberSignature Language="C#" Value="public const string ProtectedDataSectionName;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string ProtectedDataSectionName" />
<MemberSignature Language="DocId" Value="F:System.Configuration.ProtectedConfiguration.ProtectedDataSectionName" />
<MemberSignature Language="VB.NET" Value="Public Const ProtectedDataSectionName As String " />
<MemberSignature Language="F#" Value="val mutable ProtectedDataSectionName : string" Usage="System.Configuration.ProtectedConfiguration.ProtectedDataSectionName" />
<MemberSignature Language="C++ CLI" Value="public: System::String ^ ProtectedDataSectionName;" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Configuration</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Configuration.ConfigurationManager</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>The name of the protected data section.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This is a constant string variable that contains the name of the protected data section.
## Examples
The following example shows how to use the <xref:System.Configuration.ProtectedConfiguration.ProtectedDataSectionName> property to retrieve the name of a protected data section.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Configuration.ProtectedConfiguration/CS/ProtectedConfiguration.cs" id="Snippet6":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Configuration.ProtectedConfiguration/VB/ProtectedConfiguration.vb" id="Snippet6":::
]]></format>
</remarks>
<altmember cref="T:System.Configuration.ProtectedConfigurationProvider" />
<altmember cref="T:System.Configuration.RsaProtectedConfigurationProvider" />
</Docs>
</Member>
<Member MemberName="Providers">
<MemberSignature Language="C#" Value="public static System.Configuration.ProtectedConfigurationProviderCollection Providers { get; }" />
<MemberSignature Language="ILAsm" Value=".property class System.Configuration.ProtectedConfigurationProviderCollection Providers" />
<MemberSignature Language="DocId" Value="P:System.Configuration.ProtectedConfiguration.Providers" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property Providers As ProtectedConfigurationProviderCollection" />
<MemberSignature Language="F#" Value="static member Providers : System.Configuration.ProtectedConfigurationProviderCollection" Usage="System.Configuration.ProtectedConfiguration.Providers" />
<MemberSignature Language="C++ CLI" Value="public:
 static property System::Configuration::ProtectedConfigurationProviderCollection ^ Providers { System::Configuration::ProtectedConfigurationProviderCollection ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Configuration</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Configuration.ConfigurationManager</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Configuration.ProtectedConfigurationProviderCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a collection of the installed protected-configuration providers.</summary>
<value>A <see cref="T:System.Configuration.ProtectedConfigurationProviderCollection" /> collection of installed <see cref="T:System.Configuration.ProtectedConfigurationProvider" /> objects.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows how to use the <xref:System.Configuration.ProtectedConfiguration.Providers%2A> property to retrieve the collection of installed <xref:System.Configuration.ProtectedConfigurationProvider> objects.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Configuration.ProtectedConfiguration/CS/ProtectedConfiguration.cs" id="Snippet3":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Configuration.ProtectedConfiguration/VB/ProtectedConfiguration.vb" id="Snippet3":::
]]></format>
</remarks>
<altmember cref="T:System.Configuration.ProtectedConfigurationProvider" />
</Docs>
</Member>
<Member MemberName="RsaProviderName">
<MemberSignature Language="C#" Value="public const string RsaProviderName;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string RsaProviderName" />
<MemberSignature Language="DocId" Value="F:System.Configuration.ProtectedConfiguration.RsaProviderName" />
<MemberSignature Language="VB.NET" Value="Public Const RsaProviderName As String " />
<MemberSignature Language="F#" Value="val mutable RsaProviderName : string" Usage="System.Configuration.ProtectedConfiguration.RsaProviderName" />
<MemberSignature Language="C++ CLI" Value="public: System::String ^ RsaProviderName;" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Configuration</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Configuration.ConfigurationManager</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>The name of the RSA provider.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This a constant string variable that contains the name of the RSA provider made available by the system to protect a configuration section.
## Examples
The following example shows how to use the <xref:System.Configuration.ProtectedConfiguration.RsaProviderName> property to retrieve the name of the current RSA provider.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Configuration.ProtectedConfiguration/CS/ProtectedConfiguration.cs" id="Snippet5":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Configuration.ProtectedConfiguration/VB/ProtectedConfiguration.vb" id="Snippet5":::
]]></format>
</remarks>
<altmember cref="T:System.Configuration.ProtectedConfigurationProvider" />
<altmember cref="T:System.Configuration.RsaProtectedConfigurationProvider" />
</Docs>
</Member>
</Members>
</Type>