[CosmosDB] Onboarding of backup and recovery experience by Shashank1306s · Pull Request #9745 · Azure/azure-cli-extensions

Shashank1306s · 2026-03-31T05:26:45Z

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

Related command

Added dataprotection support for AzureCosmosDB workload: new manifest (Microsoft.DocumentDB/databaseAccounts), registration in supported datasource types, datasource map, and permission help text.
Added end-to-end backup/restore scenario test, unit tests for default policy template, backup-instance initialize, and restore initialize, and an update-msi-permissions live test that grants Reader/Cosmos DB Operator on the data source RG / account.

General Guidelines

Have you run azdev style <YOUR_EXT> locally? (pip install azdev required)
Have you run python scripts/ci/test_index.py -q locally? (pip install wheel==0.30.0 required)
My extension version conforms to the Extension version schema

For new extensions:

My extension description/summary conforms to the Extension Summary Guidelines.

About Extension Publish

There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update src/index.json automatically.
You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify src/index.json.

- Add AzureCosmosDB manifest (Microsoft.DocumentDB/databaseAccounts) - Register AzureCosmosDB in supported_datasource_types config - Add CosmosDB to datasource_map in helpers - Add unit tests for policy template, backup-instance initialize, restore initialize - Add e2e test with recording for backup and restore scenario

azure-client-tools-bot-prd · 2026-03-31T05:26:49Z

⚠️Azure CLI Extensions Breaking Change Test

⚠️dataprotection

rule cmd_name rule_message suggest_message

⚠️ 1010 - ParaPropUpdate dataprotection backup-instance initialize cmd dataprotection backup-instance initialize update parameter datasource_type: updated property choices from ['AzureBlob', 'AzureDataLakeStorage', 'AzureDatabaseForMySQL', 'AzureDatabaseForPostgreSQL', 'AzureDatabaseForPostgreSQLFlexibleServer', 'AzureDisk', 'AzureKubernetesService'] to ['AzureBlob', 'AzureCosmosDB', 'AzureDataLakeStorage', 'AzureDatabaseForMySQL', 'AzureDatabaseForPostgreSQL', 'AzureDatabaseForPostgreSQLFlexibleServer', 'AzureDisk', 'AzureKubernetesService']

⚠️ 1010 - ParaPropUpdate dataprotection backup-instance initialize-backupconfig cmd dataprotection backup-instance initialize-backupconfig update parameter datasource_type: updated property choices from ['AzureBlob', 'AzureDataLakeStorage', 'AzureDatabaseForMySQL', 'AzureDatabaseForPostgreSQL', 'AzureDatabaseForPostgreSQLFlexibleServer', 'AzureDisk', 'AzureKubernetesService'] to ['AzureBlob', 'AzureCosmosDB', 'AzureDataLakeStorage', 'AzureDatabaseForMySQL', 'AzureDatabaseForPostgreSQL', 'AzureDatabaseForPostgreSQLFlexibleServer', 'AzureDisk', 'AzureKubernetesService']

⚠️ 1010 - ParaPropUpdate dataprotection backup-instance initialize-restoreconfig cmd dataprotection backup-instance initialize-restoreconfig update parameter datasource_type: updated property choices from ['AzureBlob', 'AzureDataLakeStorage', 'AzureDatabaseForMySQL', 'AzureDatabaseForPostgreSQL', 'AzureDatabaseForPostgreSQLFlexibleServer', 'AzureDisk', 'AzureKubernetesService'] to ['AzureBlob', 'AzureCosmosDB', 'AzureDataLakeStorage', 'AzureDatabaseForMySQL', 'AzureDatabaseForPostgreSQL', 'AzureDatabaseForPostgreSQLFlexibleServer', 'AzureDisk', 'AzureKubernetesService']

⚠️ 1010 - ParaPropUpdate dataprotection backup-instance list-from-resourcegraph cmd dataprotection backup-instance list-from-resourcegraph update parameter datasource_type: updated property choices from ['AzureBlob', 'AzureDataLakeStorage', 'AzureDatabaseForMySQL', 'AzureDatabaseForPostgreSQL', 'AzureDatabaseForPostgreSQLFlexibleServer', 'AzureDisk', 'AzureKubernetesService'] to ['AzureBlob', 'AzureCosmosDB', 'AzureDataLakeStorage', 'AzureDatabaseForMySQL', 'AzureDatabaseForPostgreSQL', 'AzureDatabaseForPostgreSQLFlexibleServer', 'AzureDisk', 'AzureKubernetesService']

⚠️ 1010 - ParaPropUpdate dataprotection backup-instance restore initialize-for-data-recovery cmd dataprotection backup-instance restore initialize-for-data-recovery update parameter datasource_type: updated property choices from ['AzureBlob', 'AzureDataLakeStorage', 'AzureDatabaseForMySQL', 'AzureDatabaseForPostgreSQL', 'AzureDatabaseForPostgreSQLFlexibleServer', 'AzureDisk', 'AzureKubernetesService'] to ['AzureBlob', 'AzureCosmosDB', 'AzureDataLakeStorage', 'AzureDatabaseForMySQL', 'AzureDatabaseForPostgreSQL', 'AzureDatabaseForPostgreSQLFlexibleServer', 'AzureDisk', 'AzureKubernetesService']

⚠️ 1010 - ParaPropUpdate dataprotection backup-instance restore initialize-for-data-recovery-as-files cmd dataprotection backup-instance restore initialize-for-data-recovery-as-files update parameter datasource_type: updated property choices from ['AzureBlob', 'AzureDataLakeStorage', 'AzureDatabaseForMySQL', 'AzureDatabaseForPostgreSQL', 'AzureDatabaseForPostgreSQLFlexibleServer', 'AzureDisk', 'AzureKubernetesService'] to ['AzureBlob', 'AzureCosmosDB', 'AzureDataLakeStorage', 'AzureDatabaseForMySQL', 'AzureDatabaseForPostgreSQL', 'AzureDatabaseForPostgreSQLFlexibleServer', 'AzureDisk', 'AzureKubernetesService']

⚠️ 1010 - ParaPropUpdate dataprotection backup-instance restore initialize-for-item-recovery cmd dataprotection backup-instance restore initialize-for-item-recovery update parameter datasource_type: updated property choices from ['AzureBlob', 'AzureDataLakeStorage', 'AzureDatabaseForMySQL', 'AzureDatabaseForPostgreSQL', 'AzureDatabaseForPostgreSQLFlexibleServer', 'AzureDisk', 'AzureKubernetesService'] to ['AzureBlob', 'AzureCosmosDB', 'AzureDataLakeStorage', 'AzureDatabaseForMySQL', 'AzureDatabaseForPostgreSQL', 'AzureDatabaseForPostgreSQLFlexibleServer', 'AzureDisk', 'AzureKubernetesService']

⚠️ 1010 - ParaPropUpdate dataprotection backup-instance update-msi-permissions cmd dataprotection backup-instance update-msi-permissions update parameter datasource_type: updated property choices from ['AzureBlob', 'AzureDataLakeStorage', 'AzureDatabaseForMySQL', 'AzureDatabaseForPostgreSQL', 'AzureDatabaseForPostgreSQLFlexibleServer', 'AzureDisk', 'AzureKubernetesService'] to ['AzureBlob', 'AzureCosmosDB', 'AzureDataLakeStorage', 'AzureDatabaseForMySQL', 'AzureDatabaseForPostgreSQL', 'AzureDatabaseForPostgreSQLFlexibleServer', 'AzureDisk', 'AzureKubernetesService']

