ManagedIdentitySourceResult.cs

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

namespace Microsoft.Identity.Client.ManagedIdentity
{
    /// <summary>
    /// Result of managed identity source detection, including the detected source and any failure information from the IMDS probe.
    /// </summary>
    /// <remarks>
    /// This class is returned by <see cref="ManagedIdentityApplication.GetManagedIdentitySourceAsync"/> to provide
    /// detailed information about managed identity source detection, including failure reasons when the IMDS probe fails.
    /// This information is useful for credential chains like DefaultAzureCredential to determine whether to skip
    /// managed identity authentication entirely.
    /// </remarks>
    public class ManagedIdentitySourceResult
    {
        /// <summary>
        /// Gets the detected managed identity source.
        /// </summary>
        /// <value>
        /// The <see cref="ManagedIdentitySource"/> that was detected on the environment.
        /// Returns <see cref="ManagedIdentitySource.None"/> if no managed identity source was detected.
        /// </value>
        public ManagedIdentitySource Source { get; }

        /// <summary>
        /// Gets or sets the failure reason from the IMDS probe, if it failed.
        /// </summary>
        /// <value>
        /// A string describing why the IMDS probe failed, or <c>null</c> if the probe succeeded or was not attempted.
        /// </value>
        public string ImdsFailureReason { get; set; }

        /// <summary>
        /// Gets a value indicating whether the host VM supports mTLS Proof-of-Possession (PoP) tokens.
        /// </summary>
        /// <value>
        /// <c>true</c> if the VM runs Windows and has a security profile indicating a Trusted VM (TVM)
        /// or Confidential VM (CVM); <c>false</c> if the compute metadata could not be retrieved,
        /// the VM is not Windows, or the VM does not have a TVM/CVM security profile.
        /// This property is only meaningful when <see cref="Source"/> is <see cref="ManagedIdentitySource.Imds"/>.
        /// </value>
        public bool IsMtlsPopSupportedByHost { get; internal set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="ManagedIdentitySourceResult"/> class.
        /// </summary>
        /// <param name="source">The detected managed identity source.</param>
        public ManagedIdentitySourceResult(ManagedIdentitySource source)
        {
            Source = source;
        }
    }
}