526 lines
32 KiB
XML
526 lines
32 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>OpenTelemetry.Instrumentation.Http</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:OpenTelemetry.Instrumentation.Http.HttpClientInstrumentation">
|
|
<summary>
|
|
HttpClient instrumentation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Instrumentation.Http.HttpClientInstrumentation.#ctor(OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Instrumentation.Http.HttpClientInstrumentation"/> class.
|
|
</summary>
|
|
<param name="options">Configuration options for HTTP client instrumentation.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Instrumentation.Http.HttpClientInstrumentation.Dispose">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Instrumentation.Http.HttpClientMetrics">
|
|
<summary>
|
|
HttpClient instrumentation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Instrumentation.Http.HttpClientMetrics.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Instrumentation.Http.HttpClientMetrics"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Instrumentation.Http.HttpClientMetrics.Dispose">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions">
|
|
<summary>
|
|
Options for HttpClient instrumentation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.FilterHttpRequestMessage">
|
|
<summary>
|
|
Gets or sets a filter function that determines whether or not to
|
|
collect telemetry on a per request basis.
|
|
</summary>
|
|
<remarks>
|
|
<para><b>FilterHttpRequestMessage is only executed on .NET and .NET
|
|
Core runtimes. <see cref="T:System.Net.Http.HttpClient"/> and <see
|
|
cref="T:System.Net.HttpWebRequest"/> on .NET and .NET Core are both implemented
|
|
using <see cref="T:System.Net.Http.HttpRequestMessage"/>.</b></para>
|
|
Notes:
|
|
<list type="bullet">
|
|
<item>The return value for the filter function is interpreted as:
|
|
<list type="bullet">
|
|
<item>If filter returns <see langword="true" />, the request is
|
|
collected.</item>
|
|
<item>If filter returns <see langword="false" /> or throws an
|
|
exception the request is NOT collected.</item>
|
|
</list></item>
|
|
</list>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.EnrichWithHttpRequestMessage">
|
|
<summary>
|
|
Gets or sets an action to enrich an <see cref="T:System.Diagnostics.Activity"/> with <see cref="T:System.Net.Http.HttpRequestMessage"/>.
|
|
</summary>
|
|
<remarks>
|
|
<para><b>EnrichWithHttpRequestMessage is only executed on .NET and .NET
|
|
Core runtimes. <see cref="T:System.Net.Http.HttpClient"/> and <see
|
|
cref="T:System.Net.HttpWebRequest"/> on .NET and .NET Core are both implemented
|
|
using <see cref="T:System.Net.Http.HttpRequestMessage"/>.</b></para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.EnrichWithHttpResponseMessage">
|
|
<summary>
|
|
Gets or sets an action to enrich an <see cref="T:System.Diagnostics.Activity"/> with <see cref="T:System.Net.Http.HttpResponseMessage"/>.
|
|
</summary>
|
|
<remarks>
|
|
<para><b>EnrichWithHttpResponseMessage is only executed on .NET and .NET
|
|
Core runtimes. <see cref="T:System.Net.Http.HttpClient"/> and <see
|
|
cref="T:System.Net.HttpWebRequest"/> on .NET and .NET Core are both implemented
|
|
using <see cref="T:System.Net.Http.HttpRequestMessage"/>.</b></para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.EnrichWithException">
|
|
<summary>
|
|
Gets or sets an action to enrich an <see cref="T:System.Diagnostics.Activity"/> with <see cref="T:System.Exception"/>.
|
|
</summary>
|
|
<remarks>
|
|
<para><b>EnrichWithException is called for all runtimes.</b></para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.FilterHttpWebRequest">
|
|
<summary>
|
|
Gets or sets a filter function that determines whether or not to
|
|
collect telemetry on a per request basis.
|
|
</summary>
|
|
<remarks>
|
|
<para><b>FilterHttpWebRequest is only executed on .NET Framework
|
|
runtimes. <see cref="T:System.Net.Http.HttpClient"/> and <see cref="T:System.Net.HttpWebRequest"/>
|
|
on .NET Framework are both implemented using <see
|
|
cref="T:System.Net.HttpWebRequest"/>.</b></para>
|
|
Notes:
|
|
<list type="bullet">
|
|
<item>The return value for the filter function is interpreted as:
|
|
<list type="bullet">
|
|
<item>If filter returns <see langword="true" />, the request is
|
|
collected.</item>
|
|
<item>If filter returns <see langword="false" /> or throws an
|
|
exception the request is NOT collected.</item>
|
|
</list></item>
|
|
</list>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.EnrichWithHttpWebRequest">
|
|
<summary>
|
|
Gets or sets an action to enrich an <see cref="T:System.Diagnostics.Activity"/> with <see cref="T:System.Net.HttpWebRequest"/>.
|
|
</summary>
|
|
<remarks>
|
|
<para><b>EnrichWithHttpWebRequest is only executed on .NET Framework
|
|
runtimes. <see cref="T:System.Net.Http.HttpClient"/> and <see cref="T:System.Net.HttpWebRequest"/>
|
|
on .NET Framework are both implemented using <see
|
|
cref="T:System.Net.HttpWebRequest"/>.</b></para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.EnrichWithHttpWebResponse">
|
|
<summary>
|
|
Gets or sets an action to enrich an <see cref="T:System.Diagnostics.Activity"/> with <see cref="T:System.Net.HttpWebResponse"/>.
|
|
</summary>
|
|
<remarks>
|
|
<para><b>EnrichWithHttpWebResponse is only executed on .NET Framework
|
|
runtimes. <see cref="T:System.Net.Http.HttpClient"/> and <see cref="T:System.Net.HttpWebRequest"/>
|
|
on .NET Framework are both implemented using <see
|
|
cref="T:System.Net.HttpWebRequest"/>.</b></para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.RecordException">
|
|
<summary>
|
|
Gets or sets a value indicating whether exception will be recorded
|
|
as an <see cref="T:System.Diagnostics.ActivityEvent"/> or not. Default value: <see
|
|
langword="false"/>.
|
|
</summary>
|
|
<remarks>
|
|
<para><b>RecordException is supported on all runtimes.</b></para>
|
|
<para>For specification details see: <see
|
|
href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/exceptions/exceptions-spans.md"
|
|
/>.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.DisableUrlQueryRedaction">
|
|
<summary>
|
|
Gets or sets a value indicating whether the url query value should be redacted or not.
|
|
</summary>
|
|
<remarks>
|
|
The query parameter values are redacted with value set as Redacted.
|
|
e.g. `?key1=value1` is set as `?key1=Redacted`.
|
|
The redaction can be disabled by setting this property to <see langword="true" />.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Instrumentation.Http.Implementation.HttpInstrumentationEventSource">
|
|
<summary>
|
|
EventSource events emitted from the project.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Instrumentation.Http.Implementation.HttpTagHelper">
|
|
<summary>
|
|
A collection of helper methods to be used when building Http activities.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Instrumentation.Http.Implementation.HttpTagHelper.GetUriTagValueFromRequestUri(System.Uri,System.Boolean)">
|
|
<summary>
|
|
Gets the OpenTelemetry standard uri tag value for a span based on its request <see cref="T:System.Uri"/>.
|
|
</summary>
|
|
<param name="uri"><see cref="T:System.Uri"/>.</param>
|
|
<param name="disableQueryRedaction">Indicates whether query parameter should be redacted or not.</param>
|
|
<returns>Span uri value.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Instrumentation.DiagnosticSourceSubscriber.Dispose">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Instrumentation.ListenerHandler">
|
|
<summary>
|
|
ListenerHandler base class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Instrumentation.ListenerHandler.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Instrumentation.ListenerHandler"/> class.
|
|
</summary>
|
|
<param name="sourceName">The name of the <see cref="T:OpenTelemetry.Instrumentation.ListenerHandler"/>.</param>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Instrumentation.ListenerHandler.SourceName">
|
|
<summary>
|
|
Gets the name of the <see cref="T:OpenTelemetry.Instrumentation.ListenerHandler"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Instrumentation.ListenerHandler.SupportsNullActivity">
|
|
<summary>
|
|
Gets a value indicating whether the <see cref="T:OpenTelemetry.Instrumentation.ListenerHandler"/> supports NULL <see cref="T:System.Diagnostics.Activity"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Instrumentation.ListenerHandler.OnEventWritten(System.String,System.Object)">
|
|
<summary>
|
|
Method called for an event which does not have 'Start', 'Stop' or 'Exception' as suffix.
|
|
</summary>
|
|
<param name="name">Custom name.</param>
|
|
<param name="payload">An object that represent the value being passed as a payload for the event.</param>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Instrumentation.PropertyFetcher`1">
|
|
<summary>
|
|
PropertyFetcher fetches a property from an object.
|
|
</summary>
|
|
<typeparam name="T">The type of the property being fetched.</typeparam>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Instrumentation.PropertyFetcher`1.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Instrumentation.PropertyFetcher`1"/> class.
|
|
</summary>
|
|
<param name="propertyName">Property name to fetch.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Instrumentation.PropertyFetcher`1.Fetch(System.Object)">
|
|
<summary>
|
|
Fetch the property from the object.
|
|
</summary>
|
|
<param name="obj">Object to be fetched.</param>
|
|
<returns>Fetched value.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Instrumentation.PropertyFetcher`1.TryFetch(System.Object,`0@)">
|
|
<summary>
|
|
Try to fetch the property from the object.
|
|
</summary>
|
|
<param name="obj">Object to be fetched.</param>
|
|
<param name="value">Fetched value.</param>
|
|
<returns><see langword= "true"/> if the property was fetched.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.HttpClientInstrumentationMeterProviderBuilderExtensions">
|
|
<summary>
|
|
Extension methods to simplify registering of HttpClient instrumentation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.HttpClientInstrumentationMeterProviderBuilderExtensions.AddHttpClientInstrumentation(OpenTelemetry.Metrics.MeterProviderBuilder)">
|
|
<summary>
|
|
Enables HttpClient instrumentation.
|
|
</summary>
|
|
<param name="builder"><see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/> being configured.</param>
|
|
<returns>The instance of <see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/> to chain the calls.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Trace.HttpClientInstrumentationTracerProviderBuilderExtensions">
|
|
<summary>
|
|
Extension methods to simplify registering of HttpClient instrumentation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.HttpClientInstrumentationTracerProviderBuilderExtensions.AddHttpClientInstrumentation(OpenTelemetry.Trace.TracerProviderBuilder)">
|
|
<summary>
|
|
Enables HttpClient instrumentation.
|
|
</summary>
|
|
<param name="builder"><see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/> being configured.</param>
|
|
<returns>The instance of <see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/> to chain the calls.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.HttpClientInstrumentationTracerProviderBuilderExtensions.AddHttpClientInstrumentation(OpenTelemetry.Trace.TracerProviderBuilder,System.Action{OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions})">
|
|
<summary>
|
|
Enables HttpClient instrumentation.
|
|
</summary>
|
|
<param name="builder"><see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/> being configured.</param>
|
|
<param name="configureHttpClientTraceInstrumentationOptions">Callback action for configuring <see cref="T:OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions"/>.</param>
|
|
<returns>The instance of <see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/> to chain the calls.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.HttpClientInstrumentationTracerProviderBuilderExtensions.AddHttpClientInstrumentation(OpenTelemetry.Trace.TracerProviderBuilder,System.String,System.Action{OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions})">
|
|
<summary>
|
|
Enables HttpClient instrumentation.
|
|
</summary>
|
|
<param name="builder"><see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/> being configured.</param>
|
|
<param name="name">Name which is used when retrieving options.</param>
|
|
<param name="configureHttpClientTraceInstrumentationOptions">Callback action for configuring <see cref="T:OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions"/>.</param>
|
|
<returns>The instance of <see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/> to chain the calls.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Trace.SemanticConventions">
|
|
<summary>
|
|
Constants for semantic attribute names outlined by the OpenTelemetry specifications.
|
|
<see href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/README.md"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Trace.SpanHelper">
|
|
<summary>
|
|
A collection of helper methods to be used when building spans.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.SpanHelper.ResolveActivityStatusForHttpStatusCode(System.Diagnostics.ActivityKind,System.Int32)">
|
|
<summary>
|
|
Helper method that populates Activity Status from http status code according
|
|
to https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/http/http-spans.md#status.
|
|
</summary>
|
|
<param name="kind">The span kind.</param>
|
|
<param name="httpStatusCode">Http status code.</param>
|
|
<returns>Resolved span <see cref="T:System.Diagnostics.ActivityStatusCode"/> for the Http status code.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Internal.ExceptionExtensions.ToInvariantString(System.Exception)">
|
|
<summary>
|
|
Returns a culture-independent string representation of the given <paramref name="exception"/> object,
|
|
appropriate for diagnostics tracing.
|
|
</summary>
|
|
<param name="exception">Exception to convert to string.</param>
|
|
<returns>Exception as string with no culture.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Internal.Guard">
|
|
<summary>
|
|
Methods for guarding against exception throwing values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Internal.Guard.ThrowIfNull(System.Object,System.String)">
|
|
<summary>
|
|
Throw an exception if the value is null.
|
|
</summary>
|
|
<param name="value">The value to check.</param>
|
|
<param name="paramName">The parameter name to use in the thrown exception.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Internal.Guard.ThrowIfNullOrEmpty(System.String,System.String)">
|
|
<summary>
|
|
Throw an exception if the value is null or empty.
|
|
</summary>
|
|
<param name="value">The value to check.</param>
|
|
<param name="paramName">The parameter name to use in the thrown exception.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Internal.Guard.ThrowIfNullOrWhitespace(System.String,System.String)">
|
|
<summary>
|
|
Throw an exception if the value is null or whitespace.
|
|
</summary>
|
|
<param name="value">The value to check.</param>
|
|
<param name="paramName">The parameter name to use in the thrown exception.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Internal.Guard.ThrowIfZero(System.Int32,System.String,System.String)">
|
|
<summary>
|
|
Throw an exception if the value is zero.
|
|
</summary>
|
|
<param name="value">The value to check.</param>
|
|
<param name="message">The message to use in the thrown exception.</param>
|
|
<param name="paramName">The parameter name to use in the thrown exception.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Internal.Guard.ThrowIfInvalidTimeout(System.Int32,System.String)">
|
|
<summary>
|
|
Throw an exception if the value is not considered a valid timeout.
|
|
</summary>
|
|
<param name="value">The value to check.</param>
|
|
<param name="paramName">The parameter name to use in the thrown exception.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Internal.Guard.ThrowIfOutOfRange(System.Int32,System.String,System.Int32,System.Int32,System.String,System.String,System.String)">
|
|
<summary>
|
|
Throw an exception if the value is not within the given range.
|
|
</summary>
|
|
<param name="value">The value to check.</param>
|
|
<param name="paramName">The parameter name to use in the thrown exception.</param>
|
|
<param name="min">The inclusive lower bound.</param>
|
|
<param name="max">The inclusive upper bound.</param>
|
|
<param name="minName">The name of the lower bound.</param>
|
|
<param name="maxName">The name of the upper bound.</param>
|
|
<param name="message">An optional custom message to use in the thrown exception.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Internal.Guard.ThrowIfOutOfRange(System.Double,System.String,System.Double,System.Double,System.String,System.String,System.String)">
|
|
<summary>
|
|
Throw an exception if the value is not within the given range.
|
|
</summary>
|
|
<param name="value">The value to check.</param>
|
|
<param name="paramName">The parameter name to use in the thrown exception.</param>
|
|
<param name="min">The inclusive lower bound.</param>
|
|
<param name="max">The inclusive upper bound.</param>
|
|
<param name="minName">The name of the lower bound.</param>
|
|
<param name="maxName">The name of the upper bound.</param>
|
|
<param name="message">An optional custom message to use in the thrown exception.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Internal.Guard.ThrowIfNotOfType``1(System.Object,System.String)">
|
|
<summary>
|
|
Throw an exception if the value is not of the expected type.
|
|
</summary>
|
|
<param name="value">The value to check.</param>
|
|
<param name="paramName">The parameter name to use in the thrown exception.</param>
|
|
<typeparam name="T">The type attempted to convert to.</typeparam>
|
|
<returns>The value casted to the specified type.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider">
|
|
<summary>
|
|
An environment variable based <see cref="T:Microsoft.Extensions.Configuration.ConfigurationProvider"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider.#ctor">
|
|
<summary>
|
|
Initializes a new instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance with the specified prefix.
|
|
</summary>
|
|
<param name="prefix">A prefix used to filter the environment variables.</param>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider.Load">
|
|
<summary>
|
|
Loads the environment variables.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider.ToString">
|
|
<summary>
|
|
Generates a string representing this provider name and relevant details.
|
|
</summary>
|
|
<returns> The configuration name. </returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource">
|
|
<summary>
|
|
Represents environment variables as an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource.Prefix">
|
|
<summary>
|
|
A prefix used to filter environment variables.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
|
<summary>
|
|
Builds the <see cref="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider"/> for this source.
|
|
</summary>
|
|
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
|
<returns>A <see cref="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider"/></returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Configuration.EnvironmentVariablesExtensions">
|
|
<summary>
|
|
Extension methods for registering <see cref="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider"/> with <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariablesExtensions.AddEnvironmentVariables(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
|
<summary>
|
|
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from environment variables.
|
|
</summary>
|
|
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariablesExtensions.AddEnvironmentVariables(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)">
|
|
<summary>
|
|
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from environment variables
|
|
with a specified prefix.
|
|
</summary>
|
|
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
|
<param name="prefix">The prefix that environment variable names must start with. The prefix will be removed from the environment variable names.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariablesExtensions.AddEnvironmentVariables(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource})">
|
|
<summary>
|
|
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from environment variables.
|
|
</summary>
|
|
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
|
<param name="configureSource">Configures the source.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.DelegatingOptionsFactory`1">
|
|
<summary>
|
|
Implementation of <see cref="T:Microsoft.Extensions.Options.IOptionsFactory`1"/>.
|
|
</summary>
|
|
<typeparam name="TOptions">The type of options being requested.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.DelegatingOptionsFactory`1.#ctor(System.Func{Microsoft.Extensions.Configuration.IConfiguration,System.String,`0},Microsoft.Extensions.Configuration.IConfiguration,System.Collections.Generic.IEnumerable{Microsoft.Extensions.Options.IConfigureOptions{`0}},System.Collections.Generic.IEnumerable{Microsoft.Extensions.Options.IPostConfigureOptions{`0}},System.Collections.Generic.IEnumerable{Microsoft.Extensions.Options.IValidateOptions{`0}})">
|
|
<summary>
|
|
Initializes a new instance with the specified options configurations.
|
|
</summary>
|
|
<param name="optionsFactoryFunc">Factory delegate used to create <typeparamref name="TOptions"/> instances.</param>
|
|
<param name="configuration"><see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.</param>
|
|
<param name="setups">The configuration actions to run.</param>
|
|
<param name="postConfigures">The initialization actions to run.</param>
|
|
<param name="validations">The validations to run.</param>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.DelegatingOptionsFactory`1.Create(System.String)">
|
|
<summary>
|
|
Returns a configured <typeparamref name="TOptions"/> instance with the given <paramref name="name"/>.
|
|
</summary>
|
|
<param name="name">The name of the <typeparamref name="TOptions"/> instance to create.</param>
|
|
<returns>The created <typeparamref name="TOptions"/> instance with the given <paramref name="name"/>.</returns>
|
|
<exception cref="T:Microsoft.Extensions.Options.OptionsValidationException">One or more <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1"/> return failed <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult"/> when validating the <typeparamref name="TOptions"/> instance been created.</exception>
|
|
<exception cref="T:System.MissingMethodException">The <typeparamref name="TOptions"/> does not have a public parameterless constructor or <typeparamref name="TOptions"/> is <see langword="abstract"/>.</exception>
|
|
</member>
|
|
<member name="T:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute">
|
|
<summary>Allows capturing of the expressions passed to a method.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
|
<summary>Specifies that an output is not <see langword="null"/> even if
|
|
the corresponding type allows it. Specifies that an input argument was
|
|
not <see langword="null"/> when the call returns.</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.MaybeNullAttribute">
|
|
<summary>Specifies that an output may be null even if the corresponding type disallows it.</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.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>
|
|
</members>
|
|
</doc>
|