Skip to content

[ElasticSan] Support for 2026-05-01-preview service version - #10462

Merged
Ethan Yang (necusjz) merged 20 commits into
Azure:mainfrom
amnguye:feature/elastic-san/2026-05-01-preview
Nov 12, 2026
Merged

Ethan Yang (necusjz) merged 20 commits into
Azure:mainfrom
amnguye:feature/elastic-san/2026-05-01-preview

Conversation

@amnguye

@amnguye Amanda Nguyen (amnguye) commented Oct 13, 2026 •

Copy link
Copy Markdown
Member

🤖 PR Validation — ⚠️ Review suggested

Breaking Changes Suppressions
⚠️ None ⚠️ 1 added
⚠️Azure CLI Extensions Breaking Change Test
⚠️elastic-san
rule cmd_name rule_message suggest_message
⚠️ 1006 - ParaAdd elastic-san create cmd elastic-san create added parameter total_iops
⚠️ 1006 - ParaAdd elastic-san create cmd elastic-san create added parameter total_mbps
⚠️ 1006 - ParaAdd elastic-san create cmd elastic-san create added parameter total_size_tib
⚠️ 1006 - ParaAdd elastic-san create cmd elastic-san create added parameter version
⚠️ 1006 - ParaAdd elastic-san update cmd elastic-san update added parameter total_iops
⚠️ 1006 - ParaAdd elastic-san update cmd elastic-san update added parameter total_mbps
⚠️ 1006 - ParaAdd elastic-san update cmd elastic-san update added parameter total_size_tib
⚠️ 1006 - ParaAdd elastic-san volume create cmd elastic-san volume create added parameter managed_by
⚠️ 1006 - ParaAdd elastic-san volume delete cmd elastic-san volume delete added parameter delete_type
⚠️ 1006 - ParaAdd elastic-san volume list cmd elastic-san volume list added parameter x_ms_access_soft_deleted_resources
⚠️ 1006 - ParaAdd elastic-san volume update cmd elastic-san volume update added parameter managed_by
⚠️ 1006 - ParaAdd elastic-san volume-group create cmd elastic-san volume-group create added parameter delete_retention_policy
⚠️ 1006 - ParaAdd elastic-san volume-group create cmd elastic-san volume-group create added parameter encryption_in_transit
⚠️ 1006 - ParaAdd elastic-san volume-group create cmd elastic-san volume-group create added parameter quality_of_service
⚠️ 1006 - ParaAdd elastic-san volume-group create cmd elastic-san volume-group create added parameter reserved_iops
⚠️ 1006 - ParaAdd elastic-san volume-group create cmd elastic-san volume-group create added parameter reserved_mbps
⚠️ 1010 - ParaPropUpdate elastic-san volume-group create cmd elastic-san volume-group create update parameter protocol_type: updated property choices from ['Iscsi', 'None'] to ['DirectAttach', 'Iscsi', 'None']
⚠️ 1006 - ParaAdd elastic-san volume-group list cmd elastic-san volume-group list added parameter x_ms_access_soft_deleted_resources
⚠️ 1006 - ParaAdd elastic-san volume-group update cmd elastic-san volume-group update added parameter delete_retention_policy
⚠️ 1006 - ParaAdd elastic-san volume-group update cmd elastic-san volume-group update added parameter mi_system_assigned
⚠️ 1006 - ParaAdd elastic-san volume-group update cmd elastic-san volume-group update added parameter reserved_iops
⚠️ 1006 - ParaAdd elastic-san volume-group update cmd elastic-san volume-group update added parameter reserved_mbps
⚠️ 1006 - ParaAdd elastic-san volume-group update cmd elastic-san volume-group update added parameter user_assigned_identity
⚠️ 1010 - ParaPropUpdate elastic-san volume-group update cmd elastic-san volume-group update update parameter protocol_type: updated property choices from ['Iscsi', 'None'] to ['DirectAttach', 'Iscsi', 'None']

This PR adds warning or check suppressions. Fix the underlying warning where possible and justify each remaining suppression in a code comment or the PR description.

1 added suppression
File Line Kind Code
src/elastic-san/azext_elastic_san/custom.py 38 pylint class _InstanceUpdateByGeneric(AAZGenericInstanceUpdateOperation): # pylint: disable=too-few-public-methods

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

Related command

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 azdev required)
  • My extension version conforms to the Extension version schema

For new extensions:

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.

Summary of Changes

Related PR links:
Merged REST Spec PR: Azure/azure-rest-api-specs#41534
AAZ PR: Azure/aaz#1119

  • Update Elastic SAN commands to use the 2026-05-01-preview API and add V2 capacity and performance support.
  • Add V2 autoscale defaults: enable autoscale, default the increase and unused-size threshold to 1 TiB, and derive the scale-up ceiling from the SAN size and regional SKU capability. The service team confirmed that CLI should follow these defaults when these parameters are not specified.
  • Add volume-group QoS and reservation options, encryption in transit at creation, and support for the DirectAttach protocol.
  • Preserve generic update options and legacy identity behavior. Use GET-modify-PATCH for supported updates and GET-modify-PUT for SAN SKU and availability-zone edits.
  • Add managed-by compatibility handling and permanent volume-delete support.
  • Set the preview extension version to 2.0.0b1.

