-
Notifications
You must be signed in to change notification settings - Fork 0
Description
Background
A recent product update has been released that may impact our documentation. This could include new features, changes to existing functionality, or other product enhancements.
Your Action Required: Please review the suggestions below and update the relevant documentation to ensure accuracy and completeness.
Signal Details:
- Title: [GitHub] azure-cli azure-cli-2.81.0
- Source URL: https://github.com/Azure/azure-cli/releases/tag/azure-cli-2.81.0
- Repository: https://github.com/Azure/azure-cli
- ReleaseWindowUtc: 2025-11-18 05:40:19Z - 2025-12-02 05:39:31Z
- TargetBranch: release
- currentTag: azure-cli-2.81.0
- targetCommitish: release
- releaseUrl: https://github.com/Azure/azure-cli/releases/tag/azure-cli-2.81.0
- previousTag: azure-cli-2.80.0
Source Signal Summary
- Azure CLI
az cosmosdb create(Cosmos DB account)--capabilitiesparameter changed from “one or more values required” to “zero or more values allowed” (nargs='+'→nargs='*'), so theaz command referenceand parameter guidance should no longer imply at least one capability must be provided when the flag is used. - Breaking: Azure CLI
az netappfiles pool createandaz netappfiles pool updatechanged--custom-throughput/--custom-throughput-mibpsto accept an integer value (MiB/s) instead of a float; scripts passing decimals may now fail validation. - Azure CLI
az netappfiles volume-group createadded--network-features(alias--shared-network-features) under the “Shared Volume” arguments to set volume-group network features (BasicorStandard, defaultBasic). - Azure CLI
az netappfiles volume replication listadded--excludeto filter out deleted replications (None/Deleted, defaultNone); this is now sent in the request body and affects which replications appear in command output. - Azure CLI
az netappfiles volume updatemarked--remote-volume-resource-id(alias--remote-volume-id) as deprecated via the breaking-change/deprecation system; az command reference should reflect the deprecation guidance. - Azure CLI
az netappfiles volume splitclonefromparentis no longer marked asis_preview=True(i.e., it should no longer be documented as a preview command in the az command reference). - Azure CLI
az netappfiles check-name-availabilityandaz netappfiles check-quota-availabilityexpanded supported--typevalues to include backup-related resource types (for example,Microsoft.NetApp/netAppAccounts/backupVaults/backupsandMicrosoft.NetApp/netAppAccounts/capacityPools/volumes/backups). - Breaking: Azure CLI
az mysql flexible-server exportcommand group (includingaz mysql flexible-server export create) is now hidden from the az command reference/help viadeprecate_info=self.deprecate(hide=True)because MySQL Flexible Server backup export is no longer supported; update/remove any docs that instruct users to runaz mysql flexible-server export. - Azure CLI
az aks safeguards createandaz aks safeguards updateadd a new--pss-levelparameter to configure AKS Deployment Safeguards Pod Security Standards (PSS) level (Baseline,Privileged,Restricted), and theaz aks safeguards show/list/waitoutputs now include thepodSecurityStandardsLevelfield for the DeploymentSafeguards resource. - Azure CLI
az aks safeguardscommands (create,update,show,list,delete,wait) update their documented usage to reliably support the-g/--resource-group+-n/--namepattern (in addition to-c/--cluster/--managed-cluster), including treating-c/--clusteras either a full managed cluster resource ID or (if not a valid resource ID) a cluster name that requires-g/--resource-group; managed cluster IDs are also normalized to allow missing leading/for backward compatibility. - Azure CLI
az aks safeguards createnow performs a pre-check and fails fast with a clear error message if an AKS Deployment Safeguards instance already exists for the cluster, directing users toaz aks safeguards updateoraz aks safeguards deleteinstead of attempting to create again. - Azure CLI
az aks safeguardscommands switch the underlying AKS DeploymentSafeguards management-planeapi-versionto2025-07-01(from2025-04-01), which may affect any documentation that references the specific API version used by the Azure CLI implementation. - Azure CLI
az bicep install: fixes behavior so that specifying--versionno longer gets ignored whenbicep.use_binary_from_pathis enabled; the CLI will only use thebicepexecutable fromPATHwhen no specific version is requested (aligns--versionsemantics with the az command reference foraz bicep install). - Azure CLI
az bicep install: adds/changes user-visible console messages when Bicep is already installed—prints a skip message when no--versionis provided, and prints an “already installed” message when the requested--versionmatches the installed Bicep CLI version (may affect documented examples/output expectations foraz bicep install). - Azure CLI
az vm showandaz vm wait(Compute command group) now support--expand resiliencyViewin addition to existinginstanceView/userDataoptions; update theaz vm show/az vm waitaz command reference for the new--expandvalue. - Azure CLI
az vm show/az vm waitresponses (JSON output) now include additional fields surfaced by the newer Compute API version (moved toapi-version=2025-04-01), notablysystemDataon the VM resource and additional properties underproperties(for exampleadditionalCapabilities.enableFips1403Encryption,scheduledEventsPolicy.allInstancesDown,scheduledEventsAdditionalPublishingTargets.eventGridAndResourceGraph.scheduledEventsApiVersion, andsecurityProfile.proxyAgentSettings.addProxyAgentExtension); update any docs or samples that enumerate these outputs. - Azure CLI
az vm updateandaz vmss updatenow use ARM resource-ID typed arguments (AAZResourceIdArg) for severalidfields (for example network interfaceid,storageProfile.imageReference.id, disk encryption setid, and generic sub-resourceid); documentation for these parameters should explicitly state/assume full Azure Resource Manager resource IDs and scripts that relied on non-ID strings may no longer work. - Azure CLI
az vmss showis now implemented in the AAZ (Code Gen V2) layer and usesapi-version=2025-04-01; its JSON output includessystemDataand other newer Compute resource fields, so update anyaz vmss showoutput examples or field lists in the az command reference if they implied the previous shape. - Azure CLI
az vm updateswitched to the AAZ (Code Gen V2) backend for the “get-then-update” flow, including a behavior change to skip image permission checks by clearingstorageProfile.imageReferenceon the fetched VM object; users who previously needed read access to the source image may no longer need it foraz vm updatein common update scenarios. - Azure CLI
az vmss updateswitched to the AAZ (Code Gen V2) backend for both VM Scale Set model updates and per-instance updates (az vmss update --instance-id ...), including the same behavior change to skip image permission checks by clearingvirtualMachineProfile.storageProfile.imageReference(or instancestorageProfile.imageReference) before sending the update. - Azure CLI (AAZ-generated)
az vmss waitadded a new--expandquery option (documented values includeuserData) and updated its underlying Compute “api-version” to2025-04-01, which may affect documentedaz vmss waitparameters and examples involving--expand/UserData retrieval. - Azure CLI
az vm application setandaz vmss application set(Compute) add a new multi-value flag--enable-automatic-upgrade(alias--enable-auto-upgrade) to set per-application Gallery Application automatic upgrade behavior; values are a space-separated list oftrue|falsecorresponding to--app-version-ids/--application-version-idsitems. - Azure CLI
az vm application set/az vmss application setnow validate that--enable-automatic-upgradeprovides the same number oftrue|falsevalues as--application-version-ids, otherwise the command fails with a usage error (impacts documented parameter rules for theseazcommands). - Azure CLI help/az command reference examples for
az vm application setare updated to show using--enable-automatic-upgradewhen setting VM applications. - Breaking: Azure CLI
az vmss application setoutput may include an extra line written to stdout (aprint(...)of the VMSS extension list) before the normal command output, which can break scripts that parse the command output format.
Suggestions
Note
Suggestions are generated by AI and they may not be entirely accurate or complete. Please check impacted files scope and suggestions details before making changes.
- docs-ref-conceptual/Latest-version/release-notes-azure-cli.md:
- In the December 02, 2025 (Azure CLI 2.81.0) section under NetAppFiles, add a
[BREAKING CHANGE]entry foraz netappfiles pool createandaz netappfiles pool updatenoting that--custom-throughput/--custom-throughput-mibpsnow only accepts integer values (MiB/s). Include the user-visible impact that decimal values (floats) that previously worked will now fail validation. - In the same breaking change bullet, explicitly clarify the expected unit (MiB/s) and that the input type is an integer (no decimals). This prevents ambiguity for users migrating scripts that may have used fractional throughput values.
- If the release notes document maintains consistency for parameter naming, include both parameter forms as they appear in the CLI (
--custom-throughputand--custom-throughput-mibps) to ensure users searching for either flag can find the breaking change note. Place it near other NetAppFiles changes for 2.81.0.
- In the December 02, 2025 (Azure CLI 2.81.0) section under NetAppFiles, add a
- docs-ref-autogen/Latest-version/latest/netappfiles/pool.yml:
- [Correction] In the
az netappfiles pool createsection, update the--custom-throughput/--custom-throughput-mibpsparameter description (and any parameter metadata if present) to explicitly state that the value must be an integer number of MiB/s and that decimal values are not accepted. - [Correction] In the
az netappfiles pool updatesection, make the same change for the--custom-throughput/--custom-throughput-mibpsparameter to reflect integer-only input and prevent scripts from using decimal values. - [Correction] Review the examples on the page (and any inline snippets that mention
--custom-throughput) and ensure they use whole-number MiB/s values only; if any examples use decimals, change them to integers.
- [Correction] In the
- docs-ref-conceptual/Latest-version/release-notes-azure-cli.md:
- In the "December 02, 2025 (Version 2.81.0)" section, add a MySQL (or appropriate category) breaking change entry stating that MySQL Flexible Server backup export is no longer supported and the
az mysql flexible-server exportcommand group (includingexport create) is hidden/removed from CLI help and reference. - Where the new breaking change is added for 2.81.0, clarify the user-visible impact (for example, users will not see
az mysql flexible-server exportinaz --help/command reference and scripts relying on it must be updated), without rewriting older historical entries.
- In the "December 02, 2025 (Version 2.81.0)" section, add a MySQL (or appropriate category) breaking change entry stating that MySQL Flexible Server backup export is no longer supported and the
- docs-ref-autogen/Latest-version/latest/aks/safeguards.yml:
- [Correction] In each command section (
create,update,show,list,delete,wait), update the--cluster/--managed-cluster (-c)parameter description to state it accepts either a managed cluster ARM resource ID or a cluster name. Clarify that when a name is provided,--resource-group (-g)is required (and that-ccan be an ID or name, but not both with-g/-nif the command enforces mutual exclusivity). - [Correction] Where the docs refer to the managed cluster identifier as “fully qualified” (implying a leading
/), adjust wording to reflect the new normalization behavior that also accepts IDs without the leading/for backward compatibility. This applies to the--cluster/--managed-clusterparameter descriptions and any example text that labels the input as a fully qualified ARM ID. - Add (or adjust) at least one example under the affected commands demonstrating
-c/--clusterused as a cluster name together with-g/--resource-group(for example,az aks safeguards show -c <clusterName> -g <rg>). This ensures the newly supported and user-visible invocation pattern is discoverable and not contradicted by the existing ID-only wording.
- [Correction] In each command section (
- docs-ref-autogen/Latest-version/latest/vm.yml:
- In the az vm show command section, add/update the
--expandoptional parameter to reflect the supported expand options and include the new valueresiliencyViewalongside the existinginstanceViewanduserDatavalues. Update the syntax block foraz vm showto include--expandif it is currently omitted. - In the az vm wait command section, add/update the
--expandoptional parameter and includeresiliencyViewas an accepted value (alongside the existinginstanceViewanduserDatavalues). Update theaz vm waitsyntax block to include--expandif it is currently omitted. - Where the
--expandparameter is documented, ensure the parameter description and accepted-values list clearly indicate thatresiliencyViewis a valid selection so users can correctly request resiliency details in the response payload used for waiting/queries.
- In the az vm show command section, add/update the
- docs-ref-autogen/Latest-version/latest/vm.yml:
- In the
az vm showcommand section, update the option list to include the--expandparameter and listresiliencyViewas an accepted value alongside the existing supported values (for exampleinstanceViewanduserData, as applicable). Ensure the syntax block and the optional-parameters table reflect this. - In the
az vm waitcommand section, add/update documentation for--expandand includeresiliencyViewas a valid expand target. Make sure the parameter description and any accepted-values list reflect the new value. - Where the document describes VM details returned or conditions used in wait queries (for example references to instance view), ensure the wording does not imply only
instanceView/userDataexpansions are possible. Adjust any--customquery examples only if they explicitly depend on a limited set of expand values.
- In the
📚 To learn more about agentic content maintenance workflow, visit Agentic workflow for Learn content maintenance. Sign in using Learn Profile to access the content on this link.
💬 Share your feedback on the Learn Content Maintenance Agentic Workflow here.