Skip to content

[Backup] az backup: Add Cross Subscription Backup (CSB) support for A…#33703

Draft
Prabhkiratnitp wants to merge 1 commit into
Azure:devfrom
Prabhkiratnitp:users/singhprab/csb-cli
Draft

[Backup] az backup: Add Cross Subscription Backup (CSB) support for A…#33703
Prabhkiratnitp wants to merge 1 commit into
Azure:devfrom
Prabhkiratnitp:users/singhprab/csb-cli

Conversation

@Prabhkiratnitp

Copy link
Copy Markdown

…zure VM

  • az backup protection enable-for-vm: accept a full VM ARM id in a different subscription than the vault (CSB); skip discovery and construct the container/protected-item URIs and sourceResourceId directly, after validating the VM exists and is in the vault's region
  • az backup restore restore-disks: support OLR for CSB protected items by deriving the container subscription from the item sourceResourceId; fail with a clear error when a friendly container name matches multiple containers
  • az backup item list/show: add containerSubscriptionId to the Azure VM backup item response
  • az backup job show: add containerSubscriptionId to the Azure VM backup job response
  • Add tests, recording, help examples and history notes

Related command

Description

Testing Guide

History Notes

[Component Name 1] BREAKING CHANGE: az command a: Make some customer-facing breaking change
[Component Name 2] az command b: Add some customer-facing feature


This checklist is used to make sure that common guidelines for a pull request are followed.

…zure VM

- az backup protection enable-for-vm: accept a full VM ARM id in a different subscription than the
  vault (CSB); skip discovery and construct the container/protected-item URIs and sourceResourceId
  directly, after validating the VM exists and is in the vault's region
- az backup restore restore-disks: support OLR for CSB protected items by deriving the container
  subscription from the item sourceResourceId; fail with a clear error when a friendly container name
  matches multiple containers
- az backup item list/show: add containerSubscriptionId to the Azure VM backup item response
- az backup job show: add containerSubscriptionId to the Azure VM backup job response
- Add tests, recording, help examples and history notes

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@Prabhkiratnitp Prabhkiratnitp requested a review from a team as a code owner July 6, 2026 13:00
Copilot AI review requested due to automatic review settings July 6, 2026 13:00
@Prabhkiratnitp Prabhkiratnitp requested review from a team as code owners July 6, 2026 13:00
@azure-client-tools-bot-prd

Copy link
Copy Markdown
Validation for Azure CLI Full Test Starting...

Thanks for your contribution!

@azure-client-tools-bot-prd

Copy link
Copy Markdown
Validation for Breaking Change Starting...

Thanks for your contribution!

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 extends the az backup command module to support Cross Subscription Backup (CSB) scenarios for Azure VM protection and restore, and surfaces the protected VM’s subscription on item/job responses to help customers operate across vault/VM subscription boundaries.

Changes:

  • Enable az backup protection enable-for-vm to accept a full cross-subscription VM ARM ID and bypass protectable-item discovery by constructing container/item URIs directly.
  • Improve restore flows for CSB, including Original Location Recovery behavior and clearer failures when friendly names are ambiguous.
  • Add containerSubscriptionId to Azure VM backup item and job outputs, plus tests/recordings/help/history notes.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
src/azure-cli/HISTORY.rst Adds history notes documenting new CSB behavior and response fields.
src/azure-cli/azure/cli/command_modules/backup/tests/latest/test_backup_commands.py Adds validation for containerSubscriptionId on Azure VM backup items and introduces a playback-only ambiguity regression test.
src/azure-cli/azure/cli/command_modules/backup/tests/latest/recordings/test_backup_restore_multiple_containers_same_friendly_name.yaml Recording supporting the new ambiguity regression scenario.
src/azure-cli/azure/cli/command_modules/backup/custom.py Implements CSB enable-for-vm path, ambiguity validation, OLR subscription derivation, and job response augmentation.
src/azure-cli/azure/cli/command_modules/backup/custom_help.py Adds helpers to surface containerSubscriptionId for items/jobs.
src/azure-cli/azure/cli/command_modules/backup/custom_common.py Ensures item list/show consistently set containerSubscriptionId.
src/azure-cli/azure/cli/command_modules/backup/_help.py Adds help examples/long-summary guidance for CSB/native names.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +956 to +958
container_uri = "IaasVMContainer;iaasvmcontainerv2;{};{}".format(vm_rg, vm_name)
item_uri = "vm;iaasvmcontainerv2;{};{}".format(vm_rg, vm_name)
vm_item_properties = _get_vm_item_properties_from_vm_id(vm)
Comment on lines +1770 to +1772
return cust_help.set_job_container_subscription_id(cust_help.replace_min_value_in_subtask(response))
response = client.get(vault_name, resource_group_name, name)
return cust_help.replace_min_value_in_subtask(response)
return cust_help.set_job_container_subscription_id(cust_help.replace_min_value_in_subtask(response))
@yonzhan

yonzhan commented Jul 6, 2026

Copy link
Copy Markdown
Collaborator

Backup

@microsoft-github-policy-service

Copy link
Copy Markdown
Contributor

@Prabhkiratnitp 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.

@yonzhan yonzhan requested a review from yanzhudd July 6, 2026 23:13
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.

4 participants