-
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.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
- Azure CLI
az network application-gateway settings createandaz network application-gateway settings updatenow support Application Gateway backend settingsenableL4ClientIpPreservationvia the new--enable-l4-client-ipboolean flag (help indicates defaultfalse); this property may now also appear inaz network application-gateway settings show/listoutput. - Azure CLI
az network application-gateway probe createandaz network application-gateway probe updatenow support Application Gateway probeenableProbeProxyProtocolHeadervia the new--enable-proxy-headerboolean flag (help indicates defaultfalse); this property may now also appear inaz network application-gateway probe show/listoutput. - Azure CLI
az network application-gateway probe/*andaz network application-gateway settings/*AAZ commands moved from ARM Networkapi-version2023-11-01to2025-01-01; any az command reference content that mentions supported fields/behavior for these commands should align with the newer API version. - Azure CLI help content for
az network application-gateway probe delete/list/showandaz network application-gateway settings delete/list/showremoved inline:example:blocks from command docstrings, which may reduce/remove examples shown inaz ... -hand downstream az command reference generation. - Azure CLI adds new preview command groups for Azure Cosmos DB Fleet management in the az command reference:
az cosmosdb fleet(create/list/show/delete),az cosmosdb fleetspace(create/update/list/show/delete), andaz cosmosdb fleetspace account(create/list/show/delete), including new help entries incosmosdb/_help.pyand examples forcreate/updatecommands. - Azure CLI
az cosmosdb fleetspace create|updateintroduces a required--body/-bJSON (string or@file) with documented schema expectations (properties.throughputPoolConfiguration.minThroughput|maxThroughput; create requiresproperties.serviceTierandproperties.dataRegions), enforced by new validation errors; this affects how users must construct request payloads in scripts and docs. - Azure CLI
az cosmosdb fleetspace account createintroduces a required--body/-bJSON (string or@file) requiringproperties.globalDatabaseAccountProperties.resourceId(ARM ID) andarmLocation, with new validation errors that should be reflected in az command reference examples and parameter descriptions. - Azure CLI
az cosmosdb create/az cosmosdb updateadds new command parameters/flags--enable-pbeand--default-priority-level(Cosmos DB request priority behavior), which should be documented under the Cosmos DB account create/update parameters. - Azure CLI
az cosmosdb createandaz cosmosdb updateadd a new--disable-local-auth {true|false}(three-state) parameter to disable key-based authentication on the Cosmos DB account (data plane), effectively enforcing Microsoft Entra ID as the only authentication method when set totrue; update theaz command referencefor these commands/parameters and clarify how this differs from--disable-key-based-metadata-write-access(control plane metadata writes). - Azure CLI
az cosmosdb restoreadds--source-backup-location, and the--locationhelp text clarifies it is the target write region and the default backup location unless--source-backup-locationis provided;--source-backup-locationis no longer marked as preview in help/parameter metadata, and specifying--source-backup-locationnow takes effect for cross-region restore by being applied torestoreParameters.sourceBackupLocation. - Azure CLI
az acr loginnow always/enforces acquiring the AAD access token using the Azure Container Registry audience/scopehttps://containerregistry.azure.net, which may change documented authentication behavior and troubleshooting guidance foraz acr logintoken acquisition. - Azure CLI
az postgres flexible-server fabric-mirroringcommands (start,stop,update-databases) now allow Fabric mirroring on Azure Database for PostgreSQL Flexible Server instances with High Availability enabled when the PostgreSQL version is 17 or 18; update the az command reference to remove/qualify the prior limitation (“not supported on servers with high availability enabled”) for PG 17+. - Azure CLI
az postgres flexible-server updateHigh Availability workflow: when HA is enabled, the CLI no longer performs the Fabric mirroring configuration check for PostgreSQL versions 17 and 18 (in addition to 11/12), which may affect documented behavior around update-time validation/guardrails for Fabric mirroring settings on HA servers. - Azure CLI
az appservice list-locationsadds a new preview flag--managed-instance-enabledto filter regions that support Azure App Service Managed Instance workers (intended to help identify regions where Managed Instance plans are available), andaz appservice list-locations --managed-instance-enabledonly returns results for Managed Instance-supported SKU tiers (PremiumV4,PremiummV4); for other SKUs (for exampleS1) the command returns an empty list (document as SKU requirement/validation behavior for the new flag). - Azure CLI
az vmss get-instance-viewis migrated to an AAZ-based implementation that calls the Compute RESTinstanceViewendpoints withapi-version=2024-11-01; the command’s JSON output shape/fields (and error formatting) may differ from the previous Track-2 SDK-backed implementation, soaz vmss get-instance-viewoutput examples in the az command reference may need refresh. - Azure CLI
az vmss get-instance-view --instance-id '*'now retrieves per-VM instance views via the AAZaz vmss list-instancesbackend (--select instanceView --expand instanceView) and returns a list of each VM’sinstanceViewpayload (which may includenullentries), which can affect scripts relying on the previous output behavior for the wildcard--instance-idcase. - Azure CLI added a new Compute command
az vmss get-resiliency-viewto return the resiliency status for a specific VM Scale Set instance (uses--instancefor the instance ID and-n/--namefor the VMSS name; the command forces the underlyingexpandtoresiliencyView, so--expandisn’t exposed for this command). - Azure CLI updated
az vmss list-instanceswith a new flag--resiliency-viewto show resiliency status per instance (changes the command’s output from a simple VM instance list to per-instance resiliency-view results). - Azure CLI
az vmss list-instancescommand reference/help content was expanded/clarified (new help entry, including guidance that for VMSS Flexible Orchestration mode users should useaz vm listfor full details) and now documents additional parameters including--max-itemsand--next-tokenfor pagination. - Azure CLI
az postgres flexible-server createandaz postgres flexible-server updateadd--zonal-resiliency {Enabled,Disabled}(defaultDisabledon create) as the new way to enable/disable the PostgreSQL flexible server high availability feature; help examples were updated to use--zonal-resiliency Enabledinstead of--high-availability ZoneRedundant. - Azure CLI
az postgres flexible-server create/updateadd--allow-same-zone(boolean) to allow primary and standby in the same zone when multi-zone capacity is unavailable; newaz postgres flexible-server createexample documents this “same zone” behavior. - Azure CLI
az postgres flexible-server create/updatedeprecate--high-availabilityand redirect users to--zonal-resiliency(deprecation warning emitted); using--high-availabilitytogether with--zonal-resiliencynow fails validation (“Setting both … is not allowed”). - Azure CLI behavior change for PostgreSQL flexible server high availability validation: in single-availability-zone regions,
--zonal-resiliency Enablednow requires--allow-same-zone(otherwise the command errors);--allow-same-zoneis only permitted when--zonal-resiliency Enabledis set. - Azure CLI
az postgres flexible-server createandaz postgres flexible-server update: removed the validator that blocked--high-availabilitywhen--storage-type PremiumV2_LRS(Premium SSD v2) is used, so the az command reference and parameter docs for--high-availabilityshould no longer imply it’s unsupported with Premium SSD v2. - Azure CLI
az postgres flexible-server update: fixed high availability enablement with--zonal-resiliency Enabled --standby-zone <zone>so the command no longer fails with(InvalidParameterValue) ... StandbyAvailabilityZone,availabilityZoneduring update (the update request now preserves the server’s existingavailabilityZone, and validation now allows--standby-zonewhen either zonal resiliency is enabled or HA is zone-redundant). - Breaking: Azure CLI
az postgres flexible-server createnow defaults the PostgreSQL Flexible Server--locationtocanadacentral(previouslyeastus) when no location is provided; any docs/examples that rely on the implicit default region should be updated. - Azure CLI
az postgres flexible-server migration deletenow calls the PostgreSQL Flexible Server migration cancel operation (SDKcancel(...)) instead of a delete operation; docs for the migration workflow should clarify that “delete” cancels an in-progress migration rather than removing a migration resource in the previous sense. - Azure CLI
az postgres flexible-server upgradenow supports upgrading to PostgreSQL major version 18 via the--version/-vparameter (enum expanded to include18), and help examples for PostgreSQL Flexible Server were updated to use PostgreSQL 18 (e.g.,az postgres flexible-server create --version 18andaz postgres flexible-server upgrade ... -v 18). - Azure CLI (
az command reference): The followingaz postgres flexible-server ... listcommands now support the global--idsargument, allowing you to pass the Azure resource ID of the Postgres flexible server instead of specifying--resource-group/--server-nameseparately:az postgres flexible-server backup list,db list,firewall-rule list,identity list,long-term-retention list,microsoft-entra-admin list,migration list,parameter list,replica list. - Azure CLI (
az postgres flexible-server replica promote): The--name/-nparameter is now explicitly treated/documented as the read replica name (including updated help/error semantics), aligning the command reference with promoting a replica server rather than a generic server name. - Breaking: Azure CLI
az postgres flexible-server replica createadds--name/-nas the preferred parameter for the read replica server name, deprecating--replica-name(help/examples updated to use--name; command now errors if neither--namenor--replica-nameis provided). - Azure CLI breaking-change announcements added for upcoming (Azure CLI 2.86.0, May 2026) parameter deprecations/repurposing in the
az postgres flexible-servercommand groupsbackup,db,firewall-rule,long-term-retention, andmigration(e.g.,--backup-name,--database-name,--rule-name,--migration-namedeprecated;--nameto be repurposed for the child object name;--server-nameto be introduced where needed). - Breaking: Azure CLI
az postgres flexible-server index-tuningcommand group is now deprecated and redirected toaz postgres flexible-server autonomous-tuning(via CLI breaking-change/deprecation messaging); update az command reference and any docs that instruct usingindex-tuningto point to the new command group. - Azure CLI adds new command group
az postgres flexible-server autonomous-tuningwith new commands and help content:update(new required--enabled {True|False}),show,list-settings,show-settings --name,set-settings --name --value,list-index-recommendations --recommendation-type {CreateIndex,DropIndex,ReIndex}, andlist-table-recommendations --recommendation-type {AnalyzeTable,VacuumTable}; document the new workflows and parameters in the az command reference. - Azure CLI
az postgres flexible-server index-tuning list-recommendationsnow maps to a renamed implementation and expands--recommendation-typeto includeReIndex; update command parameter docs/examples that enumerate allowed values. - Behavior-only (Azure CLI / PostgreSQL Flexible Server): enabling
az postgres flexible-server autonomous-tuning update --enabled Truechecks regional capability support and may auto-adjust Query Store capture mode (pg_qs.query_capture_mode) when enabling tuning; document these prerequisites/side effects under CLI authentication and configuration / command behavior notes if current docs imply no additional configuration changes. - Breaking: Azure CLI
az postgres flexible-server createchanges the default for--database-name/-dtoNone(no default database name), and--database-name/-dis now documented/enforced as only applicable when--cluster-option ElasticCluster; using--database-namewith other--cluster-optionvalues now fails validation with anArgumentUsageError(updateaz command referenceparameter rules/examples accordingly). - Azure CLI
az sql mi createandaz sql mi update(Azure SQL Managed Instance) add a new--memoryparameter to set memory size in gigabytes (GB) (memorySizeInGb/memory_size_in_gb), including new examples inaz sql mihelp/command reference. - Azure CLI
az sql mi updatebehavior change: the command now explicitly clearsrequested_logical_availability_zone(sets it tonull) during updates to avoid request failures caused by the previous default value (NoPreference), which may change outcomes for documented “availability zone”/zone preference behavior inaz sql mi update. - Azure CLI adds a new command
az mysql flexible-server backup deleteto delete an on-demand backup by--backup-name/-bfor a given flexible server (includes newazhelp entry and example inmysql/_help.py). - Azure CLI updates
az mysql flexible-server backup showto accept--resource-group/-gand server name (-n/--name) as explicit parameters, andaz mysql flexible-server backup showparameter metadata treats--backup-name/-bas an Azure resource ID child segment (id_part='child_name_1'), which may affect documented--idsusage patterns for the command. - Azure CLI (MySQL) marks
--storage-redundancyas deprecated foraz mysql flexible-server create,az mysql flexible-server restore,az mysql flexible-server geo-restore, andaz mysql flexible-server replica create(new deprecation warnings viaregister_argument_deprecate), so command reference docs should reflect the deprecation status. - Azure CLI
az mysqlexternal migration flow updates the--versionvalidation/error message to include MySQL server version8.4as an allowed value when--versionis required for external migrations (now:5.7,8.0.21,8.4). - Azure CLI
az network virtual-appliance createandaz network virtual-appliance updateadd a new command parameter--interface-configs/--nva-interface-configurations(max 3 items) to configure NVA in VNet interface configurations, supporting fields likename(max 70 chars),subnet.id(subnet resource ID), andtype(e.g.,PrivateNic,PublicNic,AdditionalPrivateNic,AdditionalPublicNic). - Azure CLI
az network virtual-appliance showandaz network virtual-appliance listnow surfaceproperties.nvaInterfaceConfigurationsandproperties.privateIpAddressin the command output (JSON), which may require updates to theazcommand reference/output examples for Network Virtual Appliance. - Azure CLI adds a new command group
az network virtual-appliance identitywith newazcommands:assign,remove,show, andwaitto manage managed identities for a Network Virtual Appliance;assign/removesupport--system-assignedand--user-assignedand honor--no-wait. - Azure CLI
az network virtual-appliance create/updateupdates the--identityobject-style parameters to include nested managed identity inputs (system-assigned/mi-system-assignedanduser-assigned/mi-user-assigned) alongside existing identity fields, which may affect documented parameter syntax and examples for configuring Network Virtual Appliance identity. - Azure CLI
az network watcher flow-log createandaz network watcher flow-log updatenow support a new--record-typesparameter (comma-separated combinations ofB,C,E,D) to filter Flow Log records by flow state; if omitted, the command behavior remains “log all traffic” (updateaz command reference/parameter docs for Network Watcher Flow Logs). - Azure CLI
az network watcher flow-log show(andaz network watcher flow-log waitoutput) now includes therecordTypesfield in the returned Flow Log properties when present, which may require updating any documented JSON/output examples for these commands. - Azure CLI
az network watcher flow-log createidentity configuration surface was extended under--identityto includesystem-assigned/mi-system-assignedanduser-assigned/mi-user-assignedinputs, andaz network watcher flow-log show/waitnow return a structuredidentityobject (includingprincipalId,tenantId, anduserAssignedIdentities), which may require updating identity-related guidance/examples in theaz network watcher flow-logcommand reference. - Azure CLI adds a new command group
az monitor dashboardto manage Dashboard with Grafana (Azure resource providerMicrosoft.Dashboard/dashboards) resources, includingaz monitor dashboard create(PUT; idempotent create-or-update) with required--resource-group,--dashboard-name/--name (-n), and--location(optional--tags, supports--no-wait), plusshow,list(requires--resource-group, supports pagination),delete(confirmation prompt), andwait;--dashboard-nameenforces a specific validation pattern and targets the2025-09-01-previewmanagement-plane API version. - Azure CLI
az containerapp env createadds a new parameter--infrastructure-resource-group(-i) to specify the name of the infrastructure resource group for the managed environment; if omitted, the Azure CLI behavior remains to auto-generate the infrastructure resource group name, and--infrastructure-resource-group(-i) can only be used when--infrastructure-subnet-resource-id(-s) and--enable-workload-profiles(-w) are also provided (otherwise the command returns a required-argument error). - Azure CLI
az containerapp compose createnow depends onpycomposefile>=0.0.34(was0.0.32), fixing a runtimeTypeErrorwhen a Docker Compose service usesenv_filewithout anenvironmentsection; update anyaz command reference/prerequisites text that mentions Compose parsing behavior or pinnedpycomposefileversions. - Azure CLI
az identity createadds a new--isolation-scopeparameter (enum:None,Regional) to set the User Assigned Managed IdentityisolationScopeproperty, restricting identity assignment within an Azure region; updateaz command referenceand examples accordingly. - Azure CLI
az identity updatecommand is added (generic update) and supports--tagsand the new--isolation-scopeparameter to modify a User Assigned Managed Identity’sisolationScope; add/updateaz command referenceforaz identity updateincluding usage and examples. - Behavior change: Azure CLI switches the default API version for Managed Identity (
ResourceType.MGMT_MSI) to2024-11-30, enablingisolationScopesupport foraz identity create/update; docs that mention supported properties/behavior foraz identitymay need to reflect the new API version-dependent capability. - Azure CLI
az aks install-cliadds a new--gh-tokenparameter (gh_token) to pass a GitHub authentication token when downloading kubelogin from GitHub releases, helping avoid GitHub API rate limiting; when--gh-tokenis provided, requests to GitHub release endpoints for kubelogin include anAuthorization: Bearer <token>header (affecting how kubelogin version resolution/download is performed). - Azure CLI
az aks nodepool updateadds a new--gpu-driverparameter (enum) to control AKS node pool GPU driver behavior, with documented possible values"Install"or"None"; update the az command reference/help and examples where GPU node pool driver management is described. - Azure CLI
az aks nodepool addandaz aks nodepool update:--os-skunow accepts the new Linux valueUbuntu2404(in addition to existing values likeUbuntu,Ubuntu2204,AzureLinux,AzureLinux3), so theazcommand reference/help for these commands should includeUbuntu2404as a supported OS SKU option. - Azure CLI
az keyvault key createandaz keyvault key importadd a new flag--default-data-disk-policy(alias--default-dd-policy) to set a default Key Release Policy for data disk encryption, alongside the existing--default-cvm-policy; mutual exclusivity is enforced between--policyand--default-data-disk-policy, and between--default-cvm-policyand--default-data-disk-policy(erroring if combined). - Azure CLI
az keyvaultcommand module now uses the TypeSpec-generated management SDK (azure-mgmt-keyvaultupgraded to 13.0.0), which may change runtime behavior (e.g., error shapes/messages or JSON output fields) for Key Vault management commands even though theaz keyvaultcommand/parameter surface is unchanged. - Azure CLI core JSON serialization (
azure.cli.core.util.todict) now usesazure-core’sget_backcompat_attr_name(requiring azure-core 1.37.0) to preserve backward-compatible attribute names when producing--output json/-o jsonfor Azure SDK model objects (notably relevant toaz keyvaultoutputs after the SDK migration). - Breaking: Azure CLI removes the
az maps creatorcommand group and its commands (az maps creator list/show/create/update/delete), including all associated parameters (for example,--creator-name,--storage-units,--location,--tags); the az command reference should be updated to reflect that these commands are no longer available. - Breaking: Azure CLI changes
az maps account createdefaults/constraints: the default SKU/kind is nowGen2(previouslyGen1), the account--location/-lis now supported onaz maps account createand defaults toeastus(previously effectively forced toglobal); update guidance and examples that mention deprecatedGen1orglobal. - Azure CLI
az network private-endpoint-connection(Private Link resource/provider registration) adds support for Azure Maps accounts via providerMicrosoft.Maps/accounts(API version2023-12-01-preview), enabling private endpoint connection workflows foraz mapsresources in the az command reference. - Azure CLI adds preview support for user delegation SAS for OAuth (
--auth-mode login) acrossaz storage blob generate-sas,az storage container generate-sas,az storage fs generate-sas,az storage fs directory generate-sas,az storage share generate-sas,az storage file generate-sas, andaz storage queue generate-sas, adding/expanding flags--as-user(requires--auth-mode loginand--expiry) and--user-delegation-oid(Entra ID object ID authorized to use the SAS); validation rules were updated so--user-delegation-oiderrors unless--as-useris also provided. - Azure CLI adds a new command
az storage fs file generate-sas(ADLS Gen2) to generate a SAS token for a specific file path (--file-system/-f,--path/-p, permissions/expiry/start, optional--full-uri), and it participates in the same preview user-delegation SAS flags/validation (--as-user,--user-delegation-oid) where applicable. - Azure CLI Storage client behavior changes when a user-delegation SAS token is provided (SAS contains
sduoid=) together with OAuth login: the CLI prefers the Entra ID token credential and appends the SAS query string to the Storage service URL (Blob/ADLS Gen2/Queue/File), and suppresses the usual “ignored in login auth mode” warning for credential args in this case—documentation may need to clarify how--sas-token+--auth-mode loginworks for user-delegation SAS. - Azure CLI
az netappfiles check-file-path-availabilitynow includes an:example:in command help/az command reference showing usage with--location,--name, and--subnet-id(as rendered from the AAZ command docstring). - Azure CLI
az netappfiles check-name-availabilitynow includes an:example:in command help/az command reference showing usage with--location,--name,--type, and--resource-group. - Azure CLI
az netappfiles volume replicationcommands now include new:example:entries in command help/az command reference for external replication/migration workflows:authorize-external-replication,finalize-external-replication,peer-external-cluster(including--peer-ip-addressesarray syntax), andperform-replication-transfer. - Azure CLI adds a new preview command
az cognitiveservices agent create(AI Foundry hosted agents) to create a hosted agent version from either a container image (--image) or local source (--source), including new az command reference help with end-to-end examples. az cognitiveservices agent createintroduces new/updated command parameters and rules that need documenting in the az command reference:--project-name/-p(and existing agent commands now accept--project-name/-p), required--name/-n, mutually exclusive--imagevs--source,--dockerfile,--registry,--build-remote,--cpu,--memory,--env/--environment-variables(space-separatedkey=value),--protocol(responses|streaming),--protocol-version,--description,--min-replicas,--max-replicas,--timeout,--no-wait,--no-start, and--skip-acr-check(bypasses managed-identity ACR access validation).az cognitiveservices agent createbehavior: when--sourceis used, Azure CLI builds and pushes a container image to Azure Container Registry (local Docker build/push when available; otherwise falls back to ACR Task remote build, or forced via--build-remote), and the CLI enforces that the resulting image URI includes a tag because the tag becomes the agent “version” in Azure AI Foundry.az cognitiveservices agent createdeployment workflow changes that should be documented: by default the CLI automatically starts a deployment after version creation and waits until it reaches “running” (configurable via--timeout);--no-startcreates the version without deploying (and cannot be combined with--min-replicas/--max-replicas);--no-waitreturns immediately with an “InProgress” status payload and instructs usingaz cognitiveservices agent showto check status.- Breaking: Azure CLI
az sig image-version createandaz sig image-version updatenow document pending default changes:--end-of-life-datewill default to “6 months from publish date” (instead of no default) and--block-deletion-before-end-of-lifewill default totrue(instead of no default); update theaz command referenceand examples that rely on unset values. - Azure CLI
az sig image-version create/az sig image-version updateadds a warning for Azure Compute Gallery resources when usingapi-version 2026-03-03; document the warning if it affects expected output/automation. - Azure CLI version bump to 2.82.0 (including azure-cli-core 2.82.0) in packaging metadata and requirements files; update any version-pinned install/upgrade documentation that references 2.81.0.
- Azure CLI security update: azure-cli-core 2.82.0 resolves CVE-2025-66418 and CVE-2025-66471; release notes/security guidance may need to reference these fixes for Azure CLI users.
- Azure CLI installation on Windows (MSI packaging): pinned the
pywin32dependency to version310(from311) to resolve an MSI upgrade issue, which may warrant updating Azure CLI Windows install/upgrade guidance or release notes if docs currently mention the affected upgrade behavior. az network application-gateway waf-policy managed-rule rule-setchanges behavior to support disabled rules by default; update docs if they implied prior defaults.
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-autogen/Latest-version/latest/appservice.yml:
- In the "--managed-instance-enabled" optional parameter description for
az appservice list-locations, add that this filter is only applicable to Managed Instance-capable SKUs (Premium v4 tiers, including memory-optimized v4). State that if a non-supported SKU is provided (for example S1), the command returns an empty list. - Add an example under "Examples" showing the intended usage with a Premium v4 SKU (for example
az appservice list-locations --sku P1V4 --managed-instance-enabled) to help users discover the correct SKU/flag combination. - In the
az appservice list-locationscommand summary/intro line, clarify that the returned regions are for the specified SKU and any applied worker capability filters (Hyper-V, Linux, Managed Instance). This helps set expectations that filters can further restrict results and may produce an empty list when the selected SKU doesn't support the requested worker type.
- In the "--managed-instance-enabled" optional parameter description for
- docs-ref-autogen/Latest-version/latest/vmss.yml:
- [Correction] Update the
az vmss get-instance-viewcommand description/parameter documentation for--instance-idto clarify that when--instance-id '*'is used, the command returns an array of instance views (one entry per VM) rather than a single instance view object. Explicitly note that some entries in the returned list can benulldepending on what the backend returns. - Add an example under
az vmss get-instance-viewthat demonstrates using--instance-id '*'and shows the expected JSON shape (list/array). Include a brief example of a JMESPath query pattern that safely handles potentialnullentries (for example, filtering out nulls before projecting fields) so scripts can be updated accordingly. - Review any wording that implies
az vmss get-instance-viewalways returns a single 'instance view' payload and adjust it to distinguish between single-instance usage (specific instance id or omitted--instance-id) and wildcard usage ('*'). This helps prevent users from assuming a stable output schema across these cases.
- [Correction] Update the
- docs-ref-conceptual/Latest-version/release-notes-azure-cli.md:
- In the v2.82.0 (January 13, 2026) > RDBMS section, add a release note entry explicitly stating that
az postgres flexible-server create/updatedeprecates--high-availabilityand redirects users to--zonal-resiliencyvia a deprecation warning. Clarify that users should switch to--zonal-resiliencyfor the same intent going forward. - In the same v2.82.0 > RDBMS section, add an entry noting the new validation behavior: specifying both
--high-availabilityand--zonal-resiliencytogether now fails with a validation error (mutually exclusive arguments). This is important because it can break scripts that include both flags. - Update the existing v2.82.0 > RDBMS bullet "Show high availability feature with zonal resiliency argument" to be more technically specific by referencing the exact parameters (
--high-availabilityand--zonal-resiliency) and the deprecation/mutual-exclusion behavior. This avoids having two separate, potentially ambiguous entries describing the same change.
- In the v2.82.0 (January 13, 2026) > RDBMS section, add a release note entry explicitly stating that
- docs-ref-conceptual/Latest-version/release-notes-azure-cli.md:
- In the January 13, 2026 (Version 2.82.0) > RDBMS section, add a release note entry explicitly stating that
az postgres flexible-server create/updatedeprecates--high-availabilityand that users should use--zonal-resiliencyinstead (including that a deprecation warning is emitted when--high-availabilityis used). - In the same RDBMS section for 2.82.0, add a release note entry stating that specifying both
--high-availabilityand--zonal-resiliencyin the samecreate/updatecommand is now rejected (validation error) and that the flags are mutually exclusive. - Refine the existing 2.82.0 bullet "
az postgres flexible-server create/update: Show high availability feature with zonal resiliency argument" to clearly convey the parameter transition (i.e.,--zonal-resiliencyis the intended replacement interface for the high availability/zonal resiliency configuration) rather than leaving the relationship ambiguous.
- In the January 13, 2026 (Version 2.82.0) > RDBMS section, add a release note entry explicitly stating that
- docs-ref-autogen/Latest-version/latest/postgres/flexible-server.yml:
- [Correction] In the
az postgres flexible-server createsection, update the--location -lparameter description to reflect the new implicit default behavior. Specify that when--locationis omitted (and no CLI default location is otherwise configured), the command will default tocanadacentral. - [Correction] Update the example titled "Create a PostgreSQL flexible server with default parameters..." that runs
az postgres flexible-server createwith no arguments. Add an explicit note in the example text that the server will be created incanadacentralunless--location(or an explicit CLI default location) is provided. - Add a short note near the
createexamples (or immediately under the command description) advising users to specify--locationexplicitly to avoid unintended regional deployments. This note should be scoped to thecreatecommand behavior and not expanded into general guidance beyond what’s necessary for correct usage.
- [Correction] In the
- docs-ref-autogen/Latest-version/latest/postgres/flexible-server.yml:
- [Correction] Update the
az postgres flexible-server migration deletecommand reference (the migration sub-group page/section) so the description and any explanatory text clearly state that the command cancels an in-progress migration (maps to the service cancel operation), rather than deleting/removing a migration resource. Remove or replace any wording that implies the migration object is deleted as a resource-management action. - In the
az postgres flexible-servertop-level command list, add the missing entry foraz postgres flexible-server migration deleteunder the migration command group, with a description aligned to the new behavior (for example, 'Cancel an in-progress migration'). This ensures the command inventory matches what users can run in current Azure CLI versions. - Where the migration workflow is described (within the migration command group content), add a short clarification that 'delete' in this context is used to cancel a running migration, and does not imply permanent removal of a historical migration record/resource. Ensure any examples or guidance that previously recommended 'delete' for cleanup are adjusted to describe cancellation semantics.
- [Correction] Update the
- docs-ref-autogen/Latest-version/latest/postgres/flexible-server.yml:
- [Correction] In the
az postgres flexible-servercommand list, update theindex-tuningentry to explicitly state that it is deprecated and redirects toaz postgres flexible-server autonomous-tuning(rather than implying it remains a separate functional group). This prevents users from relying onindex-tuningas the primary interface. - [Correction] On the
az postgres flexible-server index-tuningreference page (and its subcommand sections), add/adjust the deprecation messaging to indicate the command group is redirected and users should run the correspondingautonomous-tuningcommands instead. Where the redirected command names differ (for example,list-recommendationsvslist-index-recommendations), update the documented command names accordingly. - [Correction] Review any examples on this page that instruct users to run
az postgres flexible-server index-tuning ...and update them to useaz postgres flexible-server autonomous-tuning ...so the documented workflow matches the post-change CLI guidance and avoids deprecated syntax.
- [Correction] In the
- docs-ref-autogen/Latest-version/latest/postgres/flexible-server.yml:
- [Correction] In the "Commands" table on the
az postgres flexible-serverreference page, update theindex-tuningentry (and its subcommand entries) to reflect that the group is deprecated and redirected/aliased toaz postgres flexible-server autonomous-tuning. Ensure the table no longer impliesindex-tuningis the primary interface for tuning operations. - [Correction] Update the
az postgres flexible-server index-tuningreference page(s) (the linkedflexible-server/index-tuningand its subcommand sections) to explicitly state that calls are redirected toaz postgres flexible-server autonomous-tuningand that users should switch to theautonomous-tuningcommand group. If the CLI behavior is now an alias/redirect rather than an independently supported command group, adjust wording and structure to avoid documentingindex-tuningas a separate feature set. - [Correction] Review any examples or workflows in the PostgreSQL Flexible Server CLI docs that instruct users to run
az postgres flexible-server index-tuning ...and replace them with the correspondingaz postgres flexible-server autonomous-tuning ...commands. This prevents users from following deprecated guidance and seeing breaking-change/deprecation messaging in otherwise current walkthroughs.
- [Correction] In the "Commands" table on the
- docs-ref-conceptual/Latest-version/release-notes-azure-cli.md:
- [Correction] In the January 13, 2026 (Version 2.82.0) > RDBMS section, update the
az postgres flexible-server createentry about the database name defaulting toNoneto also state that--database-name/-dis now only applicable when--cluster-option ElasticClusterand that using it with other--cluster-optionvalues fails validation (for example, withArgumentUsageError). - In the same RDBMS section, add a brief breaking-change clarification indicating that this is a behavioral/validation change that may break scripts that always pass
--database-nameregardless of cluster mode. Keep this scoped to the CLI behavior and the affected command (az postgres flexible-server create). - Review the nearby 2.82.0 bullets
Add database name field for create with clusterandChange database name field to default to Noneforaz postgres flexible-server createand consolidate/clarify them so it’s explicit that the database name parameter is tied to Elastic Cluster creation scenarios, while non-cluster creation has no default database name from the CLI.
- [Correction] In the January 13, 2026 (Version 2.82.0) > RDBMS section, update the
- docs-ref-autogen/Latest-version/latest/postgres/flexible-server.yml:
- [Correction] In the
az postgres flexible-server createExamples section, update the description for the bareaz postgres flexible-server createexample that currently states a “default database will be created by CLI”. Remove or revise that claim to reflect that no default database name is chosen/created by default after the change to--database-namedefaulting toNone. - [Correction] In the
--database-name -dparameter description underaz postgres flexible-server create, ensure the documentation reflects that the parameter is only valid when--cluster-option ElasticClusterand that using--database-namewith other--cluster-optionvalues results in a CLI validation failure (for example,ArgumentUsageError). This prevents users from assuming it is merely ignored outside ElasticCluster. - [Correction] Where the CLI reference shows defaults for parameters (the Properties tables), update
--database-name/-dto indicate the default isNone(no default database name). This aligns the reference with the breaking change and avoids users relying on an implied default database being provisioned.
- [Correction] In the
- docs-ref-conceptual/Latest-version/release-notes-azure-cli.md:
- In the January 13, 2026 (Version 2.82.0) > Network section, add a release note entry for
az network virtual-appliance create/updatedescribing the--identityobject-style parameter update to support nested managed identity inputs (system-assigned/user-assignedand the correspondingmi-system-assigned/mi-user-assignedaliases). - If the change affects how existing identity configuration inputs are interpreted (for example, new nested keys alongside previous identity fields), briefly clarify in the same release note entry that this is a parameter/schema change that may require updating scripts that pass
--identityas an object.
- In the January 13, 2026 (Version 2.82.0) > Network section, add a release note entry for
- docs-ref-autogen/Latest-version/latest/network/watcher.yml:
- In the
az network watcher flow-log createcommand section, add--record-typesto the command syntax and to the Optional parameters list. Document that it accepts a comma-separated list of record type codes (combinations ofB,C,E,D) to filter flow log records by flow state. - In the
az network watcher flow-log updatecommand section, add--record-typesto the command syntax and to the Optional parameters list with the same accepted values (B,C,E,Din comma-separated combinations). Ensure the parameter description clearly indicates it controls which flow log record types are emitted. - For both
createandupdate, explicitly state the default behavior when--record-typesis omitted (that flow logs record all traffic / no filtering is applied). This prevents users from assuming filtering is mandatory or that the default behavior has changed.
- In the
- docs-ref-autogen/Latest-version/latest/containerapp.yml:
- In the
az containerapp env createcommand section, add--infrastructure-resource-group(-i) to the syntax block and the Optional Parameters list, with a description that it specifies the infrastructure resource group name for the managed environment. - In the
az containerapp env createparameter description for--infrastructure-resource-group, document the constraint that it can only be used when--infrastructure-subnet-resource-id(-s) and--enable-workload-profiles(-w) are also provided, and that otherwise the command fails due to missing required arguments. - In the
az containerapp env createdocumentation, clarify the default behavior when--infrastructure-resource-groupis omitted (the CLI auto-generates the infrastructure resource group name), so users understand that specifying it is optional and only needed to override the generated name.
- In the
- docs-ref-autogen/Latest-version/latest/storage/blob.yml:
- [Correction] In the
az storage blob generate-sassection, update the--user-delegation-oidparameter description to explicitly state that it can only be used with--as-user. Also note that attempting to pass--user-delegation-oidwithout--as-userwill fail validation. - In the
--as-userparameter description foraz storage blob generate-sas, add a short cross-reference that--user-delegation-oidis an optional companion flag that is only applicable when generating a user delegation SAS (that is, when--as-useris set). This aligns the parameter guidance with the CLI’s enforced behavior. - Add an example under
az storage blob generate-sasshowing generation of a user delegation SAS using--auth-mode login --as-user --expiry ...and optionally including--user-delegation-oid <object-id>. This prevents confusion about the required flag combination for OAuth-based user delegation SAS.
- [Correction] In the
- docs-ref-autogen/Latest-version/latest/storage/blob.yml:
- [Correction] Update the authentication guidance near the top of the
az storage blobpage that says users must specify one of--auth-mode,--account-key,--connection-string,--sas-token. Clarify that--auth-mode logincan be combined with--sas-tokenfor user-delegation SAS scenarios, rather than implying they are mutually exclusive. - In the common parameter documentation for
--sas-token(Storage Account Arguments) and/or--auth-mode, add a brief note describing the behavior when--sas-tokenis supplied with--auth-mode login: for user-delegation SAS (for example, SAS includessduoid=), Azure CLI uses the Entra ID token credential and attaches the SAS query string to the request URL. - Add an example under at least one representative command on this page (for example,
az storage blob showoraz storage blob delete) demonstrating--auth-mode loginused together with a user-delegation--sas-token, so users can see the intended syntax for this flow. - Where the page discusses
--blob-urlas including a SAS token, consider a short clarification that user-delegation SAS URLs are expected to be used alongside Entra ID authentication (login), aligning with the--user-delegation-oiddescription underaz storage blob generate-sasand reducing confusion about which credential actually authorizes the request.
- [Correction] Update the authentication guidance near the top of the
- docs-ref-autogen/Latest-version/latest/cognitiveservices/agent.yml:
- [Correction] Update the --image parameter description to align with the current versioning behavior. Remove/replace the statement implying AI Foundry manages agent version independently of the image tag, and instead state that the image tag is used as the agent version identifier for the hosted agent in Azure AI Foundry.
- In the --source parameter description (and/or the command description where --source is explained), add that the CLI requires the resulting pushed image URI to include a tag because that tag becomes the agent version in Azure AI Foundry. Make clear that tagless image references are not accepted for agent creation.
- In the "Create agent using short registry name" example section (or near the examples), add a brief note that specifying a tag is mandatory and that the tag maps to the agent version. This reinforces why all examples include tags and prevents users from attempting tagless image URIs.
- docs-ref-autogen/Latest-version/latest/cognitiveservices/agent.yml:
- In the
az cognitiveservices agent createreference section, add--no-waitto the command syntax and parameter list. Describe that--no-waitreturns immediately with anInProgressstatus response and that users should useaz cognitiveservices agent showto poll/check deployment status until it reachesrunning. - Update the
--timeoutparameter description to explicitly tie it to the default behavior: after version creation, the CLI automatically starts the deployment and waits for it to reachrunning(unless--no-waitis used). Ensure the wording makes it clear that--timeoutcontrols this wait and not only image pull/build time. - Add an example under
az cognitiveservices agent createdemonstrating asynchronous usage (for example, creating with--no-waitand then callingaz cognitiveservices agent showto check status). This ensures the new workflow is discoverable and prevents users from assuming the create command has fully completed deployment when it returns.
- In the
- docs-ref-autogen/Latest-version/latest/network/application-gateway/waf-policy/managed-rule/rule-set.yml:
- [Correction] In
az network application-gateway waf-policy managed-rule rule-set addand... rule-set update, revise the--ruleparameter description so it no longer states that the rule "will be disabled" unconditionally. Describe--ruleas configuring rule overrides (includingstate) and align the text with the behavior where rules may be disabled by default. - Add a brief note in the
addandupdatecommand sections clarifying the default rule state behavior (that managed rules can be disabled by default) and what happens when--group-nameis provided with no--rule. This should explicitly tell users how to achieve the opposite outcome (for example, enabling specific rules) when defaults start as Disabled. - Update or add an example that demonstrates setting rule state explicitly via
--rule ... state=...in addition to the existing 'Disable an attack protection rule' example. This ensures examples remain valid and useful when the default state is Disabled and users need to override state intentionally.
- [Correction] In
📚 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.