[Automated][azure-resource-manager] Update ARM documentation: fix deprecated APIs, doc comments, rule titles, and broken links by tadelesh · Pull Request #4353 · Azure/typespec-azure

tadelesh · 2026-04-29T05:42:49Z

Resolve: #4351

@dev

- private-links-ref.tsp: Fix 'Properties of he private' -> 'Properties of the private' - nsp-operations.tsp: Fix @dev 'GET' -> 'Perform an action on' for Action/ActionAsync (POST ops) - arm.foundations.tsp: Remove ghost @template RequestBody tag not in op signature - private-endpoints.tsp: Fix '{name PrivateEndpointConnection}' -> '{name} PrivateEndpointConnection' - extension/operations.tsp: Fix truncated 'being rea' -> 'being read' Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

…in ARM resource-type guide - Replace deprecated envelope property spreads (ResourceSku → ResourceSkuProperty, EntityTag → EntityTagProperty, ResourcePlan → ResourcePlanProperty, ResourceKind → ResourceKindProperty, ManagedBy → ManagedByProperty) - Replace deprecated ManagedIdentity spreads (ManagedServiceIdentity → ManagedServiceIdentityProperty, ManagedSystemAssignedIdentity → ManagedSystemAssignedIdentityProperty) - Replace manual name definitions (@segment/@key/@visibility/@path/name) with ...ResourceNameParameter<ModelName> across all code examples - Update decorator explanation bullets to describe ResourceNameParameter - Fix broken sample links (DynaTrace, tenant, singleton, OperationTemplates) - Fix typos: enevelope→envelope, SUpport→Support, defintion→definition - Fix copy-paste error: 'Tenant resources' → 'Subscription-based resources' in the Subscription-based Resource section Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

…ate reference docs - Fix rule doc frontmatter titles to match registered rule names (arm- prefix) - Fix no-response-body.md title (was no-empty-model) - Fix unsupported-type.md title and namespace - Update step03/step05 to use ResourceNameParameter - Fix add-common-types.md link to correct repository - Regenerate reference docs (picked up TSP doc comment fixes) - Format all changed files Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

azure-sdk · 2026-04-29T05:45:44Z

All changed packages have been documented.

✅ @azure-tools/typespec-azure-resource-manager

Show changes

`@azure-tools/typespec-azure-resource-manager` - internal ✏️

Fix doc comment typos and inaccuracies in .tsp files

tadelesh

@copilot Resolve comments and check other changes to fix similar problem.

pkg-pr-new · 2026-04-29T05:50:50Z

Open in StackBlitz

npm i https://pkg.pr.new/@azure-tools/typespec-azure-resource-manager@4353

commit: b4ee06c

…Name in docs Agent-Logs-Url: https://github.com/Azure/typespec-azure/sessions/d1295f52-9d33-4fe2-9d05-522e64206687 Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>

Copilot · 2026-04-29T05:52:27Z

@copilot Resolve comments and check other changes to fix similar problem.

Done in 36d5207. Applied the explicit KeyName and SegmentName parameters to all ResourceNameParameter calls throughout the file, including the Extension Resource, Location-based Resource, Singleton Resource, and all the envelope property examples (Managed Identity, SKU, ETags, Plan, ResourceKind, ManagedBy).

azure-sdk · 2026-04-29T05:54:46Z

You can try these changes here

🛝 Playground	🌐 Website

tadelesh

@copilot Check all the changes and make sure all resolved the comments I mentioned.

…iption text with code examples Agent-Logs-Url: https://github.com/Azure/typespec-azure/sessions/f07275e3-c768-4ee7-bc81-2d703f197f8d Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>

Copilot · 2026-04-29T06:01:36Z

@copilot Check all the changes and make sure all resolved the comments I mentioned.

Done in 39a0674. All cases reviewed: removed redundant explicit KeyName/SegmentName from Employee model examples (defaults already match), and updated all description text lines to consolidate with the updated code examples.

tadelesh · 2026-04-29T06:20:03Z

@copilot Format the changes.

…ementResource example Agent-Logs-Url: https://github.com/Azure/typespec-azure/sessions/f289bb1a-020f-4798-82a4-01fb5813d67e Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>

Copilot · 2026-04-29T06:29:39Z

@copilot Format the changes.

Done in 100717b. Wrapped the long ResourceNameParameter<EmployeeAgreementResource, ...> template arguments in the TypeSpec code block to stay within the 100-character print width (the line was 125 chars).

tadelesh · 2026-05-11T02:04:45Z

@copilot Merge main with resolving the conflict and resolve all current comments.

…le arm- prefixes Agent-Logs-Url: https://github.com/Azure/typespec-azure/sessions/1ec75ac6-d511-4561-b1ea-f24c6853eb3c Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>

Copilot · 2026-05-11T02:12:39Z

@copilot Merge main with resolving the conflict and resolve all current comments.

Done in 34e3b15. Main was already merged in 496c823 (no conflicts). Addressed all of @markcowl's review comments: renamed example models to drop the Resource suffix, simplified ResourceNameParameter<> calls to just the model name, reverted the rule doc title arm- prefixes to match the markdown filenames, and added an anti-pattern note about the Resource suffix to the ARM knowledge base.

tadelesh · 2026-05-11T05:11:04Z

