docs: Add explicit User-Assigned Managed Identity (UAMI) example for Event Hubs binding#128219
docs: Add explicit User-Assigned Managed Identity (UAMI) example for Event Hubs binding#128219paulyuk wants to merge 1 commit intoMicrosoftDocs:mainfrom
Conversation
This PR adds a clearer example showing how to configure Event Hubs connections using a User-Assigned Managed Identity (UAMI) with explicit app settings for credential and clientId. The existing documentation mentions these properties but lacks a concrete JSON example showing the full configuration pattern that developers can copy directly. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
@paulyuk : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
|
Learn Build status updates of commit f37ea19: ✅ Validation status: passed
For more details, please refer to the build report. |
PRMerger Results
|
There was a problem hiding this comment.
Pull request overview
Adds a concrete documentation example for configuring Azure Functions Event Hubs bindings using a User-Assigned Managed Identity (UAMI) via explicit app settings.
Changes:
- Introduces a “User-assigned managed identity” subsection for Event Hubs connections
- Adds a properties table and a copy/paste JSON app settings example
- Provides guidance (TIP) on when UAMI is recommended
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | Property | Environment variable template | Description | Example value | | ||
| |--------------|----------|-----|----------| | ||
| | Fully Qualified Namespace | `<CONNECTION_NAME_PREFIX>__fullyQualifiedNamespace` | The fully qualified Event Hubs namespace. | `myeventhubns.servicebus.windows.net`| | ||
| | Credential | `<CONNECTION_NAME_PREFIX>__credential` | Must be set to `managedidentity`. | `managedidentity` | | ||
| | Client ID | `<CONNECTION_NAME_PREFIX>__clientId` | The client ID of the user-assigned managed identity. | `00000000-0000-0000-0000-000000000000` | |
There was a problem hiding this comment.
The Markdown table syntax is invalid due to the doubled leading pipes (||) and a mismatched separator row, which will render incorrectly. Use standard Markdown table formatting with a single leading | per row and a separator row that matches the number of columns.
|
Can you review the proposed changes? IMPORTANT: When the changes are ready for publication, adding a #label:"aq-pr-triaged" |
prmerger-automator
bot
added
the
aq-pr-triaged
3 participants
Summary
This PR adds a clearer example showing how to configure Event Hubs connections using a User-Assigned Managed Identity (UAMI) with explicit app settings.
Problem
The existing documentation mentions
credentialandclientIdproperties for user-assigned managed identities but lacks a concrete JSON example. Developers need to piece together information from multiple sources to configure UAMI.Solution
Added a new "User-assigned managed identity" subsection with:
fullyQualifiedNamespace,credential,clientId)Changes
includes/functions-event-hubs-connections.md: Added UAMI configuration exampleWhy This Matters
User-Assigned Managed Identity is recommended for:
Related
This change aligns with Azure security best practices for passwordless authentication.