Skip to content

[Automated][azure-resource-manager] Add ExtendedLocationProperty to envelope properties documentation#4529

Merged
markcowl merged 2 commits into
mainfrom
docs/arm-envelope-properties-update-376e3b88f0dd687d
Jun 2, 2026
Merged

[Automated][azure-resource-manager] Add ExtendedLocationProperty to envelope properties documentation#4529
markcowl merged 2 commits into
mainfrom
docs/arm-envelope-properties-update-376e3b88f0dd687d

Conversation

@markcowl
Copy link
Copy Markdown
Member

@markcowl markcowl commented Jun 1, 2026

…e properties guide

Add missing ExtendedLocationProperty documentation to the envelope properties section of the resource-type how-to guide, matching the updated canonical sample that now demonstrates all recommended envelope properties.

Also update the knowledge base with lessons from feedback and new envelope property placement conventions.

…e properties guide

Add missing ExtendedLocationProperty documentation to the envelope
properties section of the resource-type how-to guide, matching the
updated canonical sample that now demonstrates all recommended
envelope properties.

Also update the knowledge base with lessons from feedback and
new envelope property placement conventions.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@azure-sdk
Copy link
Copy Markdown
Collaborator

No changes needing a change description found.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 1, 2026

⚡ Benchmark Results

⚠️ 2 metric(s) regressed above the +5% threshold:

Metric Baseline Current Change
 ↳ linter/@azure-tools/typespec-azure-resource-manager/lro-location-header 🟡 12.3ms 🟡 13.5ms +9.8% 🔴
 ↳ emit/@azure-tools/typespec-autorest 🟢 166.1ms 🟢 182.3ms +9.8% 🔴
Full details – comparing fe44f24 vs baseline 8cd8304
Metric Baseline Current Change
total 🔴 6.59s 🔴 6.53s -0.9%
loader 🟡 212.7ms 🟢 184.0ms -13.5% 🟢
resolver 🟢 20.3ms 🟢 18.9ms -6.8% 🟢
checker 🟢 187.3ms 🟢 179.7ms -4.0%
validation 🟢 43.4ms 🟢 42.6ms -1.8%
 ↳ validation/@azure-tools/typespec-azure-core 🟢 6.2ms 🟢 6.1ms -2.3%
 ↳ validation/@typespec/http 🟢 5.4ms 🟢 5.2ms -3.3%
 ↳ validation/@typespec/rest 🟢 0.6ms 🟢 0.5ms -12.5%
 ↳ validation/@typespec/versioning 🔴 28.4ms 🔴 28.7ms +1.0%
 ↳ validation/compiler 🟢 1.8ms 🟢 1.6ms -12.1%
