Skip to content

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

Merged
Jiaqi Zhang (JiaqiZhang-Dev) merged 4 commits into
mainfrom
copilot/clarify-armoperationstatus-guidance
Sep 11, 2026
Merged

Clarify ARM operation-status guidance for brownfield contracts and non-drop-in status models#5422
Jiaqi Zhang (JiaqiZhang-Dev) merged 4 commits into
mainfrom
copilot/clarify-armoperationstatus-guidance

Conversation

Copilot AI commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

The issue was caused by docs implying ArmOperationStatus as blanket current guidance and a universal replacement for existing custom operation-status models. This update narrows the guidance to existing ARM wire-contract compatibility and clarifies where literal replacement is unsafe.

  • Scope correction: operation-status templates are contract-preservation guidance

    • Added an explicit note that operationStatuses / Azure-AsyncOperation patterns describe an existing ARM wire contract.
    • Clarified these templates should be used when preserving brownfield behavior, not as default direction for every new ARM API.
  • Drop-in caveat for converted custom models

    • Added a warning that ArmOperationStatus<Properties> is not a literal drop-in when legacy models carry extra top-level fields (e.g., operations, resourceId) or different wire semantics.
    • Directed authors to keep or define explicit status models when the existing contract diverges.
> **Note:** The `operationStatuses` and `Azure-AsyncOperation` patterns document an existing ARM wire
> contract ... Do not read this section as blanket guidance for every new ARM API design.

> **Warning:** `ArmOperationStatus<Properties>` is not a literal drop-in for every converted custom
> model ... keep or author an explicit status model that matches the existing contract.

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
1 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

Co-authored-by: jianingwang123 <141212663+jianingwang123@users.noreply.github.com>
@microsoft-github-policy-service microsoft-github-policy-service Bot added the meta:website TypeSpec.io updates label Sep 8, 2026
Copilot AI changed the title [WIP] Clarify ArmOperationStatus guidance for ARM operation-status contracts Clarify ARM operation-status guidance for brownfield contracts and non-drop-in status models Sep 8, 2026
Comment thread website/src/content/docs/docs/howtos/ARM/resource-operations.md Outdated
Co-authored-by: JiaqiZhang-Dev <194873822+JiaqiZhang-Dev@users.noreply.github.com>
@azure-sdk-automation

Copy link
Copy Markdown
Contributor

You can try these changes here

🛝 Playground 🌐 Website

Comment thread website/src/content/docs/docs/howtos/ARM/resource-operations.md Outdated
Co-authored-by: JiaqiZhang-Dev <194873822+JiaqiZhang-Dev@users.noreply.github.com>
@JiaqiZhang-Dev
Jiaqi Zhang (JiaqiZhang-Dev) added this pull request to the merge queue Sep 11, 2026
Merged via the queue into main with commit 5f993c0 Sep 11, 2026
37 checks passed
@JiaqiZhang-Dev
Jiaqi Zhang (JiaqiZhang-Dev) deleted the copilot/clarify-armoperationstatus-guidance branch September 11, 2026 02:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

meta:website TypeSpec.io updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants