Changes for Restore documentation#4262
Conversation
|
@amdeocha : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
|
Learn Build status updates of commit 438a258: ✅ Validation status: passed
For more details, please refer to the build report. |
PRMerger Results
|
|
If you approve the new content in this PR, the commits must be moved to the private repository for automated checks and publishing. After you move the commits, close this PR ( #label:"aq-pr-triaged" |
There was a problem hiding this comment.
Pull request overview
Adds initial “Restore” documentation for Azure Local disconnected operations and updates navigation/backup docs accordingly.
Changes:
- Adds a new restore how-to/concept article for disconnected operations.
- Updates the backup article title and removes the “restore is in development” disclaimer.
- Adds the new restore article to the Azure Local TOC under Disconnected operations.
Reviewed changes
Copilot reviewed 3 out of 6 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| azure-local/manage/disconnected-operations-restore.md | New restore documentation (cmdlets, prerequisites, post-restore caveats) gated by monikers. |
| azure-local/manage/disconnected-operations-back-up-restore.md | Updates page metadata title and removes restore-in-development notice. |
| azure-local/TOC.yml | Adds TOC entry linking to the new restore article. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| # Restore for disconnected operations for Azure Local | ||
|
|
||
| ::: moniker range=">=azloc-2602" |
There was a problem hiding this comment.
The moniker range starts at ">=azloc-2602", but the feature note below says restore is only available in Azure Local 2603+. As written, the restore content will render for azloc-2602 (and also overlaps with the fallback moniker), which is misleading. Update the content moniker to start at the correct version (likely ">=azloc-2603") so it doesn’t display for 2602.
| ::: moniker range=">=azloc-2602" | |
| ::: moniker range=">=azloc-2603" |
| ::: moniker-end | ||
| ::: moniker range="<=azloc-2602" |
There was a problem hiding this comment.
The fallback moniker range overlaps the main content moniker (both include azloc-2602), so users on 2602 can see both the restore instructions and the "2603 or later" warning. Adjust the fallback moniker to avoid overlap (for example, use "<azloc-2603", consistent with azure-local/manage/manage-secure-boot-updates.md:230).
| ::: moniker range="<=azloc-2602" | |
| ::: moniker range="<azloc-2603" |
| Import-Module "<full path to Operations Module>\Azure.Local.Restore.psm1" | ||
| ``` | ||
|
|
||
| ## Trigger and monitor a backup |
There was a problem hiding this comment.
Section heading says "Trigger and monitor a backup" but the section content and commands are for restore. Rename the heading to "Trigger and monitor a restore" to avoid confusing readers.
| ## Trigger and monitor a backup | |
| ## Trigger and monitor a restore |
| > [!IMPORTANT] | ||
| > The restore operation supports restoring the backup to the same version of Azure local disconnected environment. | ||
| ## Overview | ||
|
|
||
| The backup feature currently backs up only the control plane VM data. It doesn't include associated workloads or configured clusters. The restore functionality restores the control plane data from the backup. So, ensure that you configure the same version of Azure local disconnected where you restore the backup. |
There was a problem hiding this comment.
In this IMPORTANT note and the following paragraph, "Azure local" is inconsistently cased compared to "Azure Local" elsewhere in the article/title. Please standardize the product name casing (and related phrasing) so readers don’t interpret it as a different term.
| - **Environment Setup:** Ensure that you have a fresh Azure local Disconnected environment that you set up and that the version matches the backup version. Cross version restores aren't supported. | ||
|
|
||
| - **Root Certificate:** For the Restore VM, ensure that the same Root Certificate - Certificate Authority is used for the new VM Creation to ensure the trust. | ||
|
|
There was a problem hiding this comment.
These prerequisites have multiple capitalization/grammar issues (for example "Azure local Disconnected", "Cross version", and "new VM Creation") that make the steps harder to follow. Please standardize capitalization ("Azure Local disconnected"), use the hyphenated form ("cross-version"), and rephrase the root certificate requirement more clearly.
| - name: Back up disconnected operations | ||
| href: manage/disconnected-operations-back-up-restore.md | ||
| - name: Restore disconnected operations | ||
| href: manage/disconnected-operations-restore.md |
There was a problem hiding this comment.
This TOC line has trailing whitespace after the href value. Please remove trailing spaces to avoid YAML/markdown lint noise and unnecessary diffs.
| href: manage/disconnected-operations-restore.md | |
| href: manage/disconnected-operations-restore.md |
|
#please-close Files fixed in private repo: https://github.com/MicrosoftDocs/azure-stack-docs-pr/pull/20631 |
Changes for Restore documentation