[Backup] Add Azure File Share cross-region restore and soft-delete undelete support by bharatpurwar · Pull Request #33809 · Azure/azure-cli

Bharat Purwar (bharatpurwar) · 2026-07-29T04:06:43Z

🤖 PR Validation — ⚠️ Review suggested

Breaking Changes	Tests
⚠️ None	️✔️ 130/130

⚠️AzureCLI-BreakingChangeTest

⚠️backup

rule cmd_name rule_message suggest_message

⚠️ 1006 - ParaAdd backup restore restore-azurefileshare cmd backup restore restore-azurefileshare added parameter use_secondary_region

Related commands

az backup item list --use-secondary-region
az backup item show --use-secondary-region
az backup recoverypoint list --use-secondary-region
az backup restore restore-azurefileshare --use-secondary-region
az backup job show --use-secondary-region
az backup protection undelete

Description

Adds Azure File Share cross-region restore support for full-share alternate-location restores. The implementation resolves protected items and recovery points from the secondary region, validates the target file share, builds the passive-stamp CRR request with the Azure Storage access token, triggers the restore, and tracks the resulting CRR job.

Adds Azure File Share soft-delete undelete support. Soft-deleted Azure File Share protected items remain discoverable through item listing and can be rehydrated using az backup protection undelete. The command validates the deferred-delete state and submits the protected-item rehydrate request.

Also fixes Azure Storage CRR job formatting for task models without start/end timestamps.

Testing Guide

azdev test test_afs_cross_region_restore test_afs_backup_protection_undelete --series --no-exitfirst
azdev style backup
azdev linter backup

Both scenarios use recordings for CI playback. The undelete scenario uses transient resources through preparers and has a dedicated test_afs_backup_protection_undelete.yaml recording.

History Notes

[Backup] az backup restore restore-azurefileshare: Add Azure File Share cross-region restore support.

[Backup] az backup protection undelete: Add Azure File Share soft-delete undelete support.

The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 7a8ea165-11b7-4fc8-9919-ec589073b1fe

azure-pipelines · 2026-07-29T04:06:53Z

Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run.

Aditya Pujara (a0x1ab) · 2026-07-29T04:08:54Z

/azp run

azure-pipelines · 2026-07-29T04:09:10Z

Azure Pipelines: Successfully started running 3 pipeline(s).

Copilot

Pull request overview

Adds Azure File Share cross-region restore (CRR) support to the backup command module, enabling --use-secondary-region for full-share alternate-location restores and validating target file shares before triggering the passive-stamp CRR workflow. Also adjusts CRR job/task formatting to tolerate task models missing timestamps and adds a record-only scenario test + recording.

Changes:

Enable CRR restore flow for Azure File Share restores via passive-stamp access token + CRR trigger, tracked as a CRR job.
Allow --use-secondary-region for AzureStorage recovery point listing and wire the flag through restore entrypoints/params.
Add playback-only scenario test and recording for the AFS CRR restore path; harden CRR task timestamp formatting.

Reviewed changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/azure-cli/azure/cli/command_modules/backup/custom_afs.py	Implements the AFS CRR restore path (passive stamp) and enables secondary-region recovery point listing; adds target file share validation.
src/azure-cli/azure/cli/command_modules/backup/custom_base.py	Threads `use_secondary_region` into the `restore_azurefileshare` entrypoint and item resolution.
src/azure-cli/azure/cli/command_modules/backup/custom_common.py	Allows AzureStorage to use `--use-secondary-region` by updating the “not supported” list.
src/azure-cli/azure/cli/command_modules/backup/custom_help.py	Makes CRR task timestamp normalization resilient to missing `start_time`/`end_time`.
src/azure-cli/azure/cli/command_modules/backup/_params.py	Adds `--use-secondary-region` to `backup restore restore-azurefileshare`.
src/azure-cli/azure/cli/command_modules/backup/_client_factory.py	Introduces a Storage mgmt client factory and a `file_shares_cf` accessor used for target share validation.
src/azure-cli/azure/cli/command_modules/backup/tests/latest/test_afs_commands.py	Adds a record-only scenario test covering AFS CRR restore and CRR job tracking.
src/azure-cli/azure/cli/command_modules/backup/tests/latest/recordings/test_afs_cross_region_restore.yaml	Adds the test recording for the new scenario.

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

 from azure.cli.core.util import CLIError
 from azure.cli.command_modules.backup._client_factory import protection_containers_cf, protectable_containers_cf, \
    protection_policies_cf, backup_protection_containers_cf, backup_protectable_items_cf, \
-    resources_cf, backup_protected_items_cf, protected_items_cf
-from azure.cli.core.azclierror import ArgumentUsageError, ValidationError
+    resources_cf, backup_protected_items_cf, protected_items_cf, \
+    recovery_points_crr_cf, recovery_points_passive_cf, aad_properties_cf, cross_region_restore_cf, vaults_cf, \
+    file_shares_cf
+from azure.cli.core.azclierror import ArgumentUsageError, ValidationError, InvalidArgumentValueError
+from azure.core.exceptions import ResourceNotFoundError


Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 7a8ea165-11b7-4fc8-9919-ec589073b1fe

Aditya Pujara (a0x1ab) · 2026-08-03T01:42:10Z

/azp run

azure-pipelines · 2026-08-03T01:42:26Z

Azure Pipelines: Successfully started running 3 pipeline(s).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 7a8ea165-11b7-4fc8-9919-ec589073b1fe

Aditya Pujara (a0x1ab) · 2026-08-03T05:10:49Z

/azp run

azure-pipelines · 2026-08-03T05:11:06Z

Azure Pipelines: Successfully started running 3 pipeline(s).

Bharat Purwar (bharatpurwar) · 2026-08-04T03:57:55Z

/azp run Azure.azure-cli

azure-pipelines · 2026-08-04T03:58:02Z

Commenter does not have sufficient privileges for PR 33809 in repo Azure/azure-cli

Yong Zhang (yonzhan) · 2026-08-04T03:59:21Z

/azp run

azure-pipelines · 2026-08-04T03:59:37Z

Azure Pipelines: Successfully started running 3 pipeline(s).

Bharat Purwar (bharatpurwar) · 2026-08-10T17:01:03Z

Hi Team, please review the changes

Zubair Abid (zubairabid)

Look good, minor changes unrelated to function.

Zubair Abid (zubairabid) · 2026-08-13T07:10:02Z

+    # CRR path: route through passive stamp (secondary region endpoint)
+    if use_secondary_region:
+        vault = vaults_cf(cmd.cli_ctx).get(resource_group_name, vault_name)
+        import azure.cli.command_modules.backup.custom as custom_module


nit: move imports to top of file.

Zubair Abid (zubairabid) · 2026-08-13T07:12:52Z

-    recovery_points = client.list(vault_name, resource_group_name, fabric_name, container_uri, item_uri, filter_string)
-    paged_recovery_points = helper.get_list_from_paged_response(recovery_points)
+    if use_secondary_region:
+        crr_client = recovery_points_crr_cf(cmd.cli_ctx)


nit: having both this and the previous cross_region_restore_cf instance be called crr_client can get a bit confusing, useful to disambiguate the naming a bit.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 7a8ea165-11b7-4fc8-9919-ec589073b1fe

Aditya Pujara (a0x1ab) · 2026-08-13T10:13:35Z

/azp run

azure-pipelines · 2026-08-13T10:13:53Z

Azure Pipelines: Successfully started running 3 pipeline(s).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Aditya Pujara (a0x1ab) · 2026-08-18T02:16:54Z

/azp run

azure-pipelines · 2026-08-18T02:17:10Z

Azure Pipelines: Successfully started running 3 pipeline(s).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Aditya Pujara (a0x1ab) · 2026-08-18T03:47:41Z

/azp run

azure-pipelines · 2026-08-18T03:48:00Z

Azure Pipelines: Successfully started running 3 pipeline(s).

Bharat Purwar (bharatpurwar) · 2026-08-18T08:22:58Z

Hi Team, please review the pr.
Julie Zhu (@yanzhudd)

azure-client-tools-agent · 2026-08-19T08:36:06Z

Live test results — `azdev test --live --series` (changed test files only)

❌ FAIL (exit 1)

Selectors: test_afs_commands (module)
PR head ref: bharatpurwar/afs-crr-6d028121
PR head sha: 46929978020bd21ba79cc473b85e9547a041bf7c
PR base ref: dev
New test files in PR: false

Changed test files run

src/azure-cli/azure/cli/command_modules/backup/tests/latest/test_afs_commands.py

Workflow run: https://github.com/Azure/issue-sentinel/actions/runs/32233032941

Last 80 lines of azdev output

           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.venv/lib/python3.12/site-packages/azure/core/tracing/decorator.py:119: in wrapper_use_tracer
    return func(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 

self = <azure.mgmt.resource.resources.v2024_11_01.operations._operations.ResourceGroupsOperations object at 0x7f8004f35fa0>
resource_group_name = 'AzureBackupRG_clitest_5hfhlwimo5'
parameters = <azure.mgmt.resource.resources.v2024_11_01.models._models_py3.ResourceGroup object at 0x7f8004d70860>
kwargs = {}

    @distributed_trace
    def create_or_update(
        self, resource_group_name: str, parameters: Union[_models.ResourceGroup, IO[bytes]], **kwargs: Any
    ) -> _models.ResourceGroup:
        """Creates or updates a resource group.
    
        :param resource_group_name: The name of the resource group to create or update. Can include
         alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters
         that match the allowed characters. Required.
        :type resource_group_name: str
        :param parameters: Parameters supplied to the create or update a resource group. Is either a
         ResourceGroup type or a IO[bytes] type. Required.
        :type parameters: ~azure.mgmt.resource.resources.v2024_11_01.models.ResourceGroup or IO[bytes]
        :return: ResourceGroup or the result of cls(response)
        :rtype: ~azure.mgmt.resource.resources.v2024_11_01.models.ResourceGroup
        :raises ~azure.core.exceptions.HttpResponseError:
        """
        error_map: MutableMapping = {
            401: ClientAuthenticationError,
            404: ResourceNotFoundError,
            409: ResourceExistsError,
            304: ResourceNotModifiedError,
        }
        error_map.update(kwargs.pop("error_map", {}) or {})
    
        _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
        _params = case_insensitive_dict(kwargs.pop("params", {}) or {})
    
        api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._api_version or "2024-11-01"))
        content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
        cls: ClsType[_models.ResourceGroup] = kwargs.pop("cls", None)
    
        content_type = content_type or "application/json"
        _json = None
        _content = None
        if isinstance(parameters, (IOBase, bytes)):
            _content = parameters
        else:
            _json = self._serialize.body(parameters, "ResourceGroup")
    
        _request = build_resource_groups_create_or_update_request(
            resource_group_name=resource_group_name,
            subscription_id=self._config.subscription_id,
            api_version=api_version,
            content_type=content_type,
            json=_json,
            content=_content,
            headers=_headers,
            params=_params,
        )
        _request.url = self._client.format_url(_request.url)
    
        _stream = False
        pipeline_response: PipelineResponse = self._client._pipeline.run(  # pylint: disable=protected-access
            _request, stream=_stream, **kwargs
        )
    
        response = pipeline_response.http_response
    
        if response.status_code not in [200, 201]:
            map_error(status_code=response.status_code, response=response, error_map=error_map)
>           raise HttpResponseError(response=response, error_format=ARMErrorFormat)
E           azure.core.exceptions.HttpResponseError: (LocationNotAvailableForResourceGroup) The provided location 'eastus2euap' is not available for resource group. List of available regions is 'eastasia,southeastasia,austriaeast,australiaeast,australiacentral,australiacentral2,australiasoutheast,belgiumcentral,brazilsouth,canadacentral,canadaeast,switzerlandnorth,chilecentral,denmarkeast,germanywestcentral,eastus2,eastus,centralus,northcentralus,francecentral,uksouth,ukwest,indonesiacentral,israelcentral,centralindia,southindia,jioindiawest,italynorth,japaneast,japanwest,koreacentral,koreasouth,malaysiawest,mexicocentral,northeurope,norwayeast,newzealandnorth,polandcentral,qatarcentral,spaincentral,swedencentral,uaenorth,westcentralus,westeurope,westus2,westus,southcentralus,westus3,southafricanorth,westindia,jioindiacentral,indiasouthcentral'.
E           Code: LocationNotAvailableForResourceGroup
E           Message: The provided location 'eastus2euap' is not available for resource group. List of available regions is 'eastasia,southeastasia,austriaeast,australiaeast,australiacentral,australiacentral2,australiasoutheast,belgiumcentral,brazilsouth,canadacentral,canadaeast,switzerlandnorth,chilecentral,denmarkeast,germanywestcentral,eastus2,eastus,centralus,northcentralus,francecentral,uksouth,ukwest,indonesiacentral,israelcentral,centralindia,southindia,jioindiawest,italynorth,japaneast,japanwest,koreacentral,koreasouth,malaysiawest,mexicocentral,northeurope,norwayeast,newzealandnorth,polandcentral,qatarcentral,spaincentral,swedencentral,uaenorth,westcentralus,westeurope,westus2,westus,southcentralus,westus3,southafricanorth,westindia,jioindiacentral,indiasouthcentral'.

.venv/lib/python3.12/site-packages/azure/mgmt/resource/resources/v2024_11_01/operations/_operations.py:5922: HttpResponseError
!!!!!!!!!!!!!!!!!!!!!!!!!! stopping after 1 failures !!!!!!!!!!!!!!!!!!!!!!!!!!!
============================== 1 failed in 2.38s ===============================

Posted by agent-assist live-test workflow.

azure-client-tools-agent

Live-Test & CI Review Summary — FAILING

CI checks: all 56 checks passed. ✅

Live test (azdev test --live): ❌ FAILED

Workflow run: https://github.com/Azure/issue-sentinel/actions/runs/32233032941
The azdev test --live step exited with code 1 (azdev tests failed (exit 1)) against the changed test file(s) for this PR (Backup module: Azure File Share cross-region restore / soft-delete undelete support).

Please check the linked live-test run output for the specific assertion/error, and update the tests or implementation so azdev test --live passes for the changed Backup test files.

microsoft-github-policy-service · 2026-08-19T12:45:36Z

🔔 Routing this PR to @Azure/act-observability-squad.

[Backup] Add Azure File Share cross-region restore support

1684d25

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 7a8ea165-11b7-4fc8-9919-ec589073b1fe

Bharat Purwar (bharatpurwar) requested a review from a team as a code owner July 29, 2026 04:06

Copilot AI review requested due to automatic review settings July 29, 2026 04:06

azure-client-tools-bot-prd Bot added this to the September 2026 (2026-09-01) milestone Jul 29, 2026

microsoft-github-policy-service Bot requested a review from Yong Zhang (yonzhan) July 29, 2026 04:07

Copilot started reviewing on behalf of Bharat Purwar (bharatpurwar) July 29, 2026 04:07 View session

microsoft-github-policy-service Bot requested review from Yu Chen (jsntcy) and ZelinWang (wangzelin007) July 29, 2026 04:07

microsoft-github-policy-service Bot added Auto-Assign Auto assign by bot Backup act-observability-squad labels Jul 29, 2026

Bharat Purwar (bharatpurwar) added the do-not-merge label Jul 29, 2026

Copilot AI reviewed Jul 29, 2026

View reviewed changes

Add Azure Files soft-delete undelete support

b8ae054

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 7a8ea165-11b7-4fc8-9919-ec589073b1fe

Bharat Purwar (bharatpurwar) changed the title ~~[Backup] Add Azure File Share cross-region restore support~~ [Backup] Add Azure File Share cross-region restore and soft-delete undelete support Aug 3, 2026

Fix AFS CRR test recording API version

2dfba17

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 7a8ea165-11b7-4fc8-9919-ec589073b1fe

Yong Zhang (yonzhan) assigned Julie Zhu (yanzhudd) Aug 4, 2026

Yong Zhang (yonzhan) requested a review from Julie Zhu (yanzhudd) August 4, 2026 03:59

Bharat Purwar (bharatpurwar) added the needs-review label Aug 10, 2026

Zubair Abid (zubairabid) approved these changes Aug 13, 2026

View reviewed changes

Address AFS CRR review comments

58e9946

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 7a8ea165-11b7-4fc8-9919-ec589073b1fe

Bharat Purwar (bharatpurwar) added do-not-merge and removed do-not-merge labels Aug 17, 2026

Fix AFS resume and sanitize CRR recording

f186e16

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Fix AFS CRR playback API version

4692997

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Bharat Purwar (bharatpurwar) removed the do-not-merge label Aug 18, 2026

Aditya Pujara (a0x1ab) added the Azure Client Tools Agent Requested Request Azure Client Tools Agent testing and review label Aug 19, 2026

Zubair Abid (zubairabid) approved these changes Aug 19, 2026

View reviewed changes

azure-client-tools-agent Bot reviewed Aug 19, 2026

View reviewed changes

azure-client-tools-agent Bot added azure-client-tools-agent Pull request reviewed by Azure Client Tools Agent and removed Azure Client Tools Agent Requested Request Azure Client Tools Agent testing and review labels Aug 19, 2026

Uh oh!

Conversation

Bharat Purwar (bharatpurwar) commented Jul 29, 2026 • edited by azure-client-tools-agent Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🤖 PR Validation — ⚠️ Review suggested

Uh oh!

azure-pipelines Bot commented Jul 29, 2026

Uh oh!

Aditya Pujara (a0x1ab) commented Jul 29, 2026

Uh oh!

azure-pipelines Bot commented Jul 29, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Aditya Pujara (a0x1ab) commented Aug 3, 2026

Uh oh!

azure-pipelines Bot commented Aug 3, 2026

Uh oh!

Aditya Pujara (a0x1ab) commented Aug 3, 2026

Uh oh!

azure-pipelines Bot commented Aug 3, 2026

Uh oh!

Bharat Purwar (bharatpurwar) commented Aug 4, 2026

Uh oh!

azure-pipelines Bot commented Aug 4, 2026

Uh oh!

Yong Zhang (yonzhan) commented Aug 4, 2026

Uh oh!

azure-pipelines Bot commented Aug 4, 2026

Uh oh!

Bharat Purwar (bharatpurwar) commented Aug 10, 2026

Uh oh!

Zubair Abid (zubairabid) left a comment

Choose a reason for hiding this comment

Uh oh!

Zubair Abid (zubairabid) Aug 13, 2026

Choose a reason for hiding this comment

Uh oh!

Bharat Purwar (bharatpurwar) Aug 13, 2026

Choose a reason for hiding this comment

Uh oh!

Zubair Abid (zubairabid) Aug 13, 2026

Choose a reason for hiding this comment

Uh oh!

Bharat Purwar (bharatpurwar) Aug 13, 2026

Choose a reason for hiding this comment

Uh oh!

Aditya Pujara (a0x1ab) commented Aug 13, 2026

Uh oh!

azure-pipelines Bot commented Aug 13, 2026

Uh oh!

Aditya Pujara (a0x1ab) commented Aug 18, 2026

Uh oh!

azure-pipelines Bot commented Aug 18, 2026

Uh oh!

Aditya Pujara (a0x1ab) commented Aug 18, 2026

Uh oh!

azure-pipelines Bot commented Aug 18, 2026

Uh oh!

Bharat Purwar (bharatpurwar) commented Aug 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

azure-client-tools-agent Bot commented Aug 19, 2026

Live test results — azdev test --live --series (changed test files only)

Uh oh!

azure-client-tools-agent Bot left a comment

Choose a reason for hiding this comment

Live-Test & CI Review Summary — FAILING

Uh oh!

microsoft-github-policy-service Bot commented Aug 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Bharat Purwar (bharatpurwar) commented Jul 29, 2026 •

edited by azure-client-tools-agent Bot

Loading

Bharat Purwar (bharatpurwar) commented Aug 18, 2026 •

edited

Loading

Live test results — `azdev test --live --series` (changed test files only)