[RecoveryServices.Backup] Add Cross Subscription Backup (CSB) support for Azure VM by Prabhkiratnitp · Pull Request #29799 · Azure/azure-powershell

Prabhkiratnitp · 2026-07-02T17:06:58Z

Description

Adds Cross Subscription Backup (CSB) support for Azure VM in the RecoveryServices.Backup module:

Enable-AzRecoveryServicesBackupProtection: new optional -ContainerSubscriptionId parameter to configure backup for a VM residing in a different subscription than the vault. The CSB path skips container discovery/RefreshContainers and constructs the container/protected-item URIs and sourceResourceId directly.
Restore-AzRecoveryServicesBackupItem: Original Location Recovery (OLR) now works for cross-subscription protected items — the container subscription is derived from the recovery point SourceResourceId so the staging storage account is resolved in the VM's subscription. No new input required.
Get-AzRecoveryServicesBackupItem: added ContainerSubscriptionId (parsed from SourceResourceId).
Get-AzRecoveryServicesBackupJob: added ContainerSubscriptionId to the detailed job response (from extendedInfo property bag).

All changes are additive and non-breaking. Added scenario tests with recordings, help examples, and ChangeLog entry.

Mandatory Checklist

Please choose the target release of Azure PowerShell. (⚠️Target release is a different concept from API readiness. Please click below links for details.)
- General release
- Public preview
- Private preview
- Engineering build
- No need for a release
Check this box to confirm: I have read the Submitting Changes section of CONTRIBUTING.md and reviewed the following information:

SHOULD update ChangeLog.md file(s) appropriately
- Update src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.
  - A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense.
- Should not change ChangeLog.md if no new release is required, such as fixing test case only.
SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
SHOULD have proper test coverage for changes in pull request.
SHOULD NOT adjust version of module manually in pull request

…ervices - Add optional -ContainerSubscriptionId parameter to Enable-AzRecoveryServicesBackupProtection (AzureVMCompute parameter set) to configure backup for a VM in a different subscription than the vault; the CSB path skips discovery/RefreshContainers and constructs the container/protected item URIs and source resource id directly. - Add Original Location Recovery (OLR) support for cross-subscription protected items in Restore-AzRecoveryServicesBackupItem by deriving the container subscription from the recovery point SourceResourceId (no new input required). - Add ContainerSubscriptionId to Get-AzRecoveryServicesBackupItem response (parsed from SourceResourceId) and to the detailed Get-AzRecoveryServicesBackupJob response (from extendedInfo propertyBag). - Add scenario tests and recordings, help examples, and ChangeLog entry. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

azure-client-tools-bot-prd · 2026-07-02T17:07:02Z

Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status.

microsoft-github-policy-service · 2026-07-02T17:07:31Z

Thank you for your contribution @Prabhkiratnitp! We will review the pull request and get back to you soon.

Copilot

Pull request overview

Adds Cross Subscription Backup (CSB) support for Azure VM scenarios in the RecoveryServices.Backup module by enabling protection of VMs that live in a different subscription than the vault, and by improving Original Location Recovery (OLR) behavior for cross-subscription protected items.

Changes:

Added optional -ContainerSubscriptionId to Enable-AzRecoveryServicesBackupProtection (AzureVM compute parameter set) to enable protection for cross-subscription VMs by bypassing discovery and constructing URIs/sourceResourceId directly.
Updated restore flow for OLR to derive the target subscription from the recovery point’s SourceResourceId (when -TargetSubscriptionId is not provided) so staging storage account resolution works for CSB items.
Exposed ContainerSubscriptionId on Get-AzRecoveryServicesBackupItem (parsed from SourceResourceId) and on detailed job responses (Get-AzRecoveryServicesBackupJobDetail) via extendedInfo.propertyBag["VM Subscription ID"], plus added scenario tests, recordings, help examples, and a changelog entry.

Reviewed changes

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

Show a summary per file