⚠️ 1010 - ParaPropUpdate dataprotection backup-policy get-default-policy-template cmd dataprotection backup-policy get-default-policy-template update parameter datasource_type: updated property choices from ['AzureBlob', 'AzureDataLakeStorage', 'AzureDatabaseForMySQL', 'AzureDatabaseForPostgreSQL', 'AzureDatabaseForPostgreSQLFlexibleServer', 'AzureDisk', 'AzureKubernetesService'] to ['AzureBlob', 'AzureCosmosDB', 'AzureDataLakeStorage', 'AzureDatabaseForMySQL', 'AzureDatabaseForPostgreSQL', 'AzureDatabaseForPostgreSQLFlexibleServer', 'AzureDisk', 'AzureKubernetesService']

⚠️ 1010 - ParaPropUpdate dataprotection job list-from-resourcegraph cmd dataprotection job list-from-resourcegraph update parameter datasource_type: updated property choices from ['AzureBlob', 'AzureDataLakeStorage', 'AzureDatabaseForMySQL', 'AzureDatabaseForPostgreSQL', 'AzureDatabaseForPostgreSQLFlexibleServer', 'AzureDisk', 'AzureKubernetesService'] to ['AzureBlob', 'AzureCosmosDB', 'AzureDataLakeStorage', 'AzureDatabaseForMySQL', 'AzureDatabaseForPostgreSQL', 'AzureDatabaseForPostgreSQLFlexibleServer', 'AzureDisk', 'AzureKubernetesService']

azure-client-tools-bot-prd · 2026-03-31T05:26:51Z

Hi @Shashank1306s,
Please write the description of changes which can be perceived by customers into HISTORY.rst.
If you want to release a new extension version, please update the version in setup.py as well.

yonzhan · 2026-03-31T05:27:07Z

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

github-actions · 2026-03-31T05:27:08Z

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>

github-actions · 2026-03-31T05:28:11Z

CodeGen Tools Feedback Collection

Thank you for using our CodeGen tool. We value your feedback, and we would like to know how we can improve our product. Please take a few minutes to fill our codegen survey

github-actions · 2026-03-31T05:30:39Z

For more info about extension versioning, please refer to Extension version schema

github-actions · 2026-03-31T05:30:39Z

Hi @Shashank1306s

Release Suggestions

Module: dataprotection

Please log updates into to src/dataprotection/HISTORY.rst
Update VERSION to 1.9.0 in src/dataprotection/setup.py

Notes

For more info about extension versioning, please refer to Extension version schema

zubairabid

Please add the test file itself, and confirm that the update-msi-permissions command is not broken for the new workload.

zubairabid · 2026-05-13T05:55:17Z

I can see the test recording, but not the test file itself - did we not commit that?

Added. please review

zubairabid · 2026-05-13T05:57:01Z

