-
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: azure-cli azure-cli-2.82.0
- Source URL: https://github.com/Azure/azure-cli/releases/tag/azure-cli-2.82.0
- Repository: https://github.com/Azure/azure-cli
- ReleaseWindowUtc: 2025-12-02 05:39:31Z - 2026-01-13 03:38:44Z
- TargetBranch: release
- currentTag: azure-cli-2.82.0
- targetCommitish: release
- releaseUrl: https://github.com/Azure/azure-cli/releases/tag/azure-cli-2.82.0
- previousTag: azure-cli-2.81.0
Source Signal Summary
Details
- Azure CLI
az network application-gateway settings createandaz network application-gateway settings update(az command reference) add a new boolean flag--enable-l4-client-ipto set the Application Gateway backend settings propertyenableL4ClientIpPreservation(help text states default isfalse;updatesupports clearing via nullable behavior). - Azure CLI
az network application-gateway probe createandaz network application-gateway probe update(az command reference) add a new boolean flag--enable-proxy-headerto set the Application Gateway probe propertyenableProbeProxyProtocolHeader(help text states default isfalse;updatesupports clearing via nullable behavior). - Azure CLI
az network application-gateway probeandaz network application-gateway settingscommands move to Azure Network management APIapi-version=2025-01-01(from2023-11-01), which may affect documented compatibility/availability in sovereign clouds or older environments where that API version is not supported. - Azure CLI in-command help text for
az network application-gateway probe delete/list/showandaz network application-gateway settings delete/list/showno longer includes the inline:example:blocks (may reduce examples shown inaz ... -h, so az command reference/examples may need to compensate). - Azure CLI Network:
az network application-gateway waf-policy managed-rule rule-setdisabled rules default behavior (updateaz networkcommand reference and any default-behavior notes). - Azure CLI
az network virtual-appliance createandaz network virtual-appliance updateadd a new Properties parameter--nva-interface-configurations(alias--interface-configs) to configurenvaInterfaceConfigurations(list max length 3) with fieldsname(max 70 chars),subnet.id(subnet resource ID), andtype(list enum:PrivateNic,PublicNic,AdditionalPrivateNic,AdditionalPublicNic; docs should note onlyPrivateNic+PublicNiccombo is currently supported). - Azure CLI
az network virtual-appliance showoutput now includesproperties.nvaInterfaceConfigurationsandproperties.privateIpAddress(read-only), affecting theaz command referencefor expected JSON fields. - Azure CLI adds a new command group
az network virtual-appliance identitywith new commandsassign,remove,show, andwait;assign/removesupport--system-assignedand--user-assigned(managed identities) and support--no-wait, requiring newaz command referenceentries for this command group. - Breaking: Azure CLI
az network virtual-appliance createandaz network virtual-appliance updaterename the parameter--internet-ingress-public-ipsto--internet-ingress-ips(mapped toproperties.internetIngressPublicIps), which can break existing scripts using the old flag. - Azure CLI
az network virtual-appliance create/list/show/update/delete/waitmove to Network management API version2024-10-01; docs may need updates if behavior or supported properties differ from the previously documented2023-11-01behavior. - Azure CLI
az network watcher flow-log createandaz network watcher flow-log updateadd a new optional--record-typesparameter (az command reference) to filter Flow Log records by flow state using a comma-separated combination ofB(Begin),C(Continue),E(End), andD(Deny); if omitted, Azure Network Watcher Flow Logs continue to log all traffic. - Azure CLI
az network watcher flow-log show(andaz network watcher flow-log waitoutput) now surfaces therecordTypesproperty in the returned Flow Log resource when present, aligning command output with the new--record-typessetting. - Azure CLI
az network private-endpoint-connection/ Private Link provider registration now includesMicrosoft.Maps/accounts(API version2023-12-01-preview) as a supported Private Link resource type; update docs that list supported resource providers for Network Private Link Resource / Private Endpoint Connection workflows to include Azure Maps. - Behavior change (Azure CLI
az acr login): AAD token acquisition for Azure Container Registry now always requests an access token with the ACR audience (https://containerregistry.azure.net/ACR_AUDIENCE_RESOURCE_NAME), instead of conditionally using that audience based on the registry’s authentication policy; docs/help that describeaz acr loginauthentication/token behavior may need to be updated to reflect the new fixed audience used. - Azure CLI
az appservice list-locationsadds a new preview flag--managed-instance-enabledto filter the App Service region list to locations that support Azure App Service Managed Instance workers (Managed Instance App Service Plan support);az appservice list-locations --managed-instance-enabledperforms SKU-tier validation and returns an empty list unless--skuis a supported Managed Instance tier (currentlyPremiumV4/PremiummV4), and it queries theMicrosoft.Web/geoRegionsAPI using API version2025-03-01with Managed Instance–specific handling (SKU not sent to the API call). - Azure CLI
az vmss get-instance-viewis migrated to an AAZ-based implementation (now calling the Compute RPinstanceView/virtualMachines/{instanceId}/instanceViewendpoints with API version2024-11-01), which may change observable CLI behavior such as error payload formatting and the exact JSON shape/field flattening of the command output compared to the prior SDK-based implementation (updateaz command referenceexamples if they imply the old output structure);az vmss get-instance-view --instance-id '*'now retrieves per-VM instance views via an AAZ-basedaz vmss list-instancescall with--select instanceView --expand instanceViewand returns a list extracted from each item’sinstanceViewfield (instead of returning SDK object properties). - Azure CLI adds
az vmss get-resiliency-view(new command to return the resiliency status for a specific VM Scale Set instance; uses--instancefor the instance ID and automatically requestsresiliencyView), andaz vmss list-instancesadds a new--resiliency-viewflag to fetch and display resiliency status for each instance;az vmss list-instancesalso updates command parameters/help in theaz command reference(explicit--name/--virtual-machine-scale-set-name,--expand,--filter,--select, and new pagination flags--max-items/--next-tokenunder “Pagination”, plus guidance that Flexible Orchestration mode users should useaz vm listfor full details). - Azure CLI
az sig image-version createandaz sig image-version updatenow surface a breaking-change warning indicating upcoming default-value changes for Azure Compute Gallery image versions:--end-of-life-datedefaulting to “6 months from publish date” and--block-deletion-before-end-of-lifedefaulting totruewhen the flags aren’t specified. - Azure CLI az command reference: added new preview command groups for Azure Cosmos DB Fleet management —
az cosmosdb fleet(create/list/show/delete),az cosmosdb fleetspace(create/list/show/update/delete), andaz cosmosdb fleetspace account(create/list/show/delete), including new required parameters like--fleet-name,--fleetspace-name, and--fleetspace-account-nameplus example usage in_help.py;az cosmosdb fleetspace create|updaterequires/validates--body (-b)JSON payload (string or@file) with documented fields underpropertiesincludingserviceTier,dataRegions, andthroughputPoolConfiguration.minThroughput/maxThroughput;az cosmosdb fleetspace account createrequires/validates--body (-b)requiringproperties.globalDatabaseAccountProperties.resourceId(ARM resource ID) andarmLocation. - Azure CLI
az cosmosdb create/az cosmosdb updateadd account-level flags--enable-pbe(priority based execution) and--default-priority-level(enumDefaultPriorityLevel), and add a new--disable-local-auththree-state flag (true/false/unset) to disable key-based authentication on a Cosmos DB account (enforcing Microsoft Entra ID for data-plane access); docs should also cover how--disable-local-authdiffers from--disable-key-based-metadata-write-access(control-plane metadata writes). - Azure CLI
az cosmosdb restore: updated the meaning of--locationhelp text and added--source-backup-locationfor cross-region restore scenarios;--source-backup-locationis no longer marked as preview (now GA), and request construction was fixed so it is applied viarestoreParameters.sourceBackupLocation(instead of being passed at the top level), changing behavior from “flag accepted but restore may fail/ignore it” to “cross-region restore works as documented”. - Azure CLI
az postgres flexible-server fabric-mirroring(start/stop/update-databases): Fabric mirroring is now allowed on high availability-enabled PostgreSQL Flexible Server instances when the server version is PostgreSQL 17 or 18; the previous CLI error (“Fabric mirroring is not supported on servers with high availability enabled.”) now only applies to HA servers on earlier PostgreSQL versions. - Azure CLI
az postgres flexible-server create/az postgres flexible-server updatehigh availability changes: add--zonal-resiliency {Enabled,Disabled}(defaultDisabledon create) and--allow-same-zone(requires--zonal-resiliency Enabled; in single-AZ regions--zonal-resiliency Enabledrequires--allow-same-zone); deprecate--high-availability(errors if both--high-availabilityand--zonal-resiliencyare provided); tie--standby-zoneusage to enabling HA via--zonal-resiliency Enabled(still enforcing different primary/standby zones), andaz postgres flexible-server updatenow correctly supports--zonal-resiliency Enabledtogether with--standby-zone <zone>without incorrectly failing validation; HA is now supported with--storage-type PremiumV2_LRS(Premium SSD v2) (the prior validator block was removed). - Azure CLI
az postgres flexible-serverdefaults/semantics and command surface changes: default location (when--locationisn’t specified) changed fromeastustocanadacentral; breaking change thataz postgres flexible-server migration deletenow invokes the migration cancel operation (cancels an active migration) rather than deleting a migration resource;az postgres flexible-server advanced-threat-protection-setting shownow reads from the PostgreSQL Flexible Server AdvancedThreatProtectionSettings API surface (viaazure-mgmt-postgresqlflexibleservers2.0.0 / API version 2025-08-01). - Azure CLI adds
az postgres flexible-server autonomous-tuning(update/show/list-settings/show-settings/set-settings; recommendation listing vialist-index-recommendationsandlist-table-recommendationswith--recommendation-typefiltering) and deprecates/redirectsaz postgres flexible-server index-tuningtoaz postgres flexible-server autonomous-tuning; allowed--recommendation-typevalues expand to includeReIndex(in addition toCreateIndex/DropIndex) for both the legacyindex-tuning list-recommendationsand the newautonomous-tuning list-index-recommendations;postgres flexible-serverlocation capability output field changed fromindex_tuning_supportedtoautonomous_tuning_supported. - Azure CLI
az postgres flexible-server index-tuning --enabled trueno longer fails with the region capability errors “The location is restricted for provisioning of flexible servers…” or “No available SKUs in this location.” when the PostgreSQL Flexible Server Capabilities API returnsOfferRestricted=Enabled/non-Disabled; it now bypasses the “offer restriction” check and only enforces whether IndexTuning is supported for the server’s region. - Azure CLI (
azcommand reference):az postgres flexible-server {backup|db|firewall-rule|identity|long-term-retention|microsoft-entra-admin|migration|parameter|replica} listnow supports using--ids(server resource ID) for list operations (instead of requiring explicit--server-name/-s); breaking:az postgres flexible-server replica promoteswitches the replica identifier flag from--server-name/-sto--name/-n(“Name of the read replica”); breaking:az postgres flexible-server migration {create|show|list|update|check-name-availability}changes the target server parameter from--name/-nto--server-name/-s. - Azure CLI
az postgres flexible-server replica create: adds--name/-nfor the read-replica server name, updates examples to use--name, and deprecates--replica-namewith redirect to--name(users must now provide either--nameor the deprecated--replica-name; otherwise the command errors); Azure CLI breaking-change announcements (targeted for CLI breaking-change release2.86.0, May 2026) state thataz postgres flexible-server backup,db,firewall-rule,long-term-retention, andmigrationwill deprecate/remove--backup-name,--database-name,--rule-name, and--migration-name, repurpose--name/-nto mean the child resource, and introduce--server-name/-sto specify the server. - Azure CLI
az postgres flexible-server upgradenow allows--version/-v 18(PostgreSQL 18) by extending accepted enum values; help examples foraz postgres flexible-server upgrade(and theaz postgres flexible-server createexample showing--version) are updated to use PostgreSQL version 18. - Azure CLI
az postgres flexible-server create: adds--database-name(mapped todatabase_name) for Elastic Cluster creation, where the value is passed as the clusterdefault_database_nameinstead of always using the previous default (postgres); breaking: it now defaults--database-name/-dtoNone(no default database is assumed), and validation now requires--database-name/-dto be used only when--cluster-option ElasticClusteris used (otherwise the command fails with an argument usage error). - Azure CLI
az sql mi create/az sql mi updateadd--memoryto setmemory_size_in_gb(memory size specified in GB), andaz sql mi updatenow explicitly clearsrequested_logical_availability_zoneon update requests to avoid failures caused by the default'NoPreference'value. - Azure CLI adds
az monitor dashboardcommand group to manage Dashboard with Grafana (Microsoft.Dashboard/dashboards) resources, including:create(PUT2025-09-01-preview, idempotent create-or-update; required--resource-group,--location, and--name/--dashboard-namewith the documented name pattern constraint; optional--tags; supports--no-wait),delete(interactive confirmation unless--yes),show,list(scoped to required--resource-group, nextLink-based pagination), andwait(standard wait semantics; requires--resource-groupand--name/--dashboard-name). - Azure CLI
az containerapp env createadds--infrastructure-resource-group/-i(optional; if not provided CLI generates a resource group name automatically) and validation now requires-ibe used only with--infrastructure-subnet-resource-id/-sand--enable-workload-profiles/-w(otherwise the command fails with a required-argument error);az containerapp compose createnow supports docker-compose services that specifyenv_filebut omitenvironment(fixes crashTypeError: 'NoneType' object is not iterable). - Azure CLI
az identity createandaz identity updateadd--isolation-scope(enumNone,Regional) to setisolationScope; Azure CLI introduces a newaz identity updatecommand supporting updates to--tagsand--isolation-scope; default API version forResourceType.MGMT_MSIoperations switches to2024-11-30(from2023-01-31). - Azure CLI
az aks install-cliadds--gh-tokento pass a GitHub authentication token when downloadingkubeloginfrom GitHub releases;az aks nodepool updateadds/updates--gpu-driver(enum;"Install"or"None", persisted togpuProfile.driver);az aks nodepool add/update--os-skunow accepts a new Linux valueUbuntu2404. - Breaking: Azure CLI
az maps creatorcommand group has been removed; breaking:az maps account createnow defaults to--kind Gen2(instead of Gen1) and default--location eastus(instead ofglobal), and explicitly supports--location/-lwith resource-group defaulting behavior (get_default_location_from_resource_group). - Azure CLI
az keyvault key create/az keyvault key importadd--default-data-disk-policy(alias--default-dd-policy) to apply a default Key Release Policy for data disk encryption; validation:--default-data-disk-policycannot be combined with--policyand is mutually exclusive with--default-cvm-policy. - Breaking: Azure CLI
--output jsonserialization (azure.cli.core.util.todict) now usesazure-core’sget_backcompat_attr_name()for Azure SDK model fields, which can change emitted JSON property names (and therefore JMESPath queries) for commands returning SDK models (includingaz keyvaultresults);az keyvaultcommand module migrates to the TypeSpec-generated management SDK (azure-mgmt-keyvault13.0.0), which may alter returned object shapes and error details in examples/troubleshooting;az sfworkflows that auto-create an Azure Key Vault now grant broader default access policies (KeyPermissions.all,SecretPermissions.all,CertificatePermissions.all) when--no-self-permsis not used. - Azure CLI Storage SAS/OAuth changes: add preview
--user-delegation-oidforaz storage blob generate-sasandaz storage container generate-sas(used with--auth-mode loginand--as-user); add preview--as-userand--user-delegation-oidforaz storage share generate-sas,az storage file generate-sas, andaz storage queue generate-sas(requirements:--auth-mode login,--expiry, and--user-delegation-oidrequires--as-user); add new commandaz storage fs file generate-sas(supports--as-userand preview--user-delegation-oid); behavior change: when a SAS token containssduoid=and--auth-mode loginprovides a token credential, client factories prefer the OAuth token credential and append the SAS to the service URL; Storage module switches fromazure-multiapi-storageto Track 2 packages and removes explicitmin_apigating on severalaz storagecommand groups. - Azure CLI MySQL Flexible Server backups:
az mysql flexible-server backup deleteis present (deletes an on-demand backup by--backup-name/-bfor a given server--name/-nand resource group--resource-group/-g); breaking:az mysql flexible-server backup showrequires explicit--resource-group/-gand--name/-nplus--backup-name/-b, and its--backup-name/-bwiring as the child resource name may affect usage with--ids/ resource ID composition and scripts relying on prior ID-part parsing/inference; MySQL Flexible Server commands emit a deprecation warning for--storage-redundancyoncreate,restore,geo-restore, andreplica create;az mysqlexternal migration--versionvalidation now lists8.4as an allowed value (in addition to5.7and8.0.21). - Azure CLI adds a new preview command
az cognitiveservices agent create(Azure AI Foundry hosted agents) to create an agent version from either an existing container image (--image) or by building and pushing from local source (--source), with built-in examples; parameters/flags include--image(must include a tag; tag becomes the agent version),--source,--registry,--dockerfile,--build-remote,--cpu,--memory,--env/--environment-variables(space-separatedkey=value),--protocol(responses|streaming),--protocol-version,--min-replicas,--max-replicas,--timeout,--no-wait,--no-start, and--skip-acr-check; validation/enforced rules:--imageand--sourcemutually exclusive and one required,--build-remoterequires--source,--registryrequired with--source,--no-startcannot be used with--min-replicas/--max-replicas,--memorymust matchN[.N]Gi|Mi,--cpumust be a positive number, env vars split on first=; ACR integration: local Docker build targetslinux/amd64and pushes to ACR (timeoutsAZURE_CLI_DOCKER_BUILD_TIMEOUT/AZURE_CLI_DOCKER_PUSH_TIMEOUT),--sourceauto-tags with a timestamp-based version, falls back to remote ACR Task builds (may use buildpacks when no Dockerfile), includes an ACR access pre-check for the project managed identity (guided remediation viaaz role assignment create, bypassable with--skip-acr-check); default workflow auto-deploys unless--no-start, waits up to--timeout(default 600s) with progress reporting, and--no-waitreturns immediately with “InProgress” and instructs usingaz cognitiveservices agent show. - Azure CLI az command reference adds new in-command examples for
az netappfiles check-file-path-availabilityandaz netappfiles check-name-availability, and adds new in-command examples foraz netappfiles volume replicationexternal replication/migration workflows:authorize-external-replication,finalize-external-replication,peer-external-cluster(including--peer-ip-addressesarray syntax), andperform-replication-transfer. - Azure CLI 2.82.0 release documentation: update Azure CLI / azure-cli-core version references to
2.82.0; azure-cli-core 2.82.0 notes resolution of CVE-2025-66418 and CVE-2025-66471; packaging/installation note: Windows MSI distribution pinspywin32to310to resolve MSI upgrade issues.
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 release notes entry for the version where the change shipped (within the provided 2.81.0–2.82.0 window), under the Network section, add a [BREAKING CHANGE] note stating that
az network virtual-appliance createandaz network virtual-appliance updaterenamed the parameter--internet-ingress-public-ipsto--internet-ingress-ips, because scripts using the old flag will fail.
- In the release notes entry for the version where the change shipped (within the provided 2.81.0–2.82.0 window), under the Network section, add a [BREAKING CHANGE] note stating that
- docs-ref-conceptual/Latest-version/release-notes-azure-cli.md:
- In the "January 13, 2026 – Version 2.82.0" section (RDBMS/PostgreSQL area), add the breaking/default behavior change that
az postgres flexible-servercommands that create resources now default--locationtocanadacentralwhen--locationis omitted (previouslyeastus), because users following the release notes to assess impact would otherwise be unaware of the region change. - In the "January 13, 2026 – Version 2.82.0" section (RDBMS/PostgreSQL area), add the breaking change that
az postgres flexible-server migration deletenow performs the migration cancel operation (cancels an active migration) rather than deleting a migration resource, because a user invoking it after upgrading could take the wrong action based on prior semantics. - In the "January 13, 2026 – Version 2.82.0" section (RDBMS/PostgreSQL area), add that
az postgres flexible-server advanced-threat-protection-setting shownow reads from the PostgreSQL Flexible Server AdvancedThreatProtectionSettings ARM API (viaazure-mgmt-postgresqlflexibleservers2.0.0 / API version2025-08-01), since users comparing outputs/behavior across versions could otherwise be misled about the backing API and returned shape.
- In the "January 13, 2026 – Version 2.82.0" section (RDBMS/PostgreSQL area), add the breaking/default behavior change that
- docs-ref-conceptual/Latest-version/release-notes-azure-cli.md:
- In the January 13, 2026 – Version 2.82.0 section under RDBMS / PostgreSQL, add a breaking-change note for
az postgres flexible-server replica promotestating that the read-replica identifier parameter changed from--server-name/-sto--name/-n(otherwise users following prior scripts/knowledge will get argument errors). - In the January 13, 2026 – Version 2.82.0 section under RDBMS / PostgreSQL (near the migration-related bullets), add a breaking-change note for
az postgres flexible-server migration {create|show|list|update|check-name-availability}stating that the target server parameter changed from--name/-nto--server-name/-s(otherwise users will invoke migration commands with the wrong parameter and the command will fail).
- In the January 13, 2026 – Version 2.82.0 section under RDBMS / PostgreSQL, add a breaking-change note for
- docs-ref-conceptual/Latest-version/release-notes-azure-cli.md:
- In the January 13, 2026 – Version 2.82.0 section under RDBMS/PostgreSQL, add an entry calling out the breaking change for
az postgres flexible-server replica promote: the replica identifier parameter changed from--server-name/-sto--name/-n(so scripts using--server-namewill fail). - In the January 13, 2026 – Version 2.82.0 section under RDBMS/PostgreSQL, add an entry calling out the breaking change for
az postgres flexible-server migration {create|show|list|update|check-name-availability}: the target server parameter changed from--name/-nto--server-name/-s(so scripts using--namefor the server will fail).
- In the January 13, 2026 – Version 2.82.0 section under RDBMS/PostgreSQL, add an entry calling out the breaking change for
- docs-ref-conceptual/Latest-version/release-notes-azure-cli.md:
- In the January 13, 2026 – Version 2.82.0 section, add a Maps subsection that documents the breaking removal of the
az maps creatorcommand group and the changed defaults/behavior foraz maps account create(default--kind Gen2, default--location eastusinstead ofglobal, and the supported--location/-lbehavior including resource-group location defaulting). Without this, users following the release notes may form an incorrect understanding of available commands and defaults in 2.82.0.
- In the January 13, 2026 – Version 2.82.0 section, add a Maps subsection that documents the breaking removal of the
- docs-ref-conceptual/Latest-version/release-notes-azure-cli.md:
- In the January 13, 2026 (Version 2.82.0) > MySQL section, add the missing breaking change note for
az mysql flexible-server backup show: it now requires explicit--resource-group/-gand--name/-nplus--backup-name/-b, and its--backup-namechild-resource naming affects--idsusage/resource ID composition, which can break scripts that previously relied on implicit parsing/inference.
- In the January 13, 2026 (Version 2.82.0) > MySQL section, add the missing breaking change note for
📚 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.