nuget update
This commit is contained in:
StellaOps Bot
5
.nuget/packages/microsoft.identitymodel.abstractions/8.14.0/.nupkg.metadata
vendored
Normal file
5
.nuget/packages/microsoft.identitymodel.abstractions/8.14.0/.nupkg.metadata
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "iwbCpSjD3ehfTwBhtSNEtKPK0ICun6ov7Ibx6ISNA9bfwIyzI2Siwyi9eJFCJBwxowK9xcA1mj+jBWiigeqgcQ==",
|
||||
"source": "/mnt/e/dev/git.stella-ops.org/local-nugets"
|
||||
}
|
||||
BIN
.nuget/packages/microsoft.identitymodel.abstractions/8.14.0/.signature.p7s
vendored
Normal file
BIN
.nuget/packages/microsoft.identitymodel.abstractions/8.14.0/.signature.p7s
vendored
Normal file
Binary file not shown.
@@ -0,0 +1,24 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.IdentityModel.Abstractions</id>
|
||||
<version>8.14.0</version>
|
||||
<authors>Microsoft</authors>
|
||||
<license type="expression">MIT</license>
|
||||
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
|
||||
<readme>README.md</readme>
|
||||
<projectUrl>https://github.com/AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet</projectUrl>
|
||||
<description>A package containing thin abstractions for Microsoft.IdentityModel.</description>
|
||||
<copyright>© Microsoft Corporation. All rights reserved.</copyright>
|
||||
<tags>.NET Windows Authentication Identity Abstractions</tags>
|
||||
<repository type="git" url="https://github.com/AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet" commit="c8f7d87bcda35557a68f6cb9c55856a2ee733856" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETFramework4.6.2" />
|
||||
<group targetFramework=".NETFramework4.7.2" />
|
||||
<group targetFramework="net6.0" />
|
||||
<group targetFramework="net8.0" />
|
||||
<group targetFramework="net9.0" />
|
||||
<group targetFramework=".NETStandard2.0" />
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
93
.nuget/packages/microsoft.identitymodel.abstractions/8.14.0/README.md
vendored
Normal file
93
.nuget/packages/microsoft.identitymodel.abstractions/8.14.0/README.md
vendored
Normal file
@@ -0,0 +1,93 @@
|
||||
# IdentityModel Extensions for .NET
|
||||
|
||||
[](https://www.nuget.org/packages/Microsoft.IdentityModel.JsonWebTokens/)
|
||||
|
||||
The **IdentityModel Extensions for .NET** library provides robust tools to enhance authentication and authorization workflows in your .NET applications. Backed by the Entra team, this library simplifies working with OpenID Connect (OIDC), OAuth2.0, and JSON Web Tokens (JWT) in .NET.
|
||||
|
||||
Whether you're building secure APIs, implementing token validation, or managing claims, this library is designed to handle the heavy lifting for you.
|
||||
|
||||
> **Why IdentityModel?**
|
||||
> - **Widely Adopted:** Trusted by thousands of developers to integrate OIDC and OAuth2.0 standards.
|
||||
> - **Secure by Design:** Built with security as a priority to reduce common vulnerabilities.
|
||||
> - **Extensible:** Easily extend or customize for advanced use cases.
|
||||
> - **Battle hardened:** Validates 5+ trillion requests daily, and growing.
|
||||
|
||||
## Versions
|
||||
|
||||
You can find the release notes for each version [here](https://github.com/AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet/releases). Older versions can be found [here](https://github.com/AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet/wiki/Release-Notes).
|
||||
|
||||
## Version Lifecycle and Support Matrix
|
||||
|
||||
See [Long Term Support policy](./supportPolicy.md) for details.
|
||||
|
||||
| Major Version | Currently Supported Version | Status |
|
||||
| --------------|--------------|--------|
|
||||
| 8.x | from 8.0.1 to [](https://www.nuget.org/packages/Microsoft.IdentityModel.JsonWebTokens/) | Active (Current) - Tied to .NET 9 (STS) & 10 (LTS) ~ Nov, 2028|
|
||||
| 7.x | 7.7.1 | Supported (LTS) through .NET 8 LTS lifetime Nov 10, 2026.<br/>⚠️Versions `< 7.7.1` not supported.|
|
||||
| 5.x | 5.7.0 | Supported (LTS), tied to the Microsoft.Owin.Security.JWT 4.2.2 lifetime.<br/>⚠️Versions `< 5.7.0` not supported. |
|
||||
|
||||
## IdentityModel 8.x
|
||||
|
||||
Version `8.x` introduces significant updates and improvements:
|
||||
- **Enhanced Performance:** Optimized token validation to handle high-throughput scenarios.
|
||||
- **.NET Compatibility:** Fully compatible with .NET 9.
|
||||
|
||||
>🧭LTS: Supported through .NET 9 LTS lifetime: May 12, 2026 + .NET 10 LTS (~3 years).
|
||||
|
||||
## IdentityModel 7.x
|
||||
|
||||
[IdentityModel 7x](https://github.com/AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet/wiki/IdentityModel-7x) introduced several improvements related to serialization and consistency in the API, which provide a better user experience for developers, as well as full AOT compatibility on .NET, and considerable performance improvements compared to IdentityModel 6x.
|
||||
|
||||
>🧭LTS: Supported through .NET 8 LTS lifetime: Nov 10, 2026.
|
||||
>
|
||||
>⚡Recommendation: Move to 8.x.
|
||||
|
||||
## IdentityModel 6.x
|
||||
|
||||
>🧭Deprecated: Support ended with .NET 7 LTS lifetime: May 2024.
|
||||
>
|
||||
>⚡Action: Move to 8.x.
|
||||
|
||||
## IdentityModel 5.x
|
||||
|
||||
__Not a recommended version__
|
||||
|
||||
>🧭LTS: Supported for Microsoft.Owin.Security.JWT
|
||||
>
|
||||
>⚡Action: Move to 8.x.
|
||||
|
||||
## Samples and Documentation
|
||||
|
||||
The scenarios supported by IdentityModel extensions for .NET are described in [Scenarios](https://github.com/AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet/wiki/scenarios). The libraries are in particular used part of ASP.NET security to validate tokens in ASP.NET Web Apps and Web APIs. To learn more about token validation, and find samples, see:
|
||||
|
||||
- [Microsoft Entra ID with ASP.NET Core](https://docs.microsoft.com/en-us/aspnet/core/security/authentication/azure-active-directory/?view=aspnetcore-2.1)
|
||||
- [Developing ASP.NET Apps with Microsoft Entra ID](https://docs.microsoft.com/en-us/aspnet/identity/overview/getting-started/developing-aspnet-apps-with-windows-azure-active-directory)
|
||||
- [Validating tokens](https://github.com/AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet/wiki/ValidatingTokens)
|
||||
- more generally, the library's [Wiki](https://github.com/AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet/wiki)
|
||||
- the [reference documentation](https://learn.microsoft.com/dotnet/api/microsoft.identitymodel.jsonwebtokens.jsonwebtokenhandler?view=msal-web-dotnet-latest)
|
||||
|
||||
## Community Help and Support
|
||||
|
||||
Report a bug or request a feature directly in the [GitHub repo](https://github.com/AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet/issues/new/choose).
|
||||
|
||||
Have a design proposal? Please submit [a design proposal](https://github.com/AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet/issues/new?assignees=&labels=design-proposal&projects=&template=design_proposal.md) before starting work on a PR to ensure it means the goals/objectives of this library and it's priorities.
|
||||
|
||||
We leverage [Stack Overflow](http://stackoverflow.com/) to work with the community on supporting Microsoft Entra and its SDKs, including this one! We highly recommend you ask your questions on Stack Overflow (we're all on there!) Also browse existing issues to see if someone has had your question before.
|
||||
|
||||
We recommend you use the "identityModel" tag so we can see it! Here is the latest Q&A on Stack Overflow for IdentityModel: [https://stackoverflow.com/questions/tagged/identityModel](https://stackoverflow.com/questions/tagged/identityModel)
|
||||
|
||||
## Security Reporting
|
||||
|
||||
See [SECURITY.md](./SECURITY.md)
|
||||
|
||||
## Contributing
|
||||
|
||||
All code is licensed under the MIT license and we triage actively on GitHub. We enthusiastically welcome contributions and feedback. See [Contributing.md](./Contributing.md) for guidelines, branch information, build instructions, and legalese.
|
||||
|
||||
## License
|
||||
|
||||
Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License (the "License");
|
||||
|
||||
## We Value and Adhere to the Microsoft Open Source Code of Conduct
|
||||
|
||||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
@@ -0,0 +1,297 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.IdentityModel.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.EventLogLevel">
|
||||
<summary>
|
||||
Defines Event Log Levels.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.LogAlways">
|
||||
<summary>
|
||||
No level filtering is done on this log level. Log messages of all levels will be logged.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Critical">
|
||||
<summary>
|
||||
Logs that describe an unrecoverable application or system crash, or a catastrophic failure that requires
|
||||
immediate attention.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Error">
|
||||
<summary>
|
||||
Logs that highlight when the current flow of execution is stopped due to a failure. These should indicate a
|
||||
failure in the current activity, not an application-wide failure.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Warning">
|
||||
<summary>
|
||||
Logs that highlight an abnormal or unexpected event in the application flow, but do not otherwise cause the
|
||||
application execution to stop.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Informational">
|
||||
<summary>
|
||||
Logs that track the general flow of the application. These logs should have long-term value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Verbose">
|
||||
<summary>
|
||||
Logs that are used for interactive investigation during development. These logs should primarily contain
|
||||
information useful for debugging and have no long-term value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.IIdentityLogger">
|
||||
<summary>
|
||||
Interface that needs to be implemented by classes providing logging in Microsoft identity libraries.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.IIdentityLogger.IsEnabled(Microsoft.IdentityModel.Abstractions.EventLogLevel)">
|
||||
<summary>
|
||||
Checks to see if logging is enabled at given <paramref name="eventLogLevel"/>.
|
||||
</summary>
|
||||
<param name="eventLogLevel">Log level of a message.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.IIdentityLogger.Log(Microsoft.IdentityModel.Abstractions.LogEntry)">
|
||||
<summary>
|
||||
Writes a log entry.
|
||||
</summary>
|
||||
<param name="entry">Defines a structured message to be logged at the provided <see cref="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel"/>.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.ITelemetryClient">
|
||||
<summary>
|
||||
Interface for Telemetry tracking.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.ITelemetryClient.ClientId">
|
||||
<summary>
|
||||
Gets or sets the application or client ID that telemetry is being sent for.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.Initialize">
|
||||
<summary>
|
||||
Perform any necessary bootstrapping for the telemetry client.
|
||||
</summary>
|
||||
<remarks>
|
||||
The expectation is that this should only be called once for the lifetime of the object however the
|
||||
implementation should be idempotent.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.IsEnabled">
|
||||
<summary>
|
||||
Checks to see if telemetry is enabled all up.
|
||||
</summary>
|
||||
<returns>
|
||||
Returns <see langword="true"/> if telemetry should be sent; <see langword="false"/> otherwise.
|
||||
</returns>
|
||||
<remarks>
|
||||
This check should be used to gate any resource intensive operations to generate telemetry as well.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.IsEnabled(System.String)">
|
||||
<summary>
|
||||
Checks to see if telemetry is enabled for the named event.
|
||||
</summary>
|
||||
<param name="eventName">Name of the event to check.</param>
|
||||
<returns>
|
||||
Returns <see langword="true"/> if telemetry should be sent for <paramref name="eventName"/>;
|
||||
<see langword="false"/> otherwise.
|
||||
</returns>
|
||||
<remarks>
|
||||
This check should be used to gate any resource intensive operations to generate telemetry as well.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.TrackEvent(Microsoft.IdentityModel.Abstractions.TelemetryEventDetails)">
|
||||
<summary>
|
||||
Tracks an instance of a named event.
|
||||
</summary>
|
||||
<param name="eventDetails">Details of the event to track.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.TrackEvent(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.Int64},System.Collections.Generic.IDictionary{System.String,System.Boolean},System.Collections.Generic.IDictionary{System.String,System.DateTime},System.Collections.Generic.IDictionary{System.String,System.Double},System.Collections.Generic.IDictionary{System.String,System.Guid})">
|
||||
<summary>
|
||||
Tracks an instance of a named event.
|
||||
</summary>
|
||||
<param name="eventName">Name of the event to track. Should be unique per scenario.</param>
|
||||
<param name="stringProperties">Key value pair of strings to long with the event.</param>
|
||||
<param name="longProperties">Key value pair of longs to long with the event.</param>
|
||||
<param name="boolProperties">Key value pair of bools to long with the event.</param>
|
||||
<param name="dateTimeProperties">Key value pair of DateTimes to long with the event.</param>
|
||||
<param name="doubleProperties">Key value pair of doubles to long with the event.</param>
|
||||
<param name="guidProperties">Key value pair of Guids to long with the event.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.LogEntry">
|
||||
<summary>
|
||||
Defines the structure of a log entry.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel">
|
||||
<summary>
|
||||
Defines the <see cref="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.Message">
|
||||
<summary>
|
||||
Message to be logged.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.CorrelationId">
|
||||
<summary>
|
||||
A unique identifier for a request that can help with diagnostics across components.
|
||||
</summary>
|
||||
<remarks>
|
||||
Also referred to as ActivityId in Microsoft.IdentityModel.Tokens.CallContext.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger">
|
||||
<summary>
|
||||
A minimalistic <see cref="T:Microsoft.IdentityModel.Abstractions.IIdentityLogger"/> implementation that is disabled by default and doesn't log.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.Instance">
|
||||
<summary>
|
||||
Default instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.IsEnabled(Microsoft.IdentityModel.Abstractions.EventLogLevel)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.Log(Microsoft.IdentityModel.Abstractions.LogEntry)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient">
|
||||
<summary>
|
||||
The default implementation of the <see cref="T:Microsoft.IdentityModel.Abstractions.ITelemetryClient"/> interface which swallows all telemetry signals.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.ClientId">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.Instance">
|
||||
<summary>
|
||||
Singleton instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.#ctor">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
Private constructor to prevent the default constructor being exposed.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.IsEnabled">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.IsEnabled(System.String)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.Initialize">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.TrackEvent(Microsoft.IdentityModel.Abstractions.TelemetryEventDetails)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.TrackEvent(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.Int64},System.Collections.Generic.IDictionary{System.String,System.Boolean},System.Collections.Generic.IDictionary{System.String,System.DateTime},System.Collections.Generic.IDictionary{System.String,System.Double},System.Collections.Generic.IDictionary{System.String,System.Guid})">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.ObservabilityConstants">
|
||||
<summary>
|
||||
Common class containing observability constants to be used as well known metric keys.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.Succeeded">
|
||||
<summary>
|
||||
String used for the name of the property indicating if the call was successful.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.Duration">
|
||||
<summary>
|
||||
String used for the name of the property indicating the call in Duration (ms).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.ActivityId">
|
||||
<summary>
|
||||
String used for the name of the property indicating the call's Activity Id/Correlation Id.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.ClientId">
|
||||
<summary>
|
||||
String used for the name of the property indicating the caller's ClientId.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails">
|
||||
<summary>
|
||||
Details of the telemetry event.
|
||||
</summary>
|
||||
<remarks>
|
||||
This implementation is not meant to be thread-safe. This implementation would either need to be overridden or
|
||||
usage should not be concurrently operated on.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.PropertyValues">
|
||||
<summary>
|
||||
The underlying properties making up the <see cref="T:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.Name">
|
||||
<summary>
|
||||
Name of the telemetry event, should be unique between events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.Properties">
|
||||
<summary>
|
||||
Properties which describe the event.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.String)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Int64)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.DateTime)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Double)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Guid)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,297 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.IdentityModel.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.EventLogLevel">
|
||||
<summary>
|
||||
Defines Event Log Levels.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.LogAlways">
|
||||
<summary>
|
||||
No level filtering is done on this log level. Log messages of all levels will be logged.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Critical">
|
||||
<summary>
|
||||
Logs that describe an unrecoverable application or system crash, or a catastrophic failure that requires
|
||||
immediate attention.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Error">
|
||||
<summary>
|
||||
Logs that highlight when the current flow of execution is stopped due to a failure. These should indicate a
|
||||
failure in the current activity, not an application-wide failure.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Warning">
|
||||
<summary>
|
||||
Logs that highlight an abnormal or unexpected event in the application flow, but do not otherwise cause the
|
||||
application execution to stop.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Informational">
|
||||
<summary>
|
||||
Logs that track the general flow of the application. These logs should have long-term value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Verbose">
|
||||
<summary>
|
||||
Logs that are used for interactive investigation during development. These logs should primarily contain
|
||||
information useful for debugging and have no long-term value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.IIdentityLogger">
|
||||
<summary>
|
||||
Interface that needs to be implemented by classes providing logging in Microsoft identity libraries.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.IIdentityLogger.IsEnabled(Microsoft.IdentityModel.Abstractions.EventLogLevel)">
|
||||
<summary>
|
||||
Checks to see if logging is enabled at given <paramref name="eventLogLevel"/>.
|
||||
</summary>
|
||||
<param name="eventLogLevel">Log level of a message.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.IIdentityLogger.Log(Microsoft.IdentityModel.Abstractions.LogEntry)">
|
||||
<summary>
|
||||
Writes a log entry.
|
||||
</summary>
|
||||
<param name="entry">Defines a structured message to be logged at the provided <see cref="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel"/>.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.ITelemetryClient">
|
||||
<summary>
|
||||
Interface for Telemetry tracking.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.ITelemetryClient.ClientId">
|
||||
<summary>
|
||||
Gets or sets the application or client ID that telemetry is being sent for.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.Initialize">
|
||||
<summary>
|
||||
Perform any necessary bootstrapping for the telemetry client.
|
||||
</summary>
|
||||
<remarks>
|
||||
The expectation is that this should only be called once for the lifetime of the object however the
|
||||
implementation should be idempotent.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.IsEnabled">
|
||||
<summary>
|
||||
Checks to see if telemetry is enabled all up.
|
||||
</summary>
|
||||
<returns>
|
||||
Returns <see langword="true"/> if telemetry should be sent; <see langword="false"/> otherwise.
|
||||
</returns>
|
||||
<remarks>
|
||||
This check should be used to gate any resource intensive operations to generate telemetry as well.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.IsEnabled(System.String)">
|
||||
<summary>
|
||||
Checks to see if telemetry is enabled for the named event.
|
||||
</summary>
|
||||
<param name="eventName">Name of the event to check.</param>
|
||||
<returns>
|
||||
Returns <see langword="true"/> if telemetry should be sent for <paramref name="eventName"/>;
|
||||
<see langword="false"/> otherwise.
|
||||
</returns>
|
||||
<remarks>
|
||||
This check should be used to gate any resource intensive operations to generate telemetry as well.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.TrackEvent(Microsoft.IdentityModel.Abstractions.TelemetryEventDetails)">
|
||||
<summary>
|
||||
Tracks an instance of a named event.
|
||||
</summary>
|
||||
<param name="eventDetails">Details of the event to track.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.TrackEvent(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.Int64},System.Collections.Generic.IDictionary{System.String,System.Boolean},System.Collections.Generic.IDictionary{System.String,System.DateTime},System.Collections.Generic.IDictionary{System.String,System.Double},System.Collections.Generic.IDictionary{System.String,System.Guid})">
|
||||
<summary>
|
||||
Tracks an instance of a named event.
|
||||
</summary>
|
||||
<param name="eventName">Name of the event to track. Should be unique per scenario.</param>
|
||||
<param name="stringProperties">Key value pair of strings to long with the event.</param>
|
||||
<param name="longProperties">Key value pair of longs to long with the event.</param>
|
||||
<param name="boolProperties">Key value pair of bools to long with the event.</param>
|
||||
<param name="dateTimeProperties">Key value pair of DateTimes to long with the event.</param>
|
||||
<param name="doubleProperties">Key value pair of doubles to long with the event.</param>
|
||||
<param name="guidProperties">Key value pair of Guids to long with the event.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.LogEntry">
|
||||
<summary>
|
||||
Defines the structure of a log entry.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel">
|
||||
<summary>
|
||||
Defines the <see cref="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.Message">
|
||||
<summary>
|
||||
Message to be logged.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.CorrelationId">
|
||||
<summary>
|
||||
A unique identifier for a request that can help with diagnostics across components.
|
||||
</summary>
|
||||
<remarks>
|
||||
Also referred to as ActivityId in Microsoft.IdentityModel.Tokens.CallContext.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger">
|
||||
<summary>
|
||||
A minimalistic <see cref="T:Microsoft.IdentityModel.Abstractions.IIdentityLogger"/> implementation that is disabled by default and doesn't log.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.Instance">
|
||||
<summary>
|
||||
Default instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.IsEnabled(Microsoft.IdentityModel.Abstractions.EventLogLevel)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.Log(Microsoft.IdentityModel.Abstractions.LogEntry)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient">
|
||||
<summary>
|
||||
The default implementation of the <see cref="T:Microsoft.IdentityModel.Abstractions.ITelemetryClient"/> interface which swallows all telemetry signals.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.ClientId">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.Instance">
|
||||
<summary>
|
||||
Singleton instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.#ctor">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
Private constructor to prevent the default constructor being exposed.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.IsEnabled">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.IsEnabled(System.String)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.Initialize">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.TrackEvent(Microsoft.IdentityModel.Abstractions.TelemetryEventDetails)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.TrackEvent(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.Int64},System.Collections.Generic.IDictionary{System.String,System.Boolean},System.Collections.Generic.IDictionary{System.String,System.DateTime},System.Collections.Generic.IDictionary{System.String,System.Double},System.Collections.Generic.IDictionary{System.String,System.Guid})">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.ObservabilityConstants">
|
||||
<summary>
|
||||
Common class containing observability constants to be used as well known metric keys.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.Succeeded">
|
||||
<summary>
|
||||
String used for the name of the property indicating if the call was successful.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.Duration">
|
||||
<summary>
|
||||
String used for the name of the property indicating the call in Duration (ms).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.ActivityId">
|
||||
<summary>
|
||||
String used for the name of the property indicating the call's Activity Id/Correlation Id.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.ClientId">
|
||||
<summary>
|
||||
String used for the name of the property indicating the caller's ClientId.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails">
|
||||
<summary>
|
||||
Details of the telemetry event.
|
||||
</summary>
|
||||
<remarks>
|
||||
This implementation is not meant to be thread-safe. This implementation would either need to be overridden or
|
||||
usage should not be concurrently operated on.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.PropertyValues">
|
||||
<summary>
|
||||
The underlying properties making up the <see cref="T:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.Name">
|
||||
<summary>
|
||||
Name of the telemetry event, should be unique between events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.Properties">
|
||||
<summary>
|
||||
Properties which describe the event.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.String)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Int64)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.DateTime)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Double)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Guid)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,297 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.IdentityModel.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.EventLogLevel">
|
||||
<summary>
|
||||
Defines Event Log Levels.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.LogAlways">
|
||||
<summary>
|
||||
No level filtering is done on this log level. Log messages of all levels will be logged.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Critical">
|
||||
<summary>
|
||||
Logs that describe an unrecoverable application or system crash, or a catastrophic failure that requires
|
||||
immediate attention.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Error">
|
||||
<summary>
|
||||
Logs that highlight when the current flow of execution is stopped due to a failure. These should indicate a
|
||||
failure in the current activity, not an application-wide failure.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Warning">
|
||||
<summary>
|
||||
Logs that highlight an abnormal or unexpected event in the application flow, but do not otherwise cause the
|
||||
application execution to stop.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Informational">
|
||||
<summary>
|
||||
Logs that track the general flow of the application. These logs should have long-term value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Verbose">
|
||||
<summary>
|
||||
Logs that are used for interactive investigation during development. These logs should primarily contain
|
||||
information useful for debugging and have no long-term value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.IIdentityLogger">
|
||||
<summary>
|
||||
Interface that needs to be implemented by classes providing logging in Microsoft identity libraries.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.IIdentityLogger.IsEnabled(Microsoft.IdentityModel.Abstractions.EventLogLevel)">
|
||||
<summary>
|
||||
Checks to see if logging is enabled at given <paramref name="eventLogLevel"/>.
|
||||
</summary>
|
||||
<param name="eventLogLevel">Log level of a message.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.IIdentityLogger.Log(Microsoft.IdentityModel.Abstractions.LogEntry)">
|
||||
<summary>
|
||||
Writes a log entry.
|
||||
</summary>
|
||||
<param name="entry">Defines a structured message to be logged at the provided <see cref="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel"/>.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.ITelemetryClient">
|
||||
<summary>
|
||||
Interface for Telemetry tracking.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.ITelemetryClient.ClientId">
|
||||
<summary>
|
||||
Gets or sets the application or client ID that telemetry is being sent for.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.Initialize">
|
||||
<summary>
|
||||
Perform any necessary bootstrapping for the telemetry client.
|
||||
</summary>
|
||||
<remarks>
|
||||
The expectation is that this should only be called once for the lifetime of the object however the
|
||||
implementation should be idempotent.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.IsEnabled">
|
||||
<summary>
|
||||
Checks to see if telemetry is enabled all up.
|
||||
</summary>
|
||||
<returns>
|
||||
Returns <see langword="true"/> if telemetry should be sent; <see langword="false"/> otherwise.
|
||||
</returns>
|
||||
<remarks>
|
||||
This check should be used to gate any resource intensive operations to generate telemetry as well.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.IsEnabled(System.String)">
|
||||
<summary>
|
||||
Checks to see if telemetry is enabled for the named event.
|
||||
</summary>
|
||||
<param name="eventName">Name of the event to check.</param>
|
||||
<returns>
|
||||
Returns <see langword="true"/> if telemetry should be sent for <paramref name="eventName"/>;
|
||||
<see langword="false"/> otherwise.
|
||||
</returns>
|
||||
<remarks>
|
||||
This check should be used to gate any resource intensive operations to generate telemetry as well.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.TrackEvent(Microsoft.IdentityModel.Abstractions.TelemetryEventDetails)">
|
||||
<summary>
|
||||
Tracks an instance of a named event.
|
||||
</summary>
|
||||
<param name="eventDetails">Details of the event to track.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.TrackEvent(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.Int64},System.Collections.Generic.IDictionary{System.String,System.Boolean},System.Collections.Generic.IDictionary{System.String,System.DateTime},System.Collections.Generic.IDictionary{System.String,System.Double},System.Collections.Generic.IDictionary{System.String,System.Guid})">
|
||||
<summary>
|
||||
Tracks an instance of a named event.
|
||||
</summary>
|
||||
<param name="eventName">Name of the event to track. Should be unique per scenario.</param>
|
||||
<param name="stringProperties">Key value pair of strings to long with the event.</param>
|
||||
<param name="longProperties">Key value pair of longs to long with the event.</param>
|
||||
<param name="boolProperties">Key value pair of bools to long with the event.</param>
|
||||
<param name="dateTimeProperties">Key value pair of DateTimes to long with the event.</param>
|
||||
<param name="doubleProperties">Key value pair of doubles to long with the event.</param>
|
||||
<param name="guidProperties">Key value pair of Guids to long with the event.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.LogEntry">
|
||||
<summary>
|
||||
Defines the structure of a log entry.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel">
|
||||
<summary>
|
||||
Defines the <see cref="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.Message">
|
||||
<summary>
|
||||
Message to be logged.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.CorrelationId">
|
||||
<summary>
|
||||
A unique identifier for a request that can help with diagnostics across components.
|
||||
</summary>
|
||||
<remarks>
|
||||
Also referred to as ActivityId in Microsoft.IdentityModel.Tokens.CallContext.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger">
|
||||
<summary>
|
||||
A minimalistic <see cref="T:Microsoft.IdentityModel.Abstractions.IIdentityLogger"/> implementation that is disabled by default and doesn't log.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.Instance">
|
||||
<summary>
|
||||
Default instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.IsEnabled(Microsoft.IdentityModel.Abstractions.EventLogLevel)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.Log(Microsoft.IdentityModel.Abstractions.LogEntry)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient">
|
||||
<summary>
|
||||
The default implementation of the <see cref="T:Microsoft.IdentityModel.Abstractions.ITelemetryClient"/> interface which swallows all telemetry signals.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.ClientId">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.Instance">
|
||||
<summary>
|
||||
Singleton instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.#ctor">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
Private constructor to prevent the default constructor being exposed.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.IsEnabled">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.IsEnabled(System.String)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.Initialize">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.TrackEvent(Microsoft.IdentityModel.Abstractions.TelemetryEventDetails)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.TrackEvent(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.Int64},System.Collections.Generic.IDictionary{System.String,System.Boolean},System.Collections.Generic.IDictionary{System.String,System.DateTime},System.Collections.Generic.IDictionary{System.String,System.Double},System.Collections.Generic.IDictionary{System.String,System.Guid})">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.ObservabilityConstants">
|
||||
<summary>
|
||||
Common class containing observability constants to be used as well known metric keys.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.Succeeded">
|
||||
<summary>
|
||||
String used for the name of the property indicating if the call was successful.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.Duration">
|
||||
<summary>
|
||||
String used for the name of the property indicating the call in Duration (ms).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.ActivityId">
|
||||
<summary>
|
||||
String used for the name of the property indicating the call's Activity Id/Correlation Id.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.ClientId">
|
||||
<summary>
|
||||
String used for the name of the property indicating the caller's ClientId.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails">
|
||||
<summary>
|
||||
Details of the telemetry event.
|
||||
</summary>
|
||||
<remarks>
|
||||
This implementation is not meant to be thread-safe. This implementation would either need to be overridden or
|
||||
usage should not be concurrently operated on.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.PropertyValues">
|
||||
<summary>
|
||||
The underlying properties making up the <see cref="T:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.Name">
|
||||
<summary>
|
||||
Name of the telemetry event, should be unique between events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.Properties">
|
||||
<summary>
|
||||
Properties which describe the event.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.String)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Int64)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.DateTime)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Double)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Guid)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,297 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.IdentityModel.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.EventLogLevel">
|
||||
<summary>
|
||||
Defines Event Log Levels.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.LogAlways">
|
||||
<summary>
|
||||
No level filtering is done on this log level. Log messages of all levels will be logged.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Critical">
|
||||
<summary>
|
||||
Logs that describe an unrecoverable application or system crash, or a catastrophic failure that requires
|
||||
immediate attention.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Error">
|
||||
<summary>
|
||||
Logs that highlight when the current flow of execution is stopped due to a failure. These should indicate a
|
||||
failure in the current activity, not an application-wide failure.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Warning">
|
||||
<summary>
|
||||
Logs that highlight an abnormal or unexpected event in the application flow, but do not otherwise cause the
|
||||
application execution to stop.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Informational">
|
||||
<summary>
|
||||
Logs that track the general flow of the application. These logs should have long-term value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Verbose">
|
||||
<summary>
|
||||
Logs that are used for interactive investigation during development. These logs should primarily contain
|
||||
information useful for debugging and have no long-term value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.IIdentityLogger">
|
||||
<summary>
|
||||
Interface that needs to be implemented by classes providing logging in Microsoft identity libraries.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.IIdentityLogger.IsEnabled(Microsoft.IdentityModel.Abstractions.EventLogLevel)">
|
||||
<summary>
|
||||
Checks to see if logging is enabled at given <paramref name="eventLogLevel"/>.
|
||||
</summary>
|
||||
<param name="eventLogLevel">Log level of a message.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.IIdentityLogger.Log(Microsoft.IdentityModel.Abstractions.LogEntry)">
|
||||
<summary>
|
||||
Writes a log entry.
|
||||
</summary>
|
||||
<param name="entry">Defines a structured message to be logged at the provided <see cref="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel"/>.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.ITelemetryClient">
|
||||
<summary>
|
||||
Interface for Telemetry tracking.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.ITelemetryClient.ClientId">
|
||||
<summary>
|
||||
Gets or sets the application or client ID that telemetry is being sent for.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.Initialize">
|
||||
<summary>
|
||||
Perform any necessary bootstrapping for the telemetry client.
|
||||
</summary>
|
||||
<remarks>
|
||||
The expectation is that this should only be called once for the lifetime of the object however the
|
||||
implementation should be idempotent.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.IsEnabled">
|
||||
<summary>
|
||||
Checks to see if telemetry is enabled all up.
|
||||
</summary>
|
||||
<returns>
|
||||
Returns <see langword="true"/> if telemetry should be sent; <see langword="false"/> otherwise.
|
||||
</returns>
|
||||
<remarks>
|
||||
This check should be used to gate any resource intensive operations to generate telemetry as well.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.IsEnabled(System.String)">
|
||||
<summary>
|
||||
Checks to see if telemetry is enabled for the named event.
|
||||
</summary>
|
||||
<param name="eventName">Name of the event to check.</param>
|
||||
<returns>
|
||||
Returns <see langword="true"/> if telemetry should be sent for <paramref name="eventName"/>;
|
||||
<see langword="false"/> otherwise.
|
||||
</returns>
|
||||
<remarks>
|
||||
This check should be used to gate any resource intensive operations to generate telemetry as well.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.TrackEvent(Microsoft.IdentityModel.Abstractions.TelemetryEventDetails)">
|
||||
<summary>
|
||||
Tracks an instance of a named event.
|
||||
</summary>
|
||||
<param name="eventDetails">Details of the event to track.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.TrackEvent(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.Int64},System.Collections.Generic.IDictionary{System.String,System.Boolean},System.Collections.Generic.IDictionary{System.String,System.DateTime},System.Collections.Generic.IDictionary{System.String,System.Double},System.Collections.Generic.IDictionary{System.String,System.Guid})">
|
||||
<summary>
|
||||
Tracks an instance of a named event.
|
||||
</summary>
|
||||
<param name="eventName">Name of the event to track. Should be unique per scenario.</param>
|
||||
<param name="stringProperties">Key value pair of strings to long with the event.</param>
|
||||
<param name="longProperties">Key value pair of longs to long with the event.</param>
|
||||
<param name="boolProperties">Key value pair of bools to long with the event.</param>
|
||||
<param name="dateTimeProperties">Key value pair of DateTimes to long with the event.</param>
|
||||
<param name="doubleProperties">Key value pair of doubles to long with the event.</param>
|
||||
<param name="guidProperties">Key value pair of Guids to long with the event.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.LogEntry">
|
||||
<summary>
|
||||
Defines the structure of a log entry.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel">
|
||||
<summary>
|
||||
Defines the <see cref="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.Message">
|
||||
<summary>
|
||||
Message to be logged.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.CorrelationId">
|
||||
<summary>
|
||||
A unique identifier for a request that can help with diagnostics across components.
|
||||
</summary>
|
||||
<remarks>
|
||||
Also referred to as ActivityId in Microsoft.IdentityModel.Tokens.CallContext.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger">
|
||||
<summary>
|
||||
A minimalistic <see cref="T:Microsoft.IdentityModel.Abstractions.IIdentityLogger"/> implementation that is disabled by default and doesn't log.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.Instance">
|
||||
<summary>
|
||||
Default instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.IsEnabled(Microsoft.IdentityModel.Abstractions.EventLogLevel)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.Log(Microsoft.IdentityModel.Abstractions.LogEntry)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient">
|
||||
<summary>
|
||||
The default implementation of the <see cref="T:Microsoft.IdentityModel.Abstractions.ITelemetryClient"/> interface which swallows all telemetry signals.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.ClientId">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.Instance">
|
||||
<summary>
|
||||
Singleton instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.#ctor">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
Private constructor to prevent the default constructor being exposed.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.IsEnabled">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.IsEnabled(System.String)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.Initialize">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.TrackEvent(Microsoft.IdentityModel.Abstractions.TelemetryEventDetails)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.TrackEvent(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.Int64},System.Collections.Generic.IDictionary{System.String,System.Boolean},System.Collections.Generic.IDictionary{System.String,System.DateTime},System.Collections.Generic.IDictionary{System.String,System.Double},System.Collections.Generic.IDictionary{System.String,System.Guid})">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.ObservabilityConstants">
|
||||
<summary>
|
||||
Common class containing observability constants to be used as well known metric keys.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.Succeeded">
|
||||
<summary>
|
||||
String used for the name of the property indicating if the call was successful.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.Duration">
|
||||
<summary>
|
||||
String used for the name of the property indicating the call in Duration (ms).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.ActivityId">
|
||||
<summary>
|
||||
String used for the name of the property indicating the call's Activity Id/Correlation Id.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.ClientId">
|
||||
<summary>
|
||||
String used for the name of the property indicating the caller's ClientId.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails">
|
||||
<summary>
|
||||
Details of the telemetry event.
|
||||
</summary>
|
||||
<remarks>
|
||||
This implementation is not meant to be thread-safe. This implementation would either need to be overridden or
|
||||
usage should not be concurrently operated on.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.PropertyValues">
|
||||
<summary>
|
||||
The underlying properties making up the <see cref="T:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.Name">
|
||||
<summary>
|
||||
Name of the telemetry event, should be unique between events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.Properties">
|
||||
<summary>
|
||||
Properties which describe the event.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.String)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Int64)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.DateTime)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Double)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Guid)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,297 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.IdentityModel.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.EventLogLevel">
|
||||
<summary>
|
||||
Defines Event Log Levels.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.LogAlways">
|
||||
<summary>
|
||||
No level filtering is done on this log level. Log messages of all levels will be logged.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Critical">
|
||||
<summary>
|
||||
Logs that describe an unrecoverable application or system crash, or a catastrophic failure that requires
|
||||
immediate attention.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Error">
|
||||
<summary>
|
||||
Logs that highlight when the current flow of execution is stopped due to a failure. These should indicate a
|
||||
failure in the current activity, not an application-wide failure.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Warning">
|
||||
<summary>
|
||||
Logs that highlight an abnormal or unexpected event in the application flow, but do not otherwise cause the
|
||||
application execution to stop.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Informational">
|
||||
<summary>
|
||||
Logs that track the general flow of the application. These logs should have long-term value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Verbose">
|
||||
<summary>
|
||||
Logs that are used for interactive investigation during development. These logs should primarily contain
|
||||
information useful for debugging and have no long-term value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.IIdentityLogger">
|
||||
<summary>
|
||||
Interface that needs to be implemented by classes providing logging in Microsoft identity libraries.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.IIdentityLogger.IsEnabled(Microsoft.IdentityModel.Abstractions.EventLogLevel)">
|
||||
<summary>
|
||||
Checks to see if logging is enabled at given <paramref name="eventLogLevel"/>.
|
||||
</summary>
|
||||
<param name="eventLogLevel">Log level of a message.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.IIdentityLogger.Log(Microsoft.IdentityModel.Abstractions.LogEntry)">
|
||||
<summary>
|
||||
Writes a log entry.
|
||||
</summary>
|
||||
<param name="entry">Defines a structured message to be logged at the provided <see cref="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel"/>.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.ITelemetryClient">
|
||||
<summary>
|
||||
Interface for Telemetry tracking.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.ITelemetryClient.ClientId">
|
||||
<summary>
|
||||
Gets or sets the application or client ID that telemetry is being sent for.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.Initialize">
|
||||
<summary>
|
||||
Perform any necessary bootstrapping for the telemetry client.
|
||||
</summary>
|
||||
<remarks>
|
||||
The expectation is that this should only be called once for the lifetime of the object however the
|
||||
implementation should be idempotent.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.IsEnabled">
|
||||
<summary>
|
||||
Checks to see if telemetry is enabled all up.
|
||||
</summary>
|
||||
<returns>
|
||||
Returns <see langword="true"/> if telemetry should be sent; <see langword="false"/> otherwise.
|
||||
</returns>
|
||||
<remarks>
|
||||
This check should be used to gate any resource intensive operations to generate telemetry as well.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.IsEnabled(System.String)">
|
||||
<summary>
|
||||
Checks to see if telemetry is enabled for the named event.
|
||||
</summary>
|
||||
<param name="eventName">Name of the event to check.</param>
|
||||
<returns>
|
||||
Returns <see langword="true"/> if telemetry should be sent for <paramref name="eventName"/>;
|
||||
<see langword="false"/> otherwise.
|
||||
</returns>
|
||||
<remarks>
|
||||
This check should be used to gate any resource intensive operations to generate telemetry as well.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.TrackEvent(Microsoft.IdentityModel.Abstractions.TelemetryEventDetails)">
|
||||
<summary>
|
||||
Tracks an instance of a named event.
|
||||
</summary>
|
||||
<param name="eventDetails">Details of the event to track.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.TrackEvent(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.Int64},System.Collections.Generic.IDictionary{System.String,System.Boolean},System.Collections.Generic.IDictionary{System.String,System.DateTime},System.Collections.Generic.IDictionary{System.String,System.Double},System.Collections.Generic.IDictionary{System.String,System.Guid})">
|
||||
<summary>
|
||||
Tracks an instance of a named event.
|
||||
</summary>
|
||||
<param name="eventName">Name of the event to track. Should be unique per scenario.</param>
|
||||
<param name="stringProperties">Key value pair of strings to long with the event.</param>
|
||||
<param name="longProperties">Key value pair of longs to long with the event.</param>
|
||||
<param name="boolProperties">Key value pair of bools to long with the event.</param>
|
||||
<param name="dateTimeProperties">Key value pair of DateTimes to long with the event.</param>
|
||||
<param name="doubleProperties">Key value pair of doubles to long with the event.</param>
|
||||
<param name="guidProperties">Key value pair of Guids to long with the event.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.LogEntry">
|
||||
<summary>
|
||||
Defines the structure of a log entry.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel">
|
||||
<summary>
|
||||
Defines the <see cref="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.Message">
|
||||
<summary>
|
||||
Message to be logged.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.CorrelationId">
|
||||
<summary>
|
||||
A unique identifier for a request that can help with diagnostics across components.
|
||||
</summary>
|
||||
<remarks>
|
||||
Also referred to as ActivityId in Microsoft.IdentityModel.Tokens.CallContext.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger">
|
||||
<summary>
|
||||
A minimalistic <see cref="T:Microsoft.IdentityModel.Abstractions.IIdentityLogger"/> implementation that is disabled by default and doesn't log.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.Instance">
|
||||
<summary>
|
||||
Default instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.IsEnabled(Microsoft.IdentityModel.Abstractions.EventLogLevel)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.Log(Microsoft.IdentityModel.Abstractions.LogEntry)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient">
|
||||
<summary>
|
||||
The default implementation of the <see cref="T:Microsoft.IdentityModel.Abstractions.ITelemetryClient"/> interface which swallows all telemetry signals.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.ClientId">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.Instance">
|
||||
<summary>
|
||||
Singleton instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.#ctor">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
Private constructor to prevent the default constructor being exposed.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.IsEnabled">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.IsEnabled(System.String)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.Initialize">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.TrackEvent(Microsoft.IdentityModel.Abstractions.TelemetryEventDetails)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.TrackEvent(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.Int64},System.Collections.Generic.IDictionary{System.String,System.Boolean},System.Collections.Generic.IDictionary{System.String,System.DateTime},System.Collections.Generic.IDictionary{System.String,System.Double},System.Collections.Generic.IDictionary{System.String,System.Guid})">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.ObservabilityConstants">
|
||||
<summary>
|
||||
Common class containing observability constants to be used as well known metric keys.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.Succeeded">
|
||||
<summary>
|
||||
String used for the name of the property indicating if the call was successful.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.Duration">
|
||||
<summary>
|
||||
String used for the name of the property indicating the call in Duration (ms).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.ActivityId">
|
||||
<summary>
|
||||
String used for the name of the property indicating the call's Activity Id/Correlation Id.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.ClientId">
|
||||
<summary>
|
||||
String used for the name of the property indicating the caller's ClientId.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails">
|
||||
<summary>
|
||||
Details of the telemetry event.
|
||||
</summary>
|
||||
<remarks>
|
||||
This implementation is not meant to be thread-safe. This implementation would either need to be overridden or
|
||||
usage should not be concurrently operated on.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.PropertyValues">
|
||||
<summary>
|
||||
The underlying properties making up the <see cref="T:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.Name">
|
||||
<summary>
|
||||
Name of the telemetry event, should be unique between events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.Properties">
|
||||
<summary>
|
||||
Properties which describe the event.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.String)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Int64)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.DateTime)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Double)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Guid)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,297 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.IdentityModel.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.EventLogLevel">
|
||||
<summary>
|
||||
Defines Event Log Levels.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.LogAlways">
|
||||
<summary>
|
||||
No level filtering is done on this log level. Log messages of all levels will be logged.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Critical">
|
||||
<summary>
|
||||
Logs that describe an unrecoverable application or system crash, or a catastrophic failure that requires
|
||||
immediate attention.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Error">
|
||||
<summary>
|
||||
Logs that highlight when the current flow of execution is stopped due to a failure. These should indicate a
|
||||
failure in the current activity, not an application-wide failure.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Warning">
|
||||
<summary>
|
||||
Logs that highlight an abnormal or unexpected event in the application flow, but do not otherwise cause the
|
||||
application execution to stop.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Informational">
|
||||
<summary>
|
||||
Logs that track the general flow of the application. These logs should have long-term value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Verbose">
|
||||
<summary>
|
||||
Logs that are used for interactive investigation during development. These logs should primarily contain
|
||||
information useful for debugging and have no long-term value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.IIdentityLogger">
|
||||
<summary>
|
||||
Interface that needs to be implemented by classes providing logging in Microsoft identity libraries.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.IIdentityLogger.IsEnabled(Microsoft.IdentityModel.Abstractions.EventLogLevel)">
|
||||
<summary>
|
||||
Checks to see if logging is enabled at given <paramref name="eventLogLevel"/>.
|
||||
</summary>
|
||||
<param name="eventLogLevel">Log level of a message.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.IIdentityLogger.Log(Microsoft.IdentityModel.Abstractions.LogEntry)">
|
||||
<summary>
|
||||
Writes a log entry.
|
||||
</summary>
|
||||
<param name="entry">Defines a structured message to be logged at the provided <see cref="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel"/>.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.ITelemetryClient">
|
||||
<summary>
|
||||
Interface for Telemetry tracking.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.ITelemetryClient.ClientId">
|
||||
<summary>
|
||||
Gets or sets the application or client ID that telemetry is being sent for.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.Initialize">
|
||||
<summary>
|
||||
Perform any necessary bootstrapping for the telemetry client.
|
||||
</summary>
|
||||
<remarks>
|
||||
The expectation is that this should only be called once for the lifetime of the object however the
|
||||
implementation should be idempotent.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.IsEnabled">
|
||||
<summary>
|
||||
Checks to see if telemetry is enabled all up.
|
||||
</summary>
|
||||
<returns>
|
||||
Returns <see langword="true"/> if telemetry should be sent; <see langword="false"/> otherwise.
|
||||
</returns>
|
||||
<remarks>
|
||||
This check should be used to gate any resource intensive operations to generate telemetry as well.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.IsEnabled(System.String)">
|
||||
<summary>
|
||||
Checks to see if telemetry is enabled for the named event.
|
||||
</summary>
|
||||
<param name="eventName">Name of the event to check.</param>
|
||||
<returns>
|
||||
Returns <see langword="true"/> if telemetry should be sent for <paramref name="eventName"/>;
|
||||
<see langword="false"/> otherwise.
|
||||
</returns>
|
||||
<remarks>
|
||||
This check should be used to gate any resource intensive operations to generate telemetry as well.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.TrackEvent(Microsoft.IdentityModel.Abstractions.TelemetryEventDetails)">
|
||||
<summary>
|
||||
Tracks an instance of a named event.
|
||||
</summary>
|
||||
<param name="eventDetails">Details of the event to track.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.TrackEvent(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.Int64},System.Collections.Generic.IDictionary{System.String,System.Boolean},System.Collections.Generic.IDictionary{System.String,System.DateTime},System.Collections.Generic.IDictionary{System.String,System.Double},System.Collections.Generic.IDictionary{System.String,System.Guid})">
|
||||
<summary>
|
||||
Tracks an instance of a named event.
|
||||
</summary>
|
||||
<param name="eventName">Name of the event to track. Should be unique per scenario.</param>
|
||||
<param name="stringProperties">Key value pair of strings to long with the event.</param>
|
||||
<param name="longProperties">Key value pair of longs to long with the event.</param>
|
||||
<param name="boolProperties">Key value pair of bools to long with the event.</param>
|
||||
<param name="dateTimeProperties">Key value pair of DateTimes to long with the event.</param>
|
||||
<param name="doubleProperties">Key value pair of doubles to long with the event.</param>
|
||||
<param name="guidProperties">Key value pair of Guids to long with the event.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.LogEntry">
|
||||
<summary>
|
||||
Defines the structure of a log entry.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel">
|
||||
<summary>
|
||||
Defines the <see cref="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.Message">
|
||||
<summary>
|
||||
Message to be logged.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.CorrelationId">
|
||||
<summary>
|
||||
A unique identifier for a request that can help with diagnostics across components.
|
||||
</summary>
|
||||
<remarks>
|
||||
Also referred to as ActivityId in Microsoft.IdentityModel.Tokens.CallContext.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger">
|
||||
<summary>
|
||||
A minimalistic <see cref="T:Microsoft.IdentityModel.Abstractions.IIdentityLogger"/> implementation that is disabled by default and doesn't log.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.Instance">
|
||||
<summary>
|
||||
Default instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.IsEnabled(Microsoft.IdentityModel.Abstractions.EventLogLevel)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.Log(Microsoft.IdentityModel.Abstractions.LogEntry)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient">
|
||||
<summary>
|
||||
The default implementation of the <see cref="T:Microsoft.IdentityModel.Abstractions.ITelemetryClient"/> interface which swallows all telemetry signals.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.ClientId">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.Instance">
|
||||
<summary>
|
||||
Singleton instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.#ctor">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
Private constructor to prevent the default constructor being exposed.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.IsEnabled">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.IsEnabled(System.String)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.Initialize">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.TrackEvent(Microsoft.IdentityModel.Abstractions.TelemetryEventDetails)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.TrackEvent(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.Int64},System.Collections.Generic.IDictionary{System.String,System.Boolean},System.Collections.Generic.IDictionary{System.String,System.DateTime},System.Collections.Generic.IDictionary{System.String,System.Double},System.Collections.Generic.IDictionary{System.String,System.Guid})">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.ObservabilityConstants">
|
||||
<summary>
|
||||
Common class containing observability constants to be used as well known metric keys.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.Succeeded">
|
||||
<summary>
|
||||
String used for the name of the property indicating if the call was successful.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.Duration">
|
||||
<summary>
|
||||
String used for the name of the property indicating the call in Duration (ms).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.ActivityId">
|
||||
<summary>
|
||||
String used for the name of the property indicating the call's Activity Id/Correlation Id.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.ClientId">
|
||||
<summary>
|
||||
String used for the name of the property indicating the caller's ClientId.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails">
|
||||
<summary>
|
||||
Details of the telemetry event.
|
||||
</summary>
|
||||
<remarks>
|
||||
This implementation is not meant to be thread-safe. This implementation would either need to be overridden or
|
||||
usage should not be concurrently operated on.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.PropertyValues">
|
||||
<summary>
|
||||
The underlying properties making up the <see cref="T:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.Name">
|
||||
<summary>
|
||||
Name of the telemetry event, should be unique between events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.Properties">
|
||||
<summary>
|
||||
Properties which describe the event.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.String)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Int64)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.DateTime)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Double)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Guid)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1 @@
|
||||
F174v3i2PzwyfmgNXPdyHXTynpZGDmhrIrTmfCZPsDanqb6hRz9KW0hzN6t6VgyGG1HtGqdEd38wM2ImKwGotA==
|
||||
Reference in New Issue
Block a user