384 lines
25 KiB
XML
384 lines
25 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Microsoft.Extensions.Configuration.UserSecrets</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Microsoft.Extensions.Configuration.UserSecrets.PathHelper">
|
|
<summary>
|
|
Provides paths for user secrets configuration files.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.PathHelper.GetSecretsPathFromSecretsId(System.String)">
|
|
<summary>
|
|
Returns the path to the JSON file that stores user secrets.
|
|
</summary>
|
|
<param name="userSecretsId">The user secret ID.</param>
|
|
<returns>The full path to the secret file.</returns>
|
|
<remarks>
|
|
This method uses the current user profile to locate the secrets
|
|
file on disk in a location outside of source control.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.PathHelper.InternalGetSecretsPathFromSecretsId(System.String,System.Boolean)">
|
|
<summary>
|
|
<para>
|
|
Returns the path to the JSON file that stores user secrets or throws exception if not found.
|
|
</para>
|
|
<para>
|
|
This uses the current user profile to locate the secrets file on disk in a location outside of source control.
|
|
</para>
|
|
</summary>
|
|
<param name="userSecretsId">The user secret ID.</param>
|
|
<param name="throwIfNoRoot">specifies if an exception should be thrown when no root for user secrets is found</param>
|
|
<returns>The full path to the secret file.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute">
|
|
<summary>
|
|
Represents the user secrets ID.
|
|
</summary>
|
|
<remarks>
|
|
In most cases, this attribute is automatically generated during compilation by MSBuild targets
|
|
included in the UserSecrets NuGet package. These targets use the MSBuild property 'UserSecretsId'
|
|
to set the value for <see cref="P:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.UserSecretsId"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.#ctor(System.String)">
|
|
<summary>
|
|
Initializes an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.
|
|
</summary>
|
|
<param name="userSecretId">The user secrets ID.</param>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.UserSecretsId">
|
|
<summary>
|
|
Gets the user secrets ID.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions">
|
|
<summary>
|
|
Provides configuration extensions for adding user secrets configuration source.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
|
<summary>
|
|
<para>
|
|
Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>
|
|
for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
|
</para>
|
|
<para>
|
|
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
|
</para>
|
|
</summary>
|
|
<param name="configuration">The configuration builder.</param>
|
|
<typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>
|
|
<exception cref="T:System.InvalidOperationException">The assembly containing <typeparamref name="T"/> does not have <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
|
<returns>The configuration builder.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Boolean)">
|
|
<summary>
|
|
<para>
|
|
Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>
|
|
for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
|
</para>
|
|
<para>
|
|
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
|
</para>
|
|
</summary>
|
|
<param name="configuration">The configuration builder.</param>
|
|
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
|
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is false and the assembly containing <typeparamref name="T"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
|
<typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>
|
|
<returns>The configuration builder.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
<para>
|
|
Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>
|
|
for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
|
</para>
|
|
<para>
|
|
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
|
</para>
|
|
</summary>
|
|
<param name="configuration">The configuration builder.</param>
|
|
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
|
<param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>
|
|
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is <see langword="false"/> and the assembly containing <typeparamref name="T"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
|
<typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>
|
|
<returns>The configuration builder.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly)">
|
|
<summary>
|
|
<para>
|
|
Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance
|
|
of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
|
</para>
|
|
<para>
|
|
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
|
</para>
|
|
</summary>
|
|
<param name="configuration">The configuration builder.</param>
|
|
<param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>
|
|
<exception cref="T:System.InvalidOperationException"><paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
|
<returns>The configuration builder.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly,System.Boolean)">
|
|
<summary>
|
|
<para>
|
|
Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance
|
|
of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
|
</para>
|
|
<para>
|
|
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
|
</para>
|
|
</summary>
|
|
<param name="configuration">The configuration builder.</param>
|
|
<param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>
|
|
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
|
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is false and <paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
|
<returns>The configuration builder.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
<para>
|
|
Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance
|
|
of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
|
</para>
|
|
<para>
|
|
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
|
</para>
|
|
</summary>
|
|
<param name="configuration">The configuration builder.</param>
|
|
<param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>
|
|
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
|
<param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>
|
|
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is false and <paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
|
<returns>The configuration builder.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)">
|
|
<summary>
|
|
<para>
|
|
Adds the user secrets configuration source with specified user secrets ID.
|
|
</para>
|
|
<para>
|
|
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
|
</para>
|
|
</summary>
|
|
<param name="configuration">The configuration builder.</param>
|
|
<param name="userSecretsId">The user secrets ID.</param>
|
|
<returns>The configuration builder.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String,System.Boolean)">
|
|
<summary>
|
|
<para>
|
|
Adds the user secrets configuration source with specified user secrets ID.
|
|
</para>
|
|
<para>
|
|
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
|
</para>
|
|
</summary>
|
|
<param name="configuration">The configuration builder.</param>
|
|
<param name="userSecretsId">The user secrets ID.</param>
|
|
<param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>
|
|
<returns>The configuration builder.</returns>
|
|
</member>
|
|
<member name="P:System.SR.Common_StringNullOrEmpty">
|
|
<summary>Value cannot be null or an empty string.</summary>
|
|
</member>
|
|
<member name="P:System.SR.Error_Invalid_Character_In_UserSecrets_Id">
|
|
<summary>Invalid character '{0}' found in the user secrets ID at index '{1}'.</summary>
|
|
</member>
|
|
<member name="P:System.SR.Error_Missing_UserSecretsIdAttribute">
|
|
<summary>Could not find 'UserSecretsIdAttribute' on assembly '{0}'.
|
|
Check that the project for '{0}' has set the 'UserSecretsId' build property.
|
|
If the 'UserSecretsId' property is already set then add a reference to the Microsoft.Extensions.Configuration.UserSecret ...</summary>
|
|
</member>
|
|
<member name="P:System.SR.Error_Missing_UserSecretsLocation">
|
|
<summary>Could not determine an appropriate location for storing user secrets. Set the {0} environment variable to a folder where user secrets should be stored.</summary>
|
|
</member>
|
|
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
|
<summary>
|
|
Attribute used to indicate a source generator should create a function for marshalling
|
|
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
|
</summary>
|
|
<remarks>
|
|
This attribute is meaningless if the source generator associated with it is not enabled.
|
|
The current built-in source generator only supports C# and only supplies an implementation when
|
|
applied to static, partial, non-generic methods.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
|
</summary>
|
|
<param name="libraryName">Name of the library containing the import.</param>
|
|
</member>
|
|
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
|
<summary>
|
|
Gets the name of the library containing the import.
|
|
</summary>
|
|
</member>
|
|
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
|
<summary>
|
|
Gets or sets the name of the entry point to be called.
|
|
</summary>
|
|
</member>
|
|
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
|
<summary>
|
|
Gets or sets how to marshal string arguments to the method.
|
|
</summary>
|
|
<remarks>
|
|
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
|
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
|
<summary>
|
|
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
|
</summary>
|
|
<remarks>
|
|
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
|
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
|
<summary>
|
|
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
|
on other platforms) before returning from the attributed method.
|
|
</summary>
|
|
</member>
|
|
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
|
<summary>
|
|
Specifies how strings should be marshalled for generated p/invokes
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
|
<summary>
|
|
Indicates the user is supplying a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
|
<summary>
|
|
Use the platform-provided UTF-8 marshaller.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
|
|
<summary>
|
|
Use the platform-provided UTF-16 marshaller.
|
|
</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
|
|
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
|
|
<summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
|
|
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
|
<summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
|
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
|
<summary>Initializes the attribute with the specified return value condition.</summary>
|
|
<param name="returnValue">
|
|
The return value condition. If the method returns this value, the associated parameter may be null.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
|
<summary>Gets the return value condition.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
|
|
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
|
|
<summary>Initializes the attribute with the specified return value condition.</summary>
|
|
<param name="returnValue">
|
|
The return value condition. If the method returns this value, the associated parameter will not be null.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
|
|
<summary>Gets the return value condition.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
|
|
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
|
|
<summary>Initializes the attribute with the associated parameter name.</summary>
|
|
<param name="parameterName">
|
|
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
|
|
<summary>Gets the associated parameter name.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
|
<summary>Applied to a method that will never return under any circumstance.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
|
|
<summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
|
|
<summary>Initializes the attribute with the specified parameter value.</summary>
|
|
<param name="parameterValue">
|
|
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
|
the associated parameter matches this value.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
|
|
<summary>Gets the condition parameter value.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
|
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
|
<summary>Initializes the attribute with a field or property member.</summary>
|
|
<param name="member">
|
|
The field or property member that is promised to be not-null.
|
|
</param>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
|
<summary>Initializes the attribute with the list of field and property members.</summary>
|
|
<param name="members">
|
|
The list of field and property members that are promised to be not-null.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
|
<summary>Gets field or property member names.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
|
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
|
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
|
<param name="returnValue">
|
|
The return value condition. If the method returns this value, the associated field or property member will not be null.
|
|
</param>
|
|
<param name="member">
|
|
The field or property member that is promised to be not-null.
|
|
</param>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
|
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
|
<param name="returnValue">
|
|
The return value condition. If the method returns this value, the associated field and property members will not be null.
|
|
</param>
|
|
<param name="members">
|
|
The list of field and property members that are promised to be not-null.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
|
<summary>Gets the return value condition.</summary>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
|
<summary>Gets field or property member names.</summary>
|
|
</member>
|
|
<member name="T:System.ExceptionPolyfills">
|
|
<summary>Provides downlevel polyfills for static methods on Exception-derived types.</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|