@copilot resolve the merge conflicts in this pull request

…entation-da9333c50271e2a1 # Conflicts: # website/src/content/docs/docs/libraries/azure-resource-manager/rules/delete-operation-response-codes.md # website/src/content/docs/docs/libraries/azure-resource-manager/rules/post-operation-response-codes.md # website/src/content/docs/docs/libraries/azure-resource-manager/rules/put-operation-response-codes.md # website/src/content/docs/docs/libraries/azure-resource-manager/rules/resource-name-pattern.md # website/src/content/docs/docs/libraries/azure-resource-manager/rules/unsupported-type.md Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>

Copilot · 2026-05-11T05:14:06Z

@copilot resolve the merge conflicts in this pull request

Done in b4ee06c. Merged origin/main and resolved conflicts in 5 ARM rule doc files (delete-/post-/put-operation-response-codes.md, resource-name-pattern.md, unsupported-type.md) — kept the frontmatter titles without the arm- prefix (per @markcowl's earlier review) and adopted main's title="Full name" code-fence formatting fix.

tadelesh · 2026-05-11T05:16:56Z

@markcowl Could you review again?

github-actions Bot and others added 4 commits April 29, 2026 05:03

Add changelog, knowledge base, and update meta

30c67a9

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

tadelesh requested review from bterlson, markcowl and timotheeguerin as code owners April 29, 2026 05:42

microsoft-github-policy-service Bot added eng lib:azure-resource-manager Issues for @azure-tools/typespec-azure-core library meta:website TypeSpec.io updates labels Apr 29, 2026

tadelesh commented Apr 29, 2026

View reviewed changes

Copilot started work on behalf of tadelesh April 29, 2026 05:47 View session

fix: update ResourceNameParameter to use explicit KeyName and Segment…

36d5207

…Name in docs Agent-Logs-Url: https://github.com/Azure/typespec-azure/sessions/d1295f52-9d33-4fe2-9d05-522e64206687 Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>

Copilot finished work on behalf of tadelesh April 29, 2026 05:53

tadelesh commented Apr 29, 2026

View reviewed changes

Comment thread website/src/content/docs/docs/howtos/ARM/resource-type.md Outdated

Comment thread website/src/content/docs/docs/howtos/ARM/resource-type.md Outdated

Copilot started work on behalf of tadelesh April 29, 2026 05:58 View session

fix: remove redundant explicit params for Employee, consolidate descr…

39a0674

…iption text with code examples Agent-Logs-Url: https://github.com/Azure/typespec-azure/sessions/f07275e3-c768-4ee7-bc81-2d703f197f8d Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>

Copilot finished work on behalf of tadelesh April 29, 2026 06:03

Copilot started work on behalf of tadelesh April 29, 2026 06:20 View session

format: wrap long ResourceNameParameter template args in EmployeeAgre…

100717b

…ementResource example Agent-Logs-Url: https://github.com/Azure/typespec-azure/sessions/f289bb1a-020f-4798-82a4-01fb5813d67e Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>

Copilot finished work on behalf of tadelesh April 29, 2026 06:31

Merge branch 'main' into docs/update-arm-documentation-da9333c50271e2a1

496c823

markcowl requested changes May 1, 2026

View reviewed changes

Copilot started work on behalf of tadelesh May 11, 2026 02:04 View session

docs: remove Resource suffix from example models, revert rule doc tit…

34e3b15

…le arm- prefixes Agent-Logs-Url: https://github.com/Azure/typespec-azure/sessions/1ec75ac6-d511-4561-b1ea-f24c6853eb3c Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>

Copilot finished work on behalf of tadelesh May 11, 2026 02:14

Copilot started work on behalf of tadelesh May 11, 2026 05:11 View session

Copilot finished work on behalf of tadelesh May 11, 2026 05:14

tadelesh requested a review from markcowl May 11, 2026 05:17

markcowl approved these changes May 12, 2026

View reviewed changes

tadelesh added this pull request to the merge queue May 12, 2026

Merged via the queue into main with commit 073d83d May 12, 2026
29 checks passed

tadelesh deleted the docs/update-arm-documentation-da9333c50271e2a1 branch May 12, 2026 02:43

Conversation

tadelesh commented Apr 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

azure-sdk commented Apr 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

@azure-tools/typespec-azure-resource-manager - internal ✏️

Uh oh!

tadelesh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pkg-pr-new Bot commented Apr 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI commented Apr 29, 2026

Uh oh!

azure-sdk commented Apr 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tadelesh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Apr 29, 2026

Uh oh!

tadelesh commented Apr 29, 2026

Uh oh!

Copilot AI commented Apr 29, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tadelesh commented May 11, 2026

Uh oh!

Copilot AI commented May 11, 2026

Uh oh!

tadelesh commented May 11, 2026

Uh oh!

Copilot AI commented May 11, 2026

Uh oh!

tadelesh commented May 11, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

tadelesh commented Apr 29, 2026 •

edited

Loading

azure-sdk commented Apr 29, 2026 •

edited

Loading

`@azure-tools/typespec-azure-resource-manager` - internal ✏️

pkg-pr-new Bot commented Apr 29, 2026 •

edited

Loading

azure-sdk commented Apr 29, 2026 •

edited

Loading