Breaking Change

Volume output managedBy changes from an object containing resourceId to an array of objects containing resourceIds. Existing queries using managedBy.resourceId must be updated.

The new managedByResourceId compatibility alias returns the first resource ID; it cannot represent additional IDs or preserve the old query path.

Test evidence (as of 11/10)

  • azdev style azext_elastic_san — passed: pylint and flake8.
  • azdev test azext_elastic_san --live --series -a -k test_elastic_san_v2_scenarios — passed. Covers V2 SAN operations and PerformanceCritical volume-group reservations.
  • azdev test azext_elastic_san --series -a -k test_elastic_san_v2_scenarios — passed in playback.
  • azdev test azext_elastic_san --live --series -a -k test_elastic_san_v2_autoscale_defaults — passed. Covers V2 creation with autoscale options omitted.
  • azdev test azext_elastic_san --series -a -k test_elastic_san_v2_autoscale_defaults — passed in playback.
  • Focused compatibility unit tests — 55 passed, 255 subtests passed; four profile-dependent tests were deselected because the sandbox blocked access to the Azure profile.

Copilot AI balanced review requested due to automatic review settings October 13, 2026 04:11
@azure-pipelines

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

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.

🟡 Changes recommended

Legacy identity removal is broken, additional breaking changes are undocumented, and major new command paths lack coverage.

7 open findings
What changed in this PR

Updates Elastic SAN commands to the 2026-05-01-preview API and adds V2 capacity, performance, soft-delete, identity, and snapshot capabilities.

Changes:

  • Adds Elastic SAN V2 capacity and performance settings.
  • Expands volume and volume-group lifecycle controls.
  • Adds snapshot update support and updates extension metadata.
File Description
src/​elastic-san/​setup.py Bumps extension version.
src/​elastic-san/​HISTORY.rst Documents release features and breaking changes.
src/​elastic-san/​azext_elastic_san/​custom.py Adapts legacy volume-group identity arguments.
.../​volume/​snapshot/​_wait.py Updates snapshot wait schema and API.
.../​volume/​snapshot/​_update.py Adds snapshot update command.
.../​volume/​snapshot/​_show.py Updates snapshot retrieval schema.
.../​volume/​snapshot/​_list.py Updates snapshot listing schema.
.../​volume/​snapshot/​_delete.py Migrates snapshot deletion API.
.../​volume/​snapshot/​_create.py Migrates snapshot creation API.
.../​volume/​snapshot/​__init__.py Exports snapshot update.
.../​volume/​_wait.py Updates volume wait response schema.
.../​volume/​_update.py Adds managed-by updates.
.../​volume/​_show.py Supports managed-by lists.
.../​volume/​_list.py Adds soft-deleted volume access.
.../​volume/​_delete.py Adds permanent deletion.
.../​volume/​_create.py Adds managed-by creation.
.../​volume_group/​_wait.py Adds new volume-group response fields.
.../​volume_group/​_update.py Switches updates to PATCH and adds settings.
.../​volume_group/​_test_restore.py Migrates restore validation API.
.../​volume_group/​_test_backup.py Migrates backup validation API.
.../​volume_group/​_show.py Exposes retention and QoS fields.
.../​volume_group/​_list.py Adds soft-delete and new fields.
.../​volume_group/​_delete.py Migrates volume-group deletion API.
.../​volume_group/​_create.py Adds retention, encryption, and QoS settings.
.../​elastic_san/​_wait.py Adds V2 response fields.
.../​elastic_san/​_update.py Uses PATCH and adds V2 updates.
.../​elastic_san/​_show.py Exposes V2 capacity metrics.
.../​elastic_san/​_list.py Exposes V2 fields in listings.
.../​elastic_san/​_list_sku.py Adds zone capability metadata.
.../​elastic_san/​_delete.py Migrates SAN deletion API.
.../​elastic_san/​_create.py Adds V2 creation parameters.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/elastic-san/HISTORY.rst Resolved
@a0x1ab

Copy link
Copy Markdown
Member

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 2 pipeline(s).

@yonzhan

Copy link
Copy Markdown
Collaborator

Please fix CI issues

@a0x1ab

Copy link
Copy Markdown
Member

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 2 pipeline(s).

@a0x1ab

Copy link
Copy Markdown
Member

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 2 pipeline(s).

@a0x1ab

Copy link
Copy Markdown
Member

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 2 pipeline(s).

@a0x1ab

Copy link
Copy Markdown
Member

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 2 pipeline(s).

@a0x1ab

Copy link
Copy Markdown
Member

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 2 pipeline(s).

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 2 pipeline(s).

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.

🔵 Needs a closer look

Requiring identity.type breaks previously valid partial identity updates by rejecting them before the existing type can be retrieved and preserved.

No open issues 🎉

1 previously missed issue