linter 🟡 212.3ms 🟢 126.2ms -40.5% 🟢
 ↳ linter/@azure-tools/typespec-azure-core/auth-required 🟢 0.0ms 🟢 0.0ms -1.1%
 ↳ linter/@azure-tools/typespec-azure-core/bad-record-type 🟢 0.4ms 🟢 0.2ms -48.1%
 ↳ linter/@azure-tools/typespec-azure-core/byos 🟢 9.0ms 🟢 5.4ms -40.4% 🟢
 ↳ linter/@azure-tools/typespec-azure-core/casing-style 🟢 0.8ms 🟢 0.6ms -23.2%
 ↳ linter/@azure-tools/typespec-azure-core/composition-over-inheritance 🟢 0.1ms 🟢 0.1ms +4.8%
 ↳ linter/@azure-tools/typespec-azure-core/documentation-required 🟢 0.9ms 🟢 0.8ms -6.2%
 ↳ linter/@azure-tools/typespec-azure-core/friendly-name 🟢 0.8ms 🟢 0.6ms -22.6%
 ↳ linter/@azure-tools/typespec-azure-core/key-visibility-required 🟢 0.2ms 🟢 0.2ms -3.2%
 ↳ linter/@azure-tools/typespec-azure-core/known-encoding 🟢 0.3ms 🟢 0.3ms -6.3%
 ↳ linter/@azure-tools/typespec-azure-core/long-running-polling-operation-required 🟢 0.3ms 🟢 0.3ms -4.0%
 ↳ linter/@azure-tools/typespec-azure-core/no-case-mismatch 🟢 0.2ms 🟢 0.2ms -8.9%
 ↳ linter/@azure-tools/typespec-azure-core/no-closed-literal-union 🟢 0.3ms 🟢 0.2ms -8.3%
 ↳ linter/@azure-tools/typespec-azure-core/no-enum 🟢 0.0ms 🟢 0.0ms +9.4%
 ↳ linter/@azure-tools/typespec-azure-core/no-error-status-codes 🟢 0.1ms 🟢 0.1ms -8.1%
 ↳ linter/@azure-tools/typespec-azure-core/no-explicit-routes-resource-ops 🟢 0.1ms 🟢 0.1ms -11.6%
 ↳ linter/@azure-tools/typespec-azure-core/no-format 🟢 0.9ms 🟢 0.6ms -35.6%
 ↳ linter/@azure-tools/typespec-azure-core/no-generic-numeric 🟢 0.4ms 🟢 0.4ms -3.0%
 ↳ linter/@azure-tools/typespec-azure-core/no-header-explode 🔴 31.4ms 🟡 17.2ms -45.1% 🟢
 ↳ linter/@azure-tools/typespec-azure-core/no-legacy-usage 🟢 1.1ms 🟢 1.1ms -3.5%
 ↳ linter/@azure-tools/typespec-azure-core/no-multiple-discriminator 🟢 0.1ms 🟢 0.1ms -3.8%
 ↳ linter/@azure-tools/typespec-azure-core/no-nullable 🟢 0.3ms 🟢 0.3ms -2.2%
 ↳ linter/@azure-tools/typespec-azure-core/no-offsetdatetime 🟢 1.2ms 🟢 1.2ms -2.8%
 ↳ linter/@azure-tools/typespec-azure-core/no-openapi 🟢 3.0ms 🟢 2.0ms -35.2% 🟢
 ↳ linter/@azure-tools/typespec-azure-core/no-private-usage 🟢 2.1ms 🟢 1.8ms -14.5%
 ↳ linter/@azure-tools/typespec-azure-core/no-query-explode 🔴 31.3ms 🟡 18.5ms -41.0% 🟢
 ↳ linter/@azure-tools/typespec-azure-core/no-response-body 🔴 43.5ms 🔴 23.3ms -46.4% 🟢
 ↳ linter/@azure-tools/typespec-azure-core/no-rest-library-interfaces 🟢 0.0ms 🟢 0.0ms -14.0%
 ↳ linter/@azure-tools/typespec-azure-core/no-route-parameter-name-mismatch 🟢 7.8ms 🟢 4.4ms -43.1% 🟢
 ↳ linter/@azure-tools/typespec-azure-core/no-rpc-path-params 🟢 0.3ms 🟢 0.2ms -36.4%
 ↳ linter/@azure-tools/typespec-azure-core/no-string-discriminator 🟢 0.0ms 🟢 0.0ms -2.0%
 ↳ linter/@azure-tools/typespec-azure-core/no-unknown 🟢 0.3ms 🟢 0.2ms -43.9%
 ↳ linter/@azure-tools/typespec-azure-core/no-unnamed-union 🟢 0.4ms 🟢 0.3ms -7.9%
 ↳ linter/@azure-tools/typespec-azure-core/operation-missing-api-version 🟢 0.2ms 🟢 0.2ms -7.8%
 ↳ linter/@azure-tools/typespec-azure-core/request-body-problem 🟢 0.3ms 🟢 0.3ms -8.0%
 ↳ linter/@azure-tools/typespec-azure-core/require-versioned 🟢 0.0ms 🟢 0.0ms -5.2%
 ↳ linter/@azure-tools/typespec-azure-core/response-schema-problem 🔴 38.2ms 🔴 21.1ms -44.9% 🟢
 ↳ linter/@azure-tools/typespec-azure-core/rpc-operation-request-body 🟢 0.4ms 🟢 0.3ms -38.2%
 ↳ linter/@azure-tools/typespec-azure-core/spread-discriminated-model 🟢 0.3ms 🟢 0.3ms -6.8%
 ↳ linter/@azure-tools/typespec-azure-core/use-standard-names 🟡 10.2ms 🟢 4.6ms -55.4% 🟢
 ↳ linter/@azure-tools/typespec-azure-core/use-standard-operations 🟢 0.1ms 🟢 0.1ms -12.0%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-common-types-version 🟢 3.7ms 🟢 3.6ms -3.9%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-custom-resource-no-key 🟢 0.1ms 🟢 0.1ms +2.2%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-custom-resource-usage-discourage 🟢 0.1ms 🟢 0.1ms -7.1%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes 🟢 4.6ms 🟢 4.5ms -1.9%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-no-path-casing-conflicts 🟢 4.0ms 🟢 4.1ms +0.7%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-no-record 🟢 0.4ms 🟢 0.3ms -6.3%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-post-operation-response-codes 🟢 0.4ms 🟢 0.4ms -3.3%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes 🟢 0.0ms 🟢 0.0ms +7.7%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-action-no-segment 🟢 0.2ms 🟢 0.2ms -5.1%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property 🟢 0.1ms 🟢 0.1ms +5.6%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator 🟢 0.0ms 🟢 0.0ms -10.9%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-action-verb 🟢 0.1ms 🟢 0.1ms -1.1%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property 🟢 0.1ms 🟢 0.1ms +0.5%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-version-format 🟢 0.0ms 🟢 0.0ms -8.2%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-key-invalid-chars 🟢 0.2ms 🟢 0.2ms -1.6%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-name-pattern 🟢 0.0ms 🟢 0.0ms -5.3%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-operation 🟢 0.2ms 🟢 0.2ms -6.5%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-operation-response 🟢 4.4ms 🟢 4.2ms -4.8%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-patch 🟢 0.3ms 🟢 0.3ms -4.9%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-path-segment-invalid-chars 🟢 0.2ms 🟢 0.2ms +2.7%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state 🟢 0.1ms 🟢 0.1ms +7.4%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/beyond-nesting-levels 🟢 0.1ms 🟢 0.1ms -4.9%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/empty-updateable-properties 🟢 0.1ms 🟢 0.1ms +0.1%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/improper-subscription-list-operation 🟢 0.0ms 🟢 0.0ms +46.2%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/lro-location-header 🟡 12.3ms 🟡 13.5ms +9.8% 🔴
 ↳ linter/@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint 🟢 0.0ms 🟢 0.0ms -6.7%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/missing-x-ms-identifiers 🟢 0.3ms 🟢 0.3ms -2.5%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/no-empty-model 🟢 0.1ms 🟢 0.1ms -9.8%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation 🟢 0.2ms 🟢 0.2ms -0.2%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/no-response-body 🟡 19.7ms 🟡 18.7ms -5.0%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/patch-envelope 🟢 0.1ms 🟢 0.1ms -2.1%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/resource-name 🟢 0.1ms 🟢 0.1ms -6.0%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/secret-prop 🟢 2.4ms 🟢 2.3ms -6.7%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/unsupported-type 🟢 0.4ms 🟢 0.4ms -4.3%
 ↳ linter/@azure-tools/typespec-azure-resource-manager/version-progression 🟢 0.0ms 🟢 0.0ms +1.2%
 ↳ linter/@azure-tools/typespec-client-generator-core/property-name-conflict 🟢 1.2ms 🟢 1.0ms -14.2%
 ↳ linter/@azure-tools/typespec-client-generator-core/require-client-suffix 🟢 0.2ms 🟢 0.2ms +0.2%
emit 🔴 5.83s 🔴 5.93s +1.6%
 ↳ emit/@azure-tools/typespec-autorest 🟢 166.1ms 🟢 182.3ms +9.8% 🔴
 ↳ emit/@azure-tools/typespec-python 🔴 4.33s 🔴 4.37s +1.0%
 ↳ emit/@typespec/http-client-js 🔴 1.14s 🔴 1.13s -1.0%
 ↳ emit/@typespec/openapi3 🟢 147.1ms 🟢 149.2ms +1.4%
 ↳ emit/@typespec/openapi3/compute 🟢 130.7ms 🟢 130.8ms +0.1%
 ↳ emit/@typespec/openapi3/write 🟢 16.9ms 🟢 16.9ms -0.4%

Averaged across 3 specs (azure-arm-resource-manager, azure-core-dataplane, azure-full).
Threshold: changes > ±5% are highlighted.
🟢 Fast · 🟡 Moderate (stages >200ms, rules >10ms) · 🔴 Slow (stages >400ms, rules >20ms)

@azure-sdk
Copy link
Copy Markdown
Collaborator

azure-sdk commented Jun 1, 2026

You can try these changes here

🛝 Playground 🌐 Website

@markcowl markcowl added this pull request to the merge queue Jun 2, 2026
Merged via the queue into main with commit 7ee08d0 Jun 2, 2026
27 checks passed
@markcowl markcowl deleted the docs/arm-envelope-properties-update-376e3b88f0dd687d branch June 2, 2026 01:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

eng meta:website TypeSpec.io updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Automated][azure-resource-manager] Add ExtendedLocationProperty to envelope properties documentation

3 participants