File	Description
src/RecoveryServices/RecoveryServices.Backup/Cmdlets/Item/EnableAzureRmRecoveryServicesBackupProtection.cs	Adds `-ContainerSubscriptionId` parameter and forwards it into provider data for enable protection flow.
src/RecoveryServices/RecoveryServices.Backup.Providers/Providers/IaasVmPsBackupProvider.cs	Implements CSB enable-protection shortcut path and OLR subscription derivation from recovery point `SourceResourceId`.
src/RecoveryServices/RecoveryServices.Backup.Models/AzureVmModels/AzureVmItem.cs	Adds `ContainerSubscriptionId` on item model by parsing subscription from `SourceResourceId`.
src/RecoveryServices/RecoveryServices.Backup.Models/AzureVmModels/AzureVmJob.cs	Adds `ContainerSubscriptionId` field to the detailed Azure VM job model.
src/RecoveryServices/RecoveryServices.Backup.Helpers/Conversions/JobConversions.cs	Populates detailed job `ContainerSubscriptionId` from `extendedInfo.propertyBag["VM Subscription ID"]` (including CRR variant).
src/RecoveryServices/RecoveryServices.Backup.Models/CmdletParamEnums.cs	Extends `ItemParams` enum with `ContainerSubscriptionId` for provider data keying.
src/RecoveryServices/RecoveryServices.Backup/ParamHelpMsgs.cs	Adds help text constant for the new `-ContainerSubscriptionId` parameter.
src/RecoveryServices/RecoveryServices/help/Enable-AzRecoveryServicesBackupProtection.md	Documents the new parameter and adds a CSB enable-protection example.
src/RecoveryServices/RecoveryServices/help/Restore-AzRecoveryServicesBackupItem.md	Adds an example clarifying OLR behavior for cross-subscription protected items.
src/RecoveryServices/RecoveryServices/ChangeLog.md	Adds an “Upcoming Release” entry describing CSB support additions across cmdlets.
src/RecoveryServices/RecoveryServices.Backup.Test/ScenarioTests/IaasVm/ItemTests.ps1	Adds CSB protection and CSB OLR restore scenario tests.
src/RecoveryServices/RecoveryServices.Backup.Test/ScenarioTests/IaasVm/ItemTests.cs	Wires new CSB item scenario tests into xUnit runner.
src/RecoveryServices/RecoveryServices.Backup.Test/ScenarioTests/IaasVm/JobTests.ps1	Adds CSB job detail scenario test for `ContainerSubscriptionId`.
src/RecoveryServices/RecoveryServices.Backup.Test/ScenarioTests/IaasVm/JobTests.cs	Wires new CSB job scenario test into xUnit runner.
src/RecoveryServices/RecoveryServices.Backup.Test/SessionRecords/.../TestAzureVMCSBProtection.json	Recording for CSB protection scenario.
src/RecoveryServices/RecoveryServices.Backup.Test/SessionRecords/.../TestAzureVMCSBRestoreOLR.json	Recording for CSB OLR restore scenario.
src/RecoveryServices/RecoveryServices.Backup.Test/SessionRecords/.../TestAzureVMCSBJobSubscription.json	Recording for CSB job detail subscription scenario.

microsoft-github-policy-service · 2026-07-03T05:25:55Z

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

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

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

github-actions · 2026-07-03T05:26:02Z

‼️ DO NOT MERGE THIS PR ‼️
This PR was labeled "Do Not Merge" because it contains code change that cannot be merged. Please contact the reviewer for more information.

hiaga · 2026-07-03T06:03:28Z

/azp run

azure-pipelines · 2026-07-03T06:03:35Z

Commenter does not have sufficient privileges for PR 29799 in repo Azure/azure-powershell

thomas-temby · 2026-07-05T23:55:39Z

/azp run

azure-pipelines · 2026-07-05T23:55:53Z

Azure Pipelines successfully started running 3 pipeline(s).

hiaga

Reviewed the CSB code paths. Build/tests are green and the design is sound; a few items below — only the first (skipping discovery-time validation) is substantive, the rest are minor/nit. Nice work on deriving the container subscription from the recovery point for OLR staging.

hiaga · 2026-07-06T08:20:54Z

-                    (IaaSVMProtectableItem)protectableObjectResource.Properties;                
-
-                if (iaasVmProtectableItem != null)
+                if (!string.IsNullOrEmpty(containerSubscriptionId))


question: on the CSB path we skip discovery entirely, so a typo in -Name/-ResourceGroupName or an ineligible VM no longer surfaces the clear "VM not discovered" client error and instead fails opaquely at the backend — is a lightweight existence/eligibility check (or at least a doc note) worth adding?

hiaga · 2026-07-06T08:20:54Z

+        [Parameter(Mandatory = false, ParameterSetName = AzureVMComputeParameterSet,
+            HelpMessage = ParamHelpMsgs.Item.containerSubscriptionId)]
+        [ValidateNotNullOrEmpty]
+        public string ContainerSubscriptionId { get; set; }


Consider validating -ContainerSubscriptionId as a GUID (ValidatePattern / Guid.TryParse); today a malformed value silently builds a bad sourceResourceId and only fails at the service.

hiaga · 2026-07-06T08:20:54Z