+  "addDataStoreParametersList": false,
+  "friendlyNameRequired": false,
+  "supportSecretStoreAuthentication": false,
+  "backupVaultPermissions": [


Query: have we tested if the update-msi-permissions command works as expected with this set of permissions?

[update-msi-permissions] worked end-to-end and the permissions it set were exactly sufficient to complete configure-protection, adhoc-backup, and AlternateLocation restore

…ns test - Add unit test file test_dataprotection_cosmosdb.py (was missing from earlier commit) - Add live e2e Cosmos scenario test in test_dataprotection_backup_and_restore_workloads.py - Add live test_dataprotection_update_msi_permissions_cosmosdb covering manifest backupVaultPermissions (Reader on DataSourceRG, Cosmos DB Operator on DataSource) using persistent cosmos-bugbash-CLIrg-6 accounts - Update helpers.get_help_word_from_permission_type for AzureCosmosDB datasource label - Bump dataprotection extension to 1.9.0 and update HISTORY.rst

…ensions into feature/cosmoscli

Copilot

Pull request overview

This PR onboards Azure Cosmos DB (account-level Microsoft.DocumentDB/databaseAccounts) as a supported workload in the dataprotection Azure CLI extension, including manifest registration, helper mappings, and scenario/unit test coverage for the backup/restore experience.

Changes:

Bumped the dataprotection extension version to 1.11.0 and added release notes.
Added an AzureCosmosDB manifest and wired it into supported datasource types + datasource mapping + permission help text.
Added Cosmos DB-focused tests (unit-style CLI payload validation + live scenario + live MSI permission update) and a new recording.

Reviewed changes

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

Show a summary per file

File	Description
src/dataprotection/setup.py	Bumps extension version to `1.11.0`.
src/dataprotection/HISTORY.rst	Adds `1.11.0` changelog entry for Cosmos DB onboarding and tests.
src/dataprotection/azext_dataprotection/manual/Manifests/config.py	Registers `AzureCosmosDB` as a supported datasource type.
src/dataprotection/azext_dataprotection/manual/Manifests/AzureCosmosDB.py	Adds the Cosmos DB workload manifest (policy + permissions + restore constraints).
src/dataprotection/azext_dataprotection/manual/helpers.py	Adds Cosmos DB datasource mapping/help text; adds snake→camel override for `resource_id`→`resourceID`.
src/dataprotection/azext_dataprotection/tests/latest/test_dataprotection_update_msi_permissions.py	Adds a live-only Cosmos DB `update-msi-permissions` scenario.
src/dataprotection/azext_dataprotection/tests/latest/test_dataprotection_cosmosdb.py	Adds unit-style CLI tests for default policy template, backup-instance initialize, and restore initialize outputs.
src/dataprotection/azext_dataprotection/tests/latest/test_dataprotection_backup_and_restore_workloads.py	Adds a live-only end-to-end Cosmos DB backup + alternate-location restore scenario with explicit protection-status polling.
src/dataprotection/azext_dataprotection/tests/latest/recordings/test_dataprotection_backup_and_restore_cosmosdb.yaml	Adds a recording for the Cosmos DB scenario.

+from azure.cli.testsdk import ScenarioTest
+from azure.cli.testsdk.scenario_tests import AllowLargeResponse
+


Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

calvinhzy · 2026-05-20T03:07:58Z

/azp run

azure-pipelines · 2026-05-20T03:08:11Z

Azure Pipelines successfully started running 2 pipeline(s).

calvinhzy · 2026-05-20T03:45:00Z

/azp run

azure-pipelines · 2026-05-20T03:45:11Z

Azure Pipelines successfully started running 2 pipeline(s).

…azure-cli-extensions into feature/cosmoscli

Shashank1306s · 2026-05-20T06:07:28Z

/azp run

azure-pipelines · 2026-05-20T06:07:36Z

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

calvinhzy · 2026-05-20T07:15:15Z

/azp run

azure-pipelines · 2026-05-20T07:15:30Z

Azure Pipelines successfully started running 2 pipeline(s).

azclibot · 2026-05-20T09:04:06Z

[Release] Update index.json for extension [ dataprotection-1.11.0 ] : https://dev.azure.com/msazure/One/_build/results?buildId=164892035&view=results

SHASHANK SINGH and others added 3 commits February 26, 2026 10:12

nit

97158c4

fix

49f9bc2

azure-client-tools-bot-prd Bot added this to the May 2026 (2026-05-05) milestone Mar 31, 2026

microsoft-github-policy-service Bot requested review from calvinhzy, evelyn-ys and yonzhan March 31, 2026 05:27

microsoft-github-policy-service Bot added CosmosDB Auto-Assign Auto assign by bot labels Mar 31, 2026

microsoft-github-policy-service Bot assigned evelyn-ys Mar 31, 2026

yonzhan assigned calvinhzy and unassigned evelyn-ys Mar 31, 2026

jsntcy requested a review from coopercox-ms April 7, 2026 04:33

zubairabid suggested changes May 13, 2026

View reviewed changes

github-actions Bot added the release-version-block Updates do not qualify release version rules. NOTE: please do not edit it manually. label May 19, 2026

Auto-Upgrade Orchestrator added 2 commits May 19, 2026 13:57

Merge branch 'main' of https://github.com/Shashank1306s/azure-cli-ext…

5663350

…ensions into feature/cosmoscli

Update release version

b4f29af

github-actions Bot removed the release-version-block Updates do not qualify release version rules. NOTE: please do not edit it manually. label May 19, 2026

Shashank1306s marked this pull request as ready for review May 19, 2026 08:34

Copilot AI review requested due to automatic review settings May 19, 2026 08:34

Copilot started reviewing on behalf of Shashank1306s May 19, 2026 08:38 View session

zubairabid approved these changes May 19, 2026

View reviewed changes

Copilot AI reviewed May 19, 2026

View reviewed changes

Comment thread src/dataprotection/HISTORY.rst Outdated

Comment thread src/dataprotection/azext_dataprotection/tests/latest/test_dataprotection_cosmosdb.py

Comment on lines +21 to +23

from azure.cli.testsdk import ScenarioTest

from azure.cli.testsdk.scenario_tests import AllowLargeResponse

Potential fix for pull request finding

bef1eb9

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

calvinhzy approved these changes May 20, 2026

View reviewed changes

calvinhzy changed the title ~~Onboarding of backup and recovery experience for CosmosDB~~ [CosmosDB] Onboarding of backup and recovery experience May 20, 2026

Auto-Upgrade Orchestrator added 2 commits May 20, 2026 09:51

Merge remote-tracking branch 'upstream/main' into feature/cosmoscli

a587c3c

Merge branch 'feature/cosmoscli' of https://github.com/Shashank1306s/…

edaa029

…azure-cli-extensions into feature/cosmoscli

Shashank1306s requested a review from calvinhzy May 20, 2026 05:07

calvinhzy merged commit 195025e into Azure:main May 20, 2026
24 checks passed

Shashank1306s mentioned this pull request May 20, 2026

[Dataprotection] az dataprotection backup-instance update-msi-permissions: Fix --operation Restore for --datasource-type AzureCosmosDB #9890

Merged

		from azure.cli.testsdk import ScenarioTest
		from azure.cli.testsdk.scenario_tests import AllowLargeResponse

Conversation

Shashank1306s commented Mar 31, 2026 • edited by calvinhzy Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related command

General Guidelines

About Extension Publish

Uh oh!

azure-client-tools-bot-prd Bot commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

azure-client-tools-bot-prd Bot commented Mar 31, 2026

Uh oh!

yonzhan commented Mar 31, 2026

Uh oh!

github-actions Bot commented Mar 31, 2026

Uh oh!

github-actions Bot commented Mar 31, 2026

CodeGen Tools Feedback Collection

Uh oh!

github-actions Bot commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Mar 31, 2026

Release Suggestions

Module: dataprotection

Notes

Uh oh!

zubairabid left a comment

Choose a reason for hiding this comment

Uh oh!

zubairabid May 13, 2026

Choose a reason for hiding this comment

Uh oh!

Shashank1306s May 19, 2026

Choose a reason for hiding this comment

Uh oh!

zubairabid May 13, 2026

Choose a reason for hiding this comment

Uh oh!

Shashank1306s May 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

calvinhzy commented May 20, 2026

Uh oh!

azure-pipelines Bot commented May 20, 2026

Uh oh!

calvinhzy commented May 20, 2026

Uh oh!

azure-pipelines Bot commented May 20, 2026

Uh oh!

Shashank1306s commented May 20, 2026

Uh oh!

azure-pipelines Bot commented May 20, 2026

Uh oh!

calvinhzy commented May 20, 2026

Uh oh!

azure-pipelines Bot commented May 20, 2026

Uh oh!

Uh oh!

azclibot commented May 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Shashank1306s commented Mar 31, 2026 •

edited by calvinhzy

Loading

azure-client-tools-bot-prd Bot commented Mar 31, 2026 •

edited

Loading

github-actions Bot commented Mar 31, 2026 •

edited

Loading