Skip to content

az keyvault: add API version 2026-02-01 retirement notice to group help - #34208

Open
Alex Wang (Alex-AZPS) wants to merge 2 commits into
devfrom
alexwang/keyvault-api-version-retirement-notice
Open

Alex Wang (Alex-AZPS) wants to merge 2 commits into
devfrom
alexwang/keyvault-api-version-retirement-notice

Conversation

@Alex-AZPS

Copy link
Copy Markdown

Summary

Add an API-version retirement notice to the az keyvault command group help, so az keyvault --help and the generated CLI reference page (https://learn.microsoft.com/en-us/cli/azure/keyvault) surface this directly instead of only living in the conceptual Key Vault docs.

Background

All Key Vault control plane API versions before 2026-02-01 retire on February 27, 2027. This retirement is separate from the access-control (RBAC vs. access policies) migration. Azure CLI 2.90.0+ and Azure PowerShell 16.3.0+ are required to use API version 2026-02-01 and later; earlier API versions will be suspended after the retirement date.

This is added as a long-summary in _help.py (not edited directly in MicrosoftDocs/azure-docs-cli) because the CLI reference pages under docs-ref-autogen/ are auto-generated from this help text on every doc-build pipeline run — a direct edit there would be overwritten the next time az keyvault ships.

Changes

  • src/azure-cli/azure/cli/command_modules/keyvault/_help.py: added a long-summary to helps['keyvault'] with:
    1. The API-version retirement notice and date, linking to Plan for Azure RBAC as the default access control model in Key Vault for the update checklist.
    2. The minimum Azure CLI / Azure PowerShell versions needed to use the new API version, and the suspension date for older API versions.

Scope

Only the keyvault group's help text was changed. No command behavior was modified.

@Alex-AZPS
Alex Wang (Alex-AZPS) requested a review from a team as a code owner October 9, 2026 18:20
Copilot AI balanced review requested due to automatic review settings October 9, 2026 18:20
@yonzhan

Copy link
Copy Markdown
Collaborator

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

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.

🟢 Approval recommended

The documentation-only change is correctly formatted and aligns with official Key Vault guidance.

0 open findings

What changed in this PR

Adds a Key Vault control-plane API retirement notice to CLI group help and generated reference documentation.

Changes:

  • Documents the February 27, 2027 retirement date.
  • Specifies minimum supported CLI and PowerShell versions.
File Description
src/​azure-cli/​azure/​cli/​command_modules/​keyvault/​_help.py Adds the retirement and upgrade guidance to group help.

🧠 Review effort: Balanced


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

This branch has not been deployed

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

Labels

act-identity-squad Auto-Assign Auto assign by bot KeyVault az keyvault

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants