Azure / Azure/typespec-azure

[Automated][azure-resource-manager][skip chg] Document promoted ARM lint rules

Open
#5,417 0 comments 0 reactions 1 assignee Claimed by @catalinaperalta View on GitHub
agentic-workflows docs lib:azure-resource-manager triaged:core
Dominant language
TypeScript
Stars
27
Forks
90
Avg merge
1d 22h
Merged PRs (30d)
156

Description

Updates the ARM rule evaluation and RPC coverage guides for the newly promoted collection, paging, query-parameter, and content-type lint rules. Clarifies partial RPC031 coverage and records durable updater knowledge about rule behavior and resource identity resolution.

Documentation-only change; no package changelog is required.

Validation: ARM package build, documentation regeneration, formatting, and targeted rule tests (103 passing).

> Generated by [Documentation Update Agent](https://github.com/Azure/typespec-azure/actions/runs/34104710156) · gpt56 · 230.7 AIC · ⌖ 168 AIC · ⊞ 25.2K · [◷](https://github.com/search?q=repo%3AAzure%2Ftypespec-azure+%22gh-aw-workflow-id%3A+doc-update%22&type=pullrequests)

---

> [!NOTE]
> This was originally intended as a pull request, but GitHub Actions is not permitted to create or approve pull requests in this repository.
> The changes have been pushed to branch `automated/arm-doc-rules-20260907-5a43632acbeaa275`.
>
> **[Click here to create the pull request](https://github.com/Azure/typespec-azure/compare/main...automated/arm-doc-rules-20260907-5a43632acbeaa275?expand=1&title=%5BAutomated%5D%5Bazure-resource-manager%5D%5Bskip%20chg%5D%20Document%20promoted%20ARM%20lint%20rules)**

To fix the permissions issue, go to **Settings** → **Actions** → **General** and enable **Allow GitHub Actions to create and approve pull requests**. See also: [gh-aw FAQ](https://github.github.com/gh-aw/reference/faq/#why-is-my-create-pull-request-workflow-failing-with-github-actions-is-not-permitted-to-create-or-approve-pull-requests)

Show patch preview (166 of 166 lines)

```diff
From f70b5c0c93ac7e2126ea7446fe752354e6cf5b9c Mon Sep 17 00:00:00 2001
X-GH-AW-Base-Commit: dff7a58dc2efb0770155a212d29cf7d177c3b3d4
From: "github-actions[bot]"
Date: Mon, 7 Sep 2026 09:59:43 +0000
Subject: [PATCH] docs(arm): document promoted lint rules

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---
.../knowledge/azure-resource-manager.md | 20 +++++++++
.../azure-resource-manager.meta.json | 4 +-
.../content/docs/docs/howtos/ARM/arm-rules.md | 5 +++
.../howtos/ARM/rpc-guidelines-coverage.md | 41 +++++++++++--------
4 files changed, 50 insertions(+), 20 deletions(-)

diff --git a/eng/scripts/doc-updater/knowledge/azure-resource-manager.md b/eng/scripts/doc-updater/knowledge/azure-resource-manager.md
index 601aef43d..3eda04fbd 100644
--- a/eng/scripts/doc-updater/knowledge/azure-resource-manager.md
+++ b/eng/scripts/doc-updater/knowledge/azure-resource-manager.md
@@ -155,3 +155,23 @@ The former multi-purpose `arm-resource-operation` checks are represented by thre
## Resource Identity Resolution

Concrete ARM resource identities are seeded only by registered read or createOrUpdate operations with valid ARM resource instance paths. List, action, update, delete, and check-existence operations can attach to an existing resolved resource but do not create resource identities by themselves.
+
+Identity paths are matched case-insensitively for literal segments and by position for variable segments. A createOrUpdate operation can establish a resource without a read operation; list-only and action-only operation sets cannot.
+
+## ARM Collection and Content-Type Rules
+
+- `no-query-in-collection` allows only the case-sensitive `api-version` and `$filter` query parameter names on collection GET operations.
+- `no-query-in-point-op` allows only `api-version` (case-insensitively) on GET, PUT, PATCH, and DELETE resource-instance paths.
+- `list-response-envelope` requires model
... (truncated)
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.