Document resolveArmResources design proposal#4793
Draft
ArcturusZhang wants to merge 2 commits into
Draft
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
microsoft-github-policy-service
Bot
added
the
lib:azure-resource-manager
commit: |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
|
No changes needing a change description found. |
Contributor
|
You can try these changes here
|
Contributor
⚡ Benchmark Results
Full details – comparing
|
| Metric | Baseline | Current | Change |
|---|---|---|---|
| total | 🔴 715.2ms | 🔴 771.7ms | +7.9% 🔴 |
| loader | 🟡 203.6ms | 🟡 226.7ms | +11.3% 🔴 |
| resolver | 🟢 21.9ms | 🟢 34.1ms | +56.1% 🔴 |
| checker | 🟡 229.7ms | 🟡 281.0ms | +22.3% 🔴 |
| validation | 🟢 52.0ms | 🟢 67.8ms | +30.4% 🔴 |
| ↳ validation/@azure-tools/typespec-azure-core | 🟢 7.6ms | 🟢 9.4ms | +23.2% 🔴 |
| ↳ validation/@typespec/http | 🟢 7.4ms | 🟡 11.7ms | +58.7% 🔴 |
| ↳ validation/@typespec/rest | 🟢 0.8ms | 🟢 1.4ms | +76.8% |
| ↳ validation/@typespec/versioning | 🔴 33.6ms | 🔴 42.0ms | +24.9% 🔴 |
| ↳ validation/compiler | 🟢 2.0ms | 🟢 3.2ms | +57.0% 🔴 |
| linter | 🟢 157.7ms | 🟢 161.6ms | +2.5% |
| ↳ linter/@azure-tools/typespec-azure-core/auth-required | 🟢 0.0ms | 🟢 0.1ms | +141.4% |
| ↳ linter/@azure-tools/typespec-azure-core/bad-record-type | 🟢 0.3ms | 🟢 0.5ms | +64.9% |
| ↳ linter/@azure-tools/typespec-azure-core/byos | 🟢 6.5ms | 🟢 6.3ms | -2.4% |
| ↳ linter/@azure-tools/typespec-azure-core/casing-style | 🟢 0.8ms | 🟢 1.2ms | +53.1% |
| ↳ linter/@azure-tools/typespec-azure-core/composition-over-inheritance | 🟢 0.1ms | 🟢 0.1ms | +64.6% |
| ↳ linter/@azure-tools/typespec-azure-core/documentation-required | 🟢 1.0ms | 🟢 1.7ms | +65.6% |
| ↳ linter/@azure-tools/typespec-azure-core/friendly-name | 🟢 0.8ms | 🟢 1.1ms | +43.5% |
| ↳ linter/@azure-tools/typespec-azure-core/key-visibility-required | 🟢 0.2ms | 🟢 0.3ms | +40.2% |
| ↳ linter/@azure-tools/typespec-azure-core/known-encoding | 🟢 0.3ms | 🟢 0.4ms | +12.8% |
| ↳ linter/@azure-tools/typespec-azure-core/long-running-polling-operation-required | 🟢 0.4ms | 🟢 0.6ms | +63.3% |
| ↳ linter/@azure-tools/typespec-azure-core/no-case-mismatch | 🟢 0.3ms | 🟢 0.6ms | +78.0% |
| ↳ linter/@azure-tools/typespec-azure-core/no-closed-literal-union | 🟢 0.4ms | 🟢 0.8ms | +102.4% |
| ↳ linter/@azure-tools/typespec-azure-core/no-enum | 🟢 0.1ms | 🟢 0.2ms | +164.0% |
| ↳ linter/@azure-tools/typespec-azure-core/no-error-status-codes | 🟢 0.1ms | 🟢 0.2ms | +66.3% |
| ↳ linter/@azure-tools/typespec-azure-core/no-explicit-routes-resource-ops | 🟢 0.1ms | 🟢 0.1ms | +21.7% |
| ↳ linter/@azure-tools/typespec-azure-core/no-format | 🟢 0.6ms | 🟢 0.7ms | +7.0% |
| ↳ linter/@azure-tools/typespec-azure-core/no-generic-numeric | 🟢 0.5ms | 🟢 0.7ms | +34.8% |
| ↳ linter/@azure-tools/typespec-azure-core/no-header-explode | 🔴 21.1ms | 🟡 19.1ms | -9.7% 🟢 |
| ↳ linter/@azure-tools/typespec-azure-core/no-legacy-usage | 🟢 1.3ms | 🟢 1.5ms | +16.8% |
| ↳ linter/@azure-tools/typespec-azure-core/no-multiple-discriminator | 🟢 0.1ms | 🟢 0.2ms | +52.3% |
| ↳ linter/@azure-tools/typespec-azure-core/no-nullable | 🟢 0.3ms | 🟢 0.3ms | +14.4% |
| ↳ linter/@azure-tools/typespec-azure-core/no-offsetdatetime | 🟢 1.3ms | 🟢 1.5ms | +11.0% |
| ↳ linter/@azure-tools/typespec-azure-core/no-openapi | 🟢 2.1ms | 🟢 2.0ms | -3.7% |
| ↳ linter/@azure-tools/typespec-azure-core/no-private-usage | 🟢 2.2ms | 🟢 2.4ms | +12.6% |
| ↳ linter/@azure-tools/typespec-azure-core/no-query-explode | 🔴 22.4ms | 🟡 19.8ms | -11.5% 🟢 |
| ↳ linter/@azure-tools/typespec-azure-core/no-response-body | 🔴 26.3ms | 🔴 24.7ms | -5.9% 🟢 |
| ↳ linter/@azure-tools/typespec-azure-core/no-rest-library-interfaces | 🟢 0.0ms | 🟢 0.1ms | +144.6% |
| ↳ linter/@azure-tools/typespec-azure-core/no-route-parameter-name-mismatch | 🟢 5.7ms | 🟢 5.4ms | -4.4% |
| ↳ linter/@azure-tools/typespec-azure-core/no-rpc-path-params | 🟢 0.2ms | 🟢 0.3ms | +31.2% |
| ↳ linter/@azure-tools/typespec-azure-core/no-string-discriminator | 🟢 0.1ms | 🟢 0.1ms | +67.6% |
| ↳ linter/@azure-tools/typespec-azure-core/no-unknown | 🟢 0.2ms | 🟢 0.3ms | +17.9% |
| ↳ linter/@azure-tools/typespec-azure-core/no-unnamed-union | 🟢 0.4ms | 🟢 0.6ms | +45.4% |
| ↳ linter/@azure-tools/typespec-azure-core/operation-missing-api-version | 🟢 0.2ms | 🟢 0.3ms | +45.1% |
| ↳ linter/@azure-tools/typespec-azure-core/request-body-problem | 🟢 0.3ms | 🟢 0.4ms | +14.8% |
| ↳ linter/@azure-tools/typespec-azure-core/require-versioned | 🟢 0.0ms | 🟢 0.0ms | +179.8% |
| ↳ linter/@azure-tools/typespec-azure-core/response-schema-problem | 🔴 24.5ms | 🔴 24.4ms | -0.4% |
| ↳ linter/@azure-tools/typespec-azure-core/rpc-operation-request-body | 🟢 0.4ms | 🟢 0.5ms | +37.0% |
| ↳ linter/@azure-tools/typespec-azure-core/spread-discriminated-model | 🟢 0.3ms | 🟢 0.4ms | +17.1% |
| ↳ linter/@azure-tools/typespec-azure-core/use-standard-names | 🟢 6.0ms | 🟢 5.4ms | -11.4% |
| ↳ linter/@azure-tools/typespec-azure-core/use-standard-operations | 🟢 0.1ms | 🟢 0.2ms | +37.4% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-agent-base-type-child-resources | 🟢 6.8ms | 🟡 10.1ms | +49.0% 🔴 |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-agent-base-type-lifecycle-operations | 🟢 0.0ms | 🟢 0.2ms | +299.8% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-common-types-version | 🟢 5.5ms | 🟢 9.0ms | +64.1% 🔴 |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-custom-resource-no-key | 🟢 0.1ms | 🟢 0.2ms | +48.9% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-custom-resource-usage-discourage | 🟢 0.1ms | 🟢 0.1ms | +30.1% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes | 🟢 2.0ms | 🟢 4.3ms | +115.1% 🔴 |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-no-path-casing-conflicts | 🟡 11.9ms | 🟡 13.0ms | +8.8% 🔴 |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-no-record | 🟢 0.4ms | 🟢 0.5ms | +27.8% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-post-operation-response-codes | 🟢 0.7ms | 🟢 1.4ms | +114.4% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes | 🟢 0.0ms | 🟢 0.2ms | +225.5% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-action-no-segment | 🟢 0.3ms | 🟢 0.4ms | +37.7% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property | 🟢 0.2ms | 🟢 0.3ms | +74.8% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator | 🟢 0.0ms | 🟢 0.1ms | +173.9% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-action-verb | 🟢 0.1ms | 🟢 0.1ms | +44.8% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property | 🟢 0.1ms | 🟢 0.2ms | +68.8% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-version-format | 🟢 0.1ms | 🟢 0.2ms | +147.7% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-key-invalid-chars | 🟢 0.3ms | 🟢 0.4ms | +26.3% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-name-pattern | 🟢 0.0ms | 🟢 0.1ms | +244.8% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-operation | 🟢 0.2ms | 🟢 0.4ms | +90.4% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-operation-response | 🟢 5.7ms | 🟢 7.0ms | +22.7% 🔴 |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-patch | 🟢 0.4ms | 🟢 0.7ms | +73.4% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-path-segment-invalid-chars | 🟢 0.2ms | 🟢 0.3ms | +28.7% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state | 🟢 0.2ms | 🟢 0.3ms | +100.1% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/beyond-nesting-levels | 🟢 0.1ms | 🟢 0.2ms | +66.0% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/empty-updateable-properties | 🟢 0.2ms | 🟢 0.3ms | +60.8% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/improper-subscription-list-operation | 🟢 0.0ms | 🟢 0.1ms | +274.2% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/lro-location-header | 🟡 15.1ms | 🟡 13.6ms | -9.8% 🟢 |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint | 🟢 0.0ms | 🟢 0.1ms | +166.1% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/missing-x-ms-identifiers | 🟢 0.4ms | 🟢 0.9ms | +119.0% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/no-empty-model | 🟢 0.2ms | 🟢 0.2ms | +39.3% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/no-override-props | 🟢 0.1ms | 🟢 0.3ms | +135.6% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation | 🟢 0.2ms | 🟢 0.3ms | +44.8% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/no-response-body | 🔴 22.2ms | 🔴 21.2ms | -4.6% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/patch-envelope | 🟢 0.2ms | 🟢 0.3ms | +58.8% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/resource-name | 🟢 0.2ms | 🟢 0.3ms | +69.1% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/secret-prop | 🟢 4.3ms | 🟢 4.7ms | +8.5% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/unsupported-type | 🟢 0.4ms | 🟢 0.6ms | +31.4% |
| ↳ linter/@azure-tools/typespec-azure-resource-manager/version-progression | 🟢 0.1ms | 🟢 0.2ms | +237.5% |
| ↳ linter/@azure-tools/typespec-client-generator-core/property-name-conflict | 🟢 1.3ms | 🟢 1.7ms | +33.9% |
| ↳ linter/@azure-tools/typespec-client-generator-core/require-client-suffix | 🟢 0.4ms | 🟢 1.3ms | +201.4% |
| emit | 🔴 5.63s | 🔴 4.59s | -18.4% 🟢 |
| ↳ emit/@Azure-Tools | 🟢 0.0ms | 🟢 0.0ms | +0.0% |
| ↳ emit/@azure-tools/typespec-autorest | 🟢 89.0ms | 🟢 98.2ms | +10.3% 🔴 |
| ↳ emit/@azure-tools/typespec-python | 🔴 2.15s | 🔴 1.69s | -21.4% 🟢 |
| ↳ emit/@typespec | 🟢 0.0ms | 🟢 0.0ms | +0.0% |
| ↳ emit/@typespec/http-client-js | 🔴 481.1ms | 🔴 446.6ms | -7.2% 🟢 |
| ↳ emit/@typespec/openapi3 | 🟢 80.4ms | 🟢 83.3ms | +3.5% |
| ↳ emit/@typespec/openapi3/compute | 🟢 70.1ms | 🟢 72.4ms | +3.3% |
| ↳ emit/@typespec/openapi3/write | 🟢 10.1ms | 🟢 10.6ms | +5.2% |
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)
RodgeFu
reviewed
Jul 3, 2026
| } | ||
|
|
||
| interface ResolvedResource { | ||
| type: Model; |
Member
There was a problem hiding this comment.
what' if the resource has different Model for post/get/put/...? Will the API already have helped merged them? we will need the API to expose these different models if not so that the consumers can further process them.
Member
Author
There was a problem hiding this comment.
this type here (type is not a good property name, I will change it later) represents the "resource model" of this resource. theoretically, you could consider this as the "entity model" of this ARM resource on the service side.
This is not showing any request or response types.
But some operations indeed have some rules, which I have put in the linter candidates.
For instance, read operation (get) should always return the same model as the resource model. createOrUpdate operation (put) should always return the same model as the resource model as well. In real world, createOrUpdate operation can use a different model as request.
action operations (usually post) do not have constraint on request/response type.
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
2 participants
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.
Summary
resolveArmResourcesdesignCurrent implementation mismatches
Providerand caches byNamespace -> Provider.resolveProviderNamespacereturns the first namespace with ARM provider state.ResolvedResource.ReadandCreateOrUpdatepaths should create concrete resources.listandactionoperations can initialize a new resource group.providerOperations.ResolvedResourceincludesassociatedOperations, andotheroperations are attached there.associatedOperations.Read/CreateOrUpdateinstance paths.{name}.ResolvedResourcerecords.ExternalResourceor a synthesizedResolvedResource.ExternalResourceand wants structured references only when concrete.parentand resource-valuedscopeare fullResolvedResourceobjects.ResolvedResourceReference.@singletonstate and model key-property union.undefinedvalues.listArmResourcesreturnsArmResourceDetails, deduped by qualified TypeSpec model name.Related issue: customAzureResource-based converted specs
Opened #4798 for a real-world mismatch found while comparing legacy/Swagger-shaped resource detection with
resolveArmResourcesoutput.Network is the main case: the .NET management emitter comparison found 140 legacy-detected resources, but
resolveArmResourcesreturns 0 resources and 776 non-resource methods forspecification/network/resource-manager/Microsoft.Network/Network. The spec uses legacy/custom resource bases marked with@Azure.ResourceManager.Legacy.customAzureResource(#{ isAzureResource: true }), which means the current TypeSpec-based detection path can intentionally diverge from Swagger-shaped legacy detection.This needs either a spec-side resolution, if Network can be migrated to the supported
Azure.ResourceManager.Legacy.CustomAzureResource<true>pattern and future converted specs can be prevented from using the unsupported form, or a library-side resolution inresolveArmResourcesif this custom-resource shape must continue to be recognized.Related Azure SDK analysis PR
The generated comparison reports and manual root-cause notes are preserved in Azure/azure-sdk-for-net#60620.
Validation