+                    // and will not find the cross-subscription VM. Hence, we skip discovery and construct the
+                    // container URI, protected item URI and source resource ID directly. The backend derives the
+                    // VM's subscription from the source resource ID and configures backup accordingly.
+                    string vmVersion = isComputeAzureVM ? computeAzureVMVersion : classicComputeAzureVMVersion;


-ContainerSubscriptionId is only in AzureVMComputeParameterSet, so isComputeAzureVM is always true here — the classic (iaasvmcontainer / ClassicCompute) branch of these ternaries can never execute; consider dropping it or intentionally supporting classic.

hiaga · 2026-07-06T08:20:54Z

                        detailedResponse.Properties.Add(key, vmJob.ExtendedInfo.PropertyBag[key]);
                    }
+
+                    if (vmJob.ExtendedInfo.PropertyBag.ContainsKey("VM Subscription ID"))


nit: extract the "VM Subscription ID" propertyBag key into a named const — it's duplicated here and in GetPSAzureVmJobCrr and will drift.

hiaga · 2026-07-06T08:20:54Z

+
+                    containerUri = string.Format("IaasVMContainer;{0};{1};{2}",
+                        containerType, azureVMRGName, azureVMName);
+                    protectedItemUri = string.Format("VM;{0};{1};{2}",


nit: the rest of the module emits lowercase "vm;" (via GetProtectableItemUri); "VM;" works (ARM is case-insensitive) but is inconsistent.

hiaga · 2026-07-06T08:20:54Z

+		Assert-True { $modifiedItem.ContainerSubscriptionId -eq $containerSubscriptionId };
+	}
+	finally
+	{


This finally is empty but the test enables protection — file convention (e.g. Test-AzureRestoreWithCVMOsDiskEncryptionSetId) disables/deletes in finally; please clean up the protected item.

hiaga · 2026-07-06T08:20:54Z

+                // Extract the container (VM) subscription from the recovery point's SourceResourceId so that the
+                // target storage account is resolved in the correct subscription. No new input is required from
+                // the customer. For all other cases, fall back to the vault's (context) subscription.
+                if (string.Compare(restoreType, "OriginalLocation") == 0 && !string.IsNullOrEmpty(rp.SourceResourceId))


praise: deriving targetSubscriptionId from rp.SourceResourceId for OLR (so staging storage resolves in the VM's subscription) is the right fix and matches the existing restoreType convention.

Copilot AI review requested due to automatic review settings July 2, 2026 17:06

microsoft-github-policy-service Bot added the customer-reported label Jul 2, 2026

Copilot started reviewing on behalf of Prabhkiratnitp July 2, 2026 17:07 View session

Copilot AI reviewed Jul 2, 2026

View reviewed changes

Prabhkiratnitp marked this pull request as ready for review July 2, 2026 17:13

Prabhkiratnitp marked this pull request as draft July 2, 2026 17:14

hiaga added the Do Not Merge 🚫 label Jul 3, 2026

Prabhkiratnitp marked this pull request as ready for review July 3, 2026 05:26

refactor

1826b18

hiaga reviewed Jul 6, 2026

View reviewed changes

Uh oh!

Conversation

Prabhkiratnitp commented Jul 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Mandatory Checklist

Uh oh!

azure-client-tools-bot-prd Bot commented Jul 2, 2026

Uh oh!

microsoft-github-policy-service Bot commented Jul 2, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

microsoft-github-policy-service Bot commented Jul 3, 2026

Contribution License Agreement

Uh oh!

github-actions Bot commented Jul 3, 2026

Uh oh!

hiaga commented Jul 3, 2026

Uh oh!

azure-pipelines Bot commented Jul 3, 2026

Uh oh!

thomas-temby commented Jul 5, 2026

Uh oh!

azure-pipelines Bot commented Jul 5, 2026

Uh oh!

hiaga left a comment

Choose a reason for hiding this comment

Uh oh!

hiaga Jul 6, 2026

Choose a reason for hiding this comment

Uh oh!

hiaga Jul 6, 2026

Choose a reason for hiding this comment

Uh oh!

hiaga Jul 6, 2026

Choose a reason for hiding this comment

Uh oh!

hiaga Jul 6, 2026

Choose a reason for hiding this comment

Uh oh!

hiaga Jul 6, 2026

Choose a reason for hiding this comment

Uh oh!

hiaga Jul 6, 2026

Choose a reason for hiding this comment

Uh oh!

hiaga Jul 6, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Prabhkiratnitp commented Jul 2, 2026 •

edited

Loading