In code that hasn't changed since last review

Medium severity Preserve existing identity type in partial updates

src/​elastic-san/​azext_elastic_san/​custom.py:373

Requiring identity.type breaks previously valid partial updates such as --identity '{user-assigned-identity:<id>}' on a group that already has a user-assigned identity: validation now fails before GET can preserve the existing type. Keep the type optional and resolve an omitted type from the retrieved identity before translating the legacy options. Add a regression test for this partial-update form.

2 resolved since last review

Review effort: Balanced

@a0x1ab

Copy link
Copy Markdown
Member

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 2 pipeline(s).

@a0x1ab

Copy link
Copy Markdown
Member

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 2 pipeline(s).

@yonzhan

Copy link
Copy Markdown
Collaborator

Adding mansoor sarfraz (@msarfraz) to help review/merge

@amnguye

Copy link
Copy Markdown
Member Author

mansoor sarfraz (@msarfraz) Could you help with the review/merge?

@naga-nandyala Naga Nandyala (naga-nandyala) 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.

Amanda Nguyen (@amnguye)

Thanks for all the iterations. CI is green, and the --remove and legacy --identity findings look addressed. A few items before approval:

  1. Release packaging: HISTORY declares a breaking managedBy output change (object → array). Per the extension versioning guidelines, this preview should be 2.0.0b1, not 1.4.0b1. Please also align azext.isPreview with the preview release.

  2. PR description and source: Please add a summary, links to the merged REST spec and Azure/aaz#1119, the breaking output change and managedByResourceId compatibility alias, and test evidence. Please coordinate review and merge of the AAZ source changes.

  3. Service readiness: The scenarios use the East US 2 EUAP ARM endpoint. Please confirm that 2026-05-01-preview is available through public ARM in the supported regions, since existing commands also switch to this version.

Two implementation questions:

  • AAZ compatibility overrides: Can the generator preserve generic-update support and reduce the custom overrides? If these overrides are necessary, please briefly document the non-obvious compatibility workarounds.

  • V2 autoscale defaults: Please confirm that the CLI-side defaults and additional SKU-discovery request are agreed with the service team, document the defaults in command help, and add a recorded scenario exercising creation with those defaults omitted.

@a0x1ab

Copy link
Copy Markdown
Member

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 2 pipeline(s).

@amnguye

Amanda Nguyen (amnguye) commented Nov 11, 2026 •

Copy link
Copy Markdown
Member Author

Naga Nandyala (@naga-nandyala)

  1. Release packaging: HISTORY declares a breaking managedBy output change (object → array). Per the extension versioning guidelines, this preview should be 2.0.0b1, not 1.4.0b1. Please also align azext.isPreview with the preview release.

Latest commit contains changes to 2.0.0b1 version and azext.IsPreview set to true.

  1. PR description and source: Please add a summary, links to the merged REST spec and Azure/aaz#1119, the breaking output change and managedByResourceId compatibility alias, and test evidence. Please coordinate review and merge of the AAZ source changes.

Updated PR description (at the bottom) with all the asked information

  1. Service readiness: The scenarios use the East US 2 EUAP ARM endpoint. Please confirm that 2026-05-01-preview is available through public ARM in the supported regions, since existing commands also switch to this version.

I can follow up on this. I was told by the service team that the supported version was only available in East US 2 EUAP, however that may have changed. However they were the ones who requested for a CLI extension support for this latest version.

Two implementation questions:

  • AAZ compatibility overrides: Can the generator preserve generic-update support and reduce the custom overrides? If these overrides are necessary, please briefly document the non-obvious compatibility workarounds.

The compatibility overrides are needed because the regenerated PATCH commands don't provide the old generic-update flow, and also the PATCH command doesn't accept SKU or availability zones. Also some of the compatability overrides handle the legacy identity and managed by formats. I updated the docs for the non-obvious workarounds in the readme. AAZ can update some commands but I did not find that it could address the compatibility flow.

  • V2 autoscale defaults: Please confirm that the CLI-side defaults and additional SKU-discovery request are agreed with the service team, document the defaults in command help, and add a recorded scenario exercising creation with those defaults omitted.

So the service team were the ones who called this out to set the V2 autoscale defaults, and matching SKU for regional limits. I updated the docs to reflect this, and also added a recorded scenario for creation with the defaults omitted.

@necusjz

Copy link
Copy Markdown
Member

Amanda Nguyen (@amnguye) please update the pr under Azure/aaz to the latest status.

@necusjz

Copy link
Copy Markdown
Member

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 2 pipeline(s).

@necusjz
Ethan Yang (necusjz) merged commit 4fc6808 into Azure:main Nov 12, 2026
24 checks passed
@azclibot

Copy link
Copy Markdown
Collaborator

[Release] Update index.json for extension [ elastic-san-2.0.0b1 ] : https://dev.azure.com/msazure/One/_build/results?buildId=190793065&view=results

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Request X Engineering Agent Ask the agent to triage this issue or review this PR X Engineering Agent Reviewed Agent reviewed this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants