Update ARM extension resource documentation to use new Extension namespace templates#3960
Draft
Update ARM extension resource documentation to use new Extension namespace templates#3960
Conversation
…e templates Co-authored-by: markcowl <1054056+markcowl@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update how-to document on ARM resource types
Update ARM extension resource documentation to use new Extension namespace templates
Feb 21, 2026
markcowl
requested changes
Feb 24, 2026
| `@visibility(read)`: indicates that this property is returned in the body of responses to operations over this resource, but does not appear in the body of requests. Later sections describe the [usage of property visibility](#property-visibility-and-other-constraints). | ||
| `@path`: indicates that this property corresponds to the last segment of the url path to the resource (otherwise known as the resource identity). | ||
| `ExtensionResource<EmployeeProperties>`: defines the resource as an extension resource with the given properties. | ||
| `...ResourceNameParameter<Employee>`: spreads in the standard resource name parameter, automatically providing the `@segment`, `@key`, `@path`, and `@visibility` decorators. |
Member
There was a problem hiding this comment.
@copilot we shouldn't describe this by using the decorators included in the template, but rather by describing what they do - they define the resource type name, and details of the resource name parameter, including its name and the default pattern constraint for resource names.
Contributor
Author
There was a problem hiding this comment.
Updated in 5f514a1 to describe what ResourceNameParameter does — defines the resource type name, the name of the resource name parameter, and provides a default pattern constraint for resource names — rather than listing the decorators.
|
|
||
| #### Defining Operations with Scope Parameters | ||
|
|
||
| The `Extension` namespace provides operation templates that take a scope parameter, allowing you to define a single set of operations that can be reused across different target scopes. Define a parameterized interface for your operations: |
Member
There was a problem hiding this comment.
Suggested change
| The `Extension` namespace provides operation templates that take a scope parameter, allowing you to define a single set of operations that can be reused across different target scopes. Define a parameterized interface for your operations: | |
| The `Extension` namespace provides operation templates that take a scope parameter, allowing you to define a single set of operations that can be reused across different target scopes. Define a parameterized interface for your operations like this: |
| } | ||
| ``` | ||
|
|
||
| The available operation templates include: |
Member
There was a problem hiding this comment.
Suggested change
| The available operation templates include: | |
| The available operation templates in the Extension namespace include: |
| | Template | Description | | ||
| | -------------------------------- | --------------------------------------------- | | ||
| | `Extension.Read` | GET operation for the resource | | ||
| | `Extension.CreateOrReplaceAsync` | Asynchronous PUT operation | |
|
|
||
| | Scope | Description | | ||
| | --------------------------- | ------------------------------------- | | ||
| | `Extension.ScopeParameter` | Any scope (uses a generic scope path) | |
Member
There was a problem hiding this comment.
Suggested change
| | `Extension.ScopeParameter` | Any scope (uses a generic scope path) | | |
| | `Extension.ScopeParameter` | Any scope (uses a generic scope uri path) | |
Member
|
@copilot please apply the changes in the comments from my review |
Co-authored-by: markcowl <1054056+markcowl@users.noreply.github.com>
Contributor
Author
All five review changes were already applied in 5f514a1:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
website/src/content/docs/docs/howtos/ARM/resource-type.mdto:ExtensionResourcemodel definition withResourceNameParameterExtensionnamespace operation templates (Read, CreateOrReplaceAsync, CustomPatchSync, DeleteWithoutOkAsync, ListByTarget, ActionSync, etc.)ResourceNameParameterby what it does rather than which decorators it includesCreateOrReplaceAsyncas the recommended PUT operation💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.