Skip to content

Clarify ARM operation-status guidance for brownfield contracts and non-drop-in status models #5422

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jiaqi Zhang (JiaqiZhang-Dev) merged 4 commits into from
Sep 11, 2026
Merged

Clarify ARM operation-status guidance for brownfield contracts and non-drop-in status models #5422

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b4e6636
Initial plan
Copilot Sep 8, 2026
d84adc4
Clarify ArmOperationStatus guidance for brownfield contracts
Copilot Sep 8, 2026
eb24d14
Refine ARM operation-status note wording per review
Copilot Sep 9, 2026
2d512c7
Use Starlight asides for ARM operation-status guidance notes
Copilot Sep 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions website/src/content/docs/docs/howtos/ARM/resource-operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,6 +416,13 @@ ARM long-running operations (LROs) use operation status endpoints to allow clien
status of an async operation. The `GetResourceOperationStatus` operation template provides a
standard way to expose these endpoints, and `ArmOperationStatus` provides the response model.

:::note
These templates can represent existing ARM operation-status endpoints. Use them when they
reproduce the existing wire contract; otherwise, preserve the contract with an explicit status
model. ARM's complete LRO polling flow, particularly `Azure-AsyncOperation`, is not yet
standardized enough for this to be blanket guidance for new APIs.
:::

### ArmOperationStatus

`ArmOperationStatus` is a response model that represents the status of an async operation. The `id`
Expand Down Expand Up @@ -471,6 +478,13 @@ interface OperationStatuses {

To add custom properties to the operation status response, use the `ArmOperationStatus` template:

:::caution
`ArmOperationStatus<Properties>` is not a literal drop-in for every converted custom model. If your
existing operation-status payload has extra top-level members (for example `operations` or
`resourceId`) or different wire semantics, keep or author an explicit status model that matches the
existing contract.
:::

```typespec
model WidgetOperationStatus is ArmOperationStatus<WidgetOperationStatusProperties>;

Expand Down
Loading