Skip to content

Include ManagedIdentitySource in managed identity error messages and request-failure logs#6095

Open
juliovi-1 wants to merge 2 commits into
AzureAD:mainfrom
juliovi-1:dev/juliovi/mi-exception-source-in-message
Open

Include ManagedIdentitySource in managed identity error messages and request-failure logs#6095
juliovi-1 wants to merge 2 commits into
AzureAD:mainfrom
juliovi-1:dev/juliovi/mi-exception-source-in-message

Conversation

@juliovi-1

Copy link
Copy Markdown

Summary

Managed identity authentication failures surface a host-issued Managed Identity Correlation ID, but neither the customer-facing error message nor the request-failure log indicated which managed identity source (AppService, Imds, ServiceFabric, AzureArc, CloudShell, MachineLearning, etc.) produced that correlation ID. During live-site investigations this is ambiguous: each host emits its correlation ID into its own telemetry, so without the source you don't know which host's telemetry to search.

This change appends the detected ManagedIdentitySource to:

  • the request-failure log line ([Managed Identity] request failed, Source: {source}, ...), and
  • the customer-facing correlation ID message, clarifying that the correlation ID should be searched in that source's telemetry.

The source is taken from the existing _sourceType value already known to AbstractManagedIdentity at runtime — it is not hardcoded; the value reflects the host detected at runtime.

Motivation

We recently root-caused a ManagedIdentityCredential authentication failed incident where the failure originated in the host (App Service) with an AADSTS500011 resource-principal-not-found error. The host-issued correlation ID was present, but the exception did not say it came from the App Service host, slowing down the investigation. Surfacing the source makes the correlation ID directly actionable.

Changes

  • AbstractManagedIdentity.cs: include _sourceType in the request-failure log line and in the correlation ID message (only when a host correlation ID is present).
  • ManagedIdentityTests.cs: updated ManagedIdentityTestErrorResponseParsing rows that carry a host correlationId to assert the source (AppService) and the new explanatory text appear in the message.
  • CHANGELOG.md: added a ### Changes entry under the in-progress version.

Testing

  • ManagedIdentityTestErrorResponseParsing — all rows pass.
  • ManagedIdentityTestWrongScopeAsync (cross-source regression coverage) — passes.
  • Local build of Microsoft.Identity.Client is clean; no public API surface changes.

Notes

  • No behavioral/auth changes — message/log content only.
  • The CHANGELOG link placeholder will be updated with this PR number.

…e logs

Managed identity authentication failures surface a host-issued
'Managed Identity Correlation ID', but the message did not indicate which
managed identity source (AppService, Imds, ServiceFabric, etc.) produced it,
making it ambiguous which host's telemetry to search during investigations.

This change appends the detected ManagedIdentitySource to both the
request-failure log line and the customer-facing correlation ID message,
so the correlation ID can be traced to the correct host's telemetry.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 29, 2026 23:45
@juliovi-1 juliovi-1 requested a review from a team as a code owner June 29, 2026 23:45
@microsoft-github-policy-service

Copy link
Copy Markdown

@juliovi-1 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR improves managed identity diagnostics by including the detected ManagedIdentitySource in both request-failure logs and customer-facing error messages when a host-issued managed identity correlation ID is present, making correlation IDs actionable during live-site investigations.

Changes:

  • Added ManagedIdentitySource to the managed identity request-failure error log line.
  • Appended ManagedIdentitySource context to the “Managed Identity Correlation ID” portion of the error message (when correlation ID is present).
  • Updated unit tests and changelog entry to reflect the new message/log content.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
src/client/Microsoft.Identity.Client/ManagedIdentity/AbstractManagedIdentity.cs Adds _sourceType to request-failure logging and correlation-ID error message text.
tests/Microsoft.Identity.Test.Unit/ManagedIdentityTests/ManagedIdentityTests.cs Updates expected substrings in parsing tests to assert the new source/context text.
CHANGELOG.md Documents the diagnostic message/log enhancement under the in-progress release section.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants