Az.KeyVault: add API version 2026-02-01 retirement notice to module help

[Alex Wang (Alex-AZPS)]

Summary

Add an API-version retirement notice to the Az.KeyVault module help, so the generated module reference page (https://learn.microsoft.com/en-us/powershell/module/az.keyvault/) surfaces 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. Az.KeyVault already upgraded to API version 2026-02-01 as of module version 6.6.1 (see ChangeLog.md); this PR adds a corresponding notice to the module's published help so users on older module versions know to upgrade to Azure PowerShell 16.3.0+ before the retirement date.

This mirrors the equivalent change made on the Azure CLI side in Azure/azure-cli#34208 (az keyvault group help).

Changes

• src/KeyVault/KeyVault/help/Az.KeyVault.md: added two sentences to the ## Description section:
  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 PowerShell version needed to use the new API version, and the suspension date for older API versions.

Scope

Only the Az.KeyVault module description was changed. No cmdlet behavior was modified, so no ChangeLog.md entry was added.

[azure-pipelines]

Azure Pipelines:
Successfully started running 2 pipeline(s).
There may be pipelines that require an authorized user to comment /azp run to run.

[Copilot]

🟢 Approval recommended

The documentation-only update is accurate, scoped appropriately, and consistent with the referenced Azure CLI notice.

0 open findings

What changed in this PR

Adds a Key Vault control-plane API retirement notice to the Az.KeyVault module help.

Changes:

• Documents the February 27, 2027 retirement date.
• Directs users to upgrade to Azure PowerShell 16.3.0 or later.

File	Description
src/​KeyVault/​KeyVault/​help/​Az.KeyVault.md	Adds retirement and upgrade guidance to the module description.

🧠 Review effort: Balanced

---

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

[Copilot]

🟡 Changes recommended

The notice should include the promised Azure PowerShell 16.3.0 minimum version.

1 open finding

• Document the required Azure PowerShell 16.3.0 version · New

🧠 Review effort: Balanced

[Copilot]

🔵 Needs a closer look

The guidance incorrectly implies every Az.KeyVault 6.6.1 control-plane command uses API version 2026-02-01 and links to the wrong migration page.

0 open findings

1 resolved since last review

• Document the required Azure PowerShell 16.3.0 version

Previously missed (2)

In code that hasn't changed since last review

Exported Key Vault commands still use outdated API versions

src/​KeyVault/​KeyVault/​help/​Az.KeyVault.md:15

Az.KeyVault 6.6.1 does not uniformly use API version 2026-02-01. The module exports its nested AutoRest functions (src/KeyVault/KeyVault/Az.KeyVault.psd1:78-86), but, for example, Get-AzKeyVaultManagedHsmRegion is still generated with ApiVersion = "2024-11-01" (generated/KeyVault/KeyVault.Autorest/generated/cmdlets/GetAzKeyVaultManagedHsmRegion_List.cs:23); the other exported name-availability/region functions use that older contract as well. Users following this blanket upgrade guidance can therefore still issue control-plane requests that the preceding paragraph says will retire. Please update/regenerate those commands before advertising 6.6.1 as compliant, or identify a version where every exported control-plane command is upgraded.

API-version checklist link points to the wrong migration article

src/​KeyVault/​KeyVault/​help/​Az.KeyVault.md:13

This link promises the API-version update checklist but sends readers to the separate RBAC/access-control migration article. Since the notice explicitly distinguishes those migrations, link directly to Microsoft's API-version migration checklist instead.

🧠 Review effort: Balanced

[NoriZC]

/azp run azure-powershell - security-tools

[azure-pipelines]

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