[backup] AFS soft delete: implement undelete for Azure File Share + --is-deleted filter on backup item list

[bharatpurwar]

Related command

az backup protection undelete, az backup item list

Description

Adds end-user soft-delete support for Azure File Share (AFS) backup items in az backup, bringing the CLI surface for AFS in line with what IaaS VM already exposes.

Command	Before	After
az backup protection undelete --backup-management-type AzureStorage --workload-type AzureFileShare ...	Returned None silently — only the AzureIaasVM and AzureWorkload branches were wired in custom_base.undelete_protection	Dispatches to a new custom_afs.undelete_protection which issues PUT with is_rehydrate=True, protection_state=ProtectionStopped, policy_id="", source_resource_id from the item
az backup item list	No filter for soft-deleted items	Adds --is-deleted switch (client-side filter on properties.is_scheduled_for_deferred_delete) — works for every backup-management-type that supports soft delete

The protected-items LIST endpoint does not expose isDeleted as an OData predicate, so the filter is applied client-side after pagination. This matches the equivalent PowerShell -DeleteState SoftDeleted behavior shipping in parallel at Azure/azure-powershell#29622.

Files

• azure/cli/command_modules/backup/custom_afs.py — new undelete_protection
• azure/cli/command_modules/backup/custom_base.py — AzureStorage branch in undelete_protection; thread is_deleted through list_items
• azure/cli/command_modules/backup/custom_common.py — is_deleted client-side filter in list_items
• azure/cli/command_modules/backup/_params.py — register --is-deleted on backup item list
• azure/cli/command_modules/backup/_help.py — examples for backup protection undelete (AFS) and backup item list --is-deleted
• azure/cli/command_modules/backup/tests/latest/test_afs_commands.py — test_afs_backup_softdelete
• src/azure-cli/HISTORY.rst

Testing

• python -c "import ast; ast.parse(open(p).read())" clean for every modified .py.
• New scenario test test_afs_backup_softdelete mirrors test_backup_softdelete (in test_backup_commands.py) for IaaS VM. Covers the full lifecycle: disable with --delete-backup-data → assert isScheduledForDeferredDelete=True via both backup item show and the new --is-deleted filter → undelete → assert isScheduledForDeferredDelete=None. Marked @live_only because the service state transitions can't be recorded.

HISTORY.rst entry

**Backup**

* `az backup protection undelete`: Add support for rehydrating soft-deleted Azure File Share backup items
* `az backup item list`: Add `--is-deleted` flag to return only soft-deleted backup items in the vault

Backward compatibility

• --is-deleted is a new optional flag; default behavior of az backup item list is unchanged.
• az backup protection undelete for --backup-management-type AzureStorage previously silently returned None; it now succeeds. No existing caller was relying on the no-op.

[azure-client-tools-bot-prd]

Validation for Azure CLI Full Test Starting...

Thanks for your contribution!

[azure-client-tools-bot-prd]

Hi @bharatpurwar,
Since the current milestone time is less than 7 days, this pr will be reviewed in the next milestone.

[azure-client-tools-bot-prd]

Validation for Breaking Change Starting...

Thanks for your contribution!

[yonzhan]

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

[github-actions]

The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR.

Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions).
After that please run the following commands to enable git hooks:

pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>

[Copilot]

Pull request overview

Adds Azure File Share (AFS) soft-delete rehydration support to az backup protection undelete and introduces an --is-deleted switch on az backup item list to surface only soft-deleted items (client-side filtered via properties.isScheduledForDeferredDelete).

Changes:

• Add AzureStorage dispatch for backup protection undelete, implemented via new custom_afs.undelete_protection using is_rehydrate=True.
• Add --is-deleted to backup item list, threading the flag through custom_base into custom_common.list_items for client-side filtering.
• Add a new live-only scenario test covering the AFS soft-delete lifecycle and update help/HISTORY entries.

Reviewed changes

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

Show a summary per file

File	Description
src/azure-cli/HISTORY.rst	Documents the new undelete support for AFS and the new --is-deleted flag.
src/azure-cli/azure/cli/command_modules/backup/tests/latest/test_afs_commands.py	Adds a live-only scenario test validating AFS soft-delete → list filter → undelete behavior.
src/azure-cli/azure/cli/command_modules/backup/custom_common.py	Implements the --is-deleted client-side filter in list_items.
src/azure-cli/azure/cli/command_modules/backup/custom_base.py	Threads is_deleted through list_items and dispatches undelete for AzureStorage to custom_afs.
src/azure-cli/azure/cli/command_modules/backup/custom_afs.py	Adds undelete_protection implementation for AFS rehydration (is_rehydrate=True).
src/azure-cli/azure/cli/command_modules/backup/_params.py	Registers the --is-deleted argument for backup item list.
src/azure-cli/azure/cli/command_modules/backup/_help.py	Adds examples for backup item list --is-deleted and AFS backup protection undelete.

---

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

[microsoft-github-policy-service]

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

6. 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.
7. 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.
8. 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.
9. 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.
10. 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.