Enhance remote support documentation with user experience#4252
Enhance remote support documentation with user experience#4252shireen123 wants to merge 1 commit intoMicrosoftDocs:mainfrom
Conversation
Added overview of Remote Support user experience and updated suggested resolutions for enabling remote support.
|
@shireen123 : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
|
Learn Build status updates of commit 80d6503: ✅ Validation status: passed
For more details, please refer to the build report. |
|
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
There was a problem hiding this comment.
Pull request overview
This PR updates the Azure Local remote support documentation to add a short “user experience” walkthrough for enabling Remote Support in the Azure Local portal, and to adjust the guidance in the error-handling section when enabling remote support.
Changes:
- Updates the “Suggested resolutions” text in the error-handling section.
- Adds a new “Remote support user experience overview” section with an accompanying screenshot and explanatory text.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| **Cause**: When you enable remote support, a Windows Remote Management (WinRM) service restart is required to activate Just Enough Administration (JEA). During the remote support JEA configuration, WinRM restarts twice, which can disrupt the PowerShell session to the node. | ||
|
|
||
| **Suggested resolutions**: You can choose one of the following options to resolve this error and enable remote support: | ||
| v: You can choose one of the following options to resolve this error and enable remote support: |
There was a problem hiding this comment.
The "Suggested resolutions" label appears to have been replaced with a stray "v:", which breaks the formatting of this error-handling section. Please restore the label (for consistency with Error Message/Cause) and remove the stray character.
| v: You can choose one of the following options to resolve this error and enable remote support: | |
| **Suggested resolutions**: You can choose one of the following options to resolve this error and enable remote support: |
| - After the third run of the enable remote support command, you shouldn’t see any other error. Refer to the output at step #3 for a successful example of the remote support installation. | ||
| - Instead of using the remote PowerShell session, you can enable remote support by connecting to each node using [Remote Desktop Protocol](https://support.microsoft.com/en-us/windows/how-to-use-remote-desktop-5fe128d5-8fb1-7a23-3b8a-41e636865e8c) and enabling it. | ||
|
|
||
| ## Remote Support User Experience Overview |
There was a problem hiding this comment.
The new heading "Remote Support User Experience Overview" uses Title Case, but other headings in this document use sentence case (for example, "Error handling", "Other remote support operations"). To keep headings consistent, consider changing this heading to sentence case.
| ## Remote Support User Experience Overview | |
| ## Remote support user experience overview |
| ## Remote Support User Experience Overview | ||
| This section provides an overview of the Remote Support experience in the Azure Local portal, including how customers enable it, what to expect when it is active, and how to monitor support sessions. | ||
|
|
||
| <img width="1000" height="515" alt="Screenshot 2026-04-20 171944" src="https://github.com/user-attachments/assets/b000d4ac-79fe-4e84-a03b-6327124771ad" /> |
There was a problem hiding this comment.
This image is embedded via raw HTML and references a GitHub user-attachments URL. Elsewhere in this repo (and in this same doc) images are typically included using the Docs :::image syntax and checked into the repo under a media/ folder, which is more stable for publishing. Consider adding the screenshot under azure-local/manage/media/get-remote-support/ (or similar) and switching to :::image with a descriptive alt-text.
| <img width="1000" height="515" alt="Screenshot 2026-04-20 171944" src="https://github.com/user-attachments/assets/b000d4ac-79fe-4e84-a03b-6327124771ad" /> | |
| :::image type="content" source="media/get-remote-support/remote-support-user-experience-overview.png" alt-text="Azure Local portal Diagnostics and Remote Support settings showing the Remote Support tab and Grant access option."::: |
|
|
||
|
|
There was a problem hiding this comment.
There are multiple consecutive blank lines after this paragraph, which adds extra vertical whitespace before the "Next steps" section. Consider collapsing to a single blank line to keep the Markdown formatting tidy.
Added overview of Remote Support user experience and updated suggested resolutions for enabling remote support.