justinytchen hybridcompute microsoft.hybrid compute 2024 07 31 preview
ARM (Control Plane) API Specification Update Pull Request
[!TIP] Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
- [ ] New resource provider.
- [x] New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
- [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
- [ ] Update existing version to fix OpenAPI spec quality issues in S360.
- [ ] Other, please clarify:
- edit this with your clarification
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood and followed the instructions by checking all the boxes:
- [x] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
- [x] I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.
Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the suppressions guide to get approval.
Getting help
- First, please carefully read through this PR description, from top to bottom. Please fill out the
Purpose of this PRandDue diligence checklist. - If you don't have permissions to remove or add labels to the PR, request
write accessper aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories - To understand what you must do next to merge this PR, see the
Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state. - For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
- For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
- If the PR CI checks appear to be stuck in
queuedstate, please add a comment with contents/azp run. This should result in a new comment denoting aPR validation pipelinehas started and the checks should be updated after few minutes. - If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.
Next Steps to Merge
✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 39 Errors, 87 Warnings failed [Detail]
| Compared specs (v0.10.12) | new version | base version |
|---|---|---|
| HybridCompute.json | 2024-07-31-preview(5ab54ee) | 2022-12-27(main) |
| HybridCompute.json | 2024-07-31-preview(5ab54ee) | 2024-05-20-preview(main) |
| privateLinkScopes.json | 2024-07-31-preview(5ab54ee) | 2022-12-27(main) |
| privateLinkScopes.json | 2024-07-31-preview(5ab54ee) | 2024-05-20-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 29 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with the latest preview version:
Only 29 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-preview-2024-07 | package-preview-2024-07(5ab54ee) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| :warning: XmsIdentifierValidation | Missing identifier id in array item property Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L3029 |
The following errors/warnings exist before current PR submission:
Only 29 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
PostResponseCodes |
Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L38 |
OperationIdNounVerb |
Per the Noun_Verb convention for Operation Ids, the noun 'Licenses' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L42 |
ProvisioningStateSpecifiedForLROPut |
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L84 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L84 |
PatchResponseCodes |
Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L134 |
LroPatch202 |
The async patch operation should return 202. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L163 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L224 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L348 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:name. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L441 |
ParametersInPointGet |
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L520 |
ResourceNameRestriction |
The resource name parameter 'extensionName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L1103 |
ProvisioningStateSpecifiedForLROPut |
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L1104 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L1104 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L1154 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L1253 |
PostResponseCodes |
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L1441 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L1617 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L1654 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L1675 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L1705 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L1841 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L3191 |
BodyTopLevelProperties |
Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'Machine' has extra properties ['resources']. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L3405 |
AllTrackedResourcesMustHaveDelete |
The resource License does not have a corresponding delete operation. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L3513 |
TrackedResourcePatchOperation |
Tracked resource 'License' must have patch operation that at least supports the update of tags. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L3513 |
ArmResourcePropertiesBag |
Top level property names should not be repeated inside the properties bag for ARM resource 'MachineExtension'. Properties [properties.type] conflict with ARM top level properties. Please rename these. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L4243 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L4301 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L4306 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L4350 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️❌ azure-sdk-for-net-track2 failed [Detail]
- For more instructions, please refer to the FAQ .
❌Failed in generating from b7d86b7f2e332d036a0144f8fc7e45ca8d3c79d5. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json command pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json cmderr [Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714 cmderr [Invoke-GenerateAndBuildV2.ps1] Line | cmderr [Invoke-GenerateAndBuildV2.ps1] 714 | GeneratePackage -projectFolder $projectFolder -sdkRootPath $s … cmderr [Invoke-GenerateAndBuildV2.ps1] | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] | Failed to build sdk solution. exit code: False cmderr [Invoke-GenerateAndBuildV2.ps1] Get-ChildItem: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:787 cmderr [Invoke-GenerateAndBuildV2.ps1] Line | cmderr [Invoke-GenerateAndBuildV2.ps1] 787 | … rtifacts += Get-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s … cmderr [Invoke-GenerateAndBuildV2.ps1] | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] | Cannot find path cmderr [Invoke-GenerateAndBuildV2.ps1] | '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because cmderr [Invoke-GenerateAndBuildV2.ps1] | it does not exist.
❌Azure.ResourceManager.HybridCompute [Preview SDK Changes]info [Changelog]
️⚠️ azure-sdk-for-python warning [Detail]
- For more instructions, please refer to the FAQ .
⚠️Warning in generating from b7d86b7f2e332d036a0144f8fc7e45ca8d3c79d5. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. cmderr [automation_init.sh] npm notice cmderr [automation_init.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.2 cmderr [automation_init.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.2 cmderr [automation_init.sh] npm notice To update run: npm install -g [email protected] cmderr [automation_init.sh] npm notice command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
️✔️azure-mgmt-hybridcompute [Preview SDK Changes]
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
- For more instructions, please refer to the FAQ .
️✔️Succeeded in generating from b7d86b7f2e332d036a0144f8fc7e45ca8d3c79d5. SDK Automation 14.0.0command ./eng/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json command ./eng/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
️✔️azure-resourcemanager-hybridcompute [Preview SDK Changes]info [Changelog]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
- For more instructions, please refer to the FAQ .
️✔️Succeeded in generating from b7d86b7f2e332d036a0144f8fc7e45ca8d3c79d5. SDK Automation 14.0.0command sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json command generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
️✔️sdk/resourcemanager/hybridcompute/armhybridcompute [Preview SDK Changes]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
- For more instructions, please refer to the FAQ .
️✔️Succeeded in generating from b7d86b7f2e332d036a0144f8fc7e45ca8d3c79d5. SDK Automation 14.0.0command sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json warn Warning: File azure-sdk-for-js_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel. command sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
️✔️@azure/arm-hybridcompute [Preview SDK Changes]
️❌ azure-resource-manager-schemas failed [Detail]
- For more instructions, please refer to the FAQ .
❌Code Generator Failed in generating from b7d86b7f2e332d036a0144f8fc7e45ca8d3c79d5. Schema Automation 14.0.0command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json cmderr [initScript.sh] Submodule 'bicep-types-az' (https://github.com/Azure/bicep-types-az) registered for path 'bicep-types-az' cmderr [initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az'... cmderr [initScript.sh] Submodule 'bicep-types' (https://github.com/Azure/bicep-types) registered for path 'bicep-types-az/bicep-types' cmderr [initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az/bicep-types'... cmderr [initScript.sh] npm notice cmderr [initScript.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.2 cmderr [initScript.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.2 cmderr [initScript.sh] npm notice To update run: npm install -g [email protected] cmderr [initScript.sh] npm notice error Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/initScript.sh warn Warning: File azure-resource-manager-schemas_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel. command .sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json cmderr [generateScript.sh] /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:500 cmderr [generateScript.sh] return new TSError(diagnosticText, diagnosticCodes) cmderr [generateScript.sh] ^ cmderr [generateScript.sh] TSError: ⨯ Unable to compile TypeScript: cmderr [generateScript.sh] cmd/generateall.ts(6,20): error TS2307: Cannot find module 'colors' or its corresponding type declarations. cmderr [generateScript.sh] cmd/generateall.ts(10,19): error TS2307: Cannot find module 'yargs' or its corresponding type declarations. cmderr [generateScript.sh] cmd/generateall.ts(11,18): error TS2307: Cannot find module 'path' or its corresponding type declarations. cmderr [generateScript.sh] cmd/generateall.ts(13,35): error TS2307: Cannot find module 'fs' or its corresponding type declarations. cmderr [generateScript.sh] cmd/generateall.ts(14,23): error TS2307: Cannot find module 'strip-ansi' or its corresponding type declarations. cmderr [generateScript.sh] cmd/generateall.ts(42,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'. cmderr [generateScript.sh] cmd/generateall.ts(53,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'. cmderr [generateScript.sh] cmd/generateall.ts(69,67): error TS7006: Parameter 'x' implicitly has an 'any' type. cmderr [generateScript.sh] cmd/generateall.ts(70,49): error TS7006: Parameter 'f' implicitly has an 'any' type. cmderr [generateScript.sh] cmd/generateall.ts(94,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'. cmderr [generateScript.sh] cmd/generateall.ts(105,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'. cmderr [generateScript.sh] cmd/generateall.ts(106,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'. cmderr [generateScript.sh] cmd/generateall.ts(157,13): error TS2591: Cannot find name 'process'. Do you need to install type definitions for node? Try `npm i --save-dev @types/node` and then add 'node' to the types field in your tsconfig. cmderr [generateScript.sh] at createTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:500:12) cmderr [generateScript.sh] at reportTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:504:19) cmderr [generateScript.sh] at getOutput (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:739:36) cmderr [generateScript.sh] at Object.compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:955:32) cmderr [generateScript.sh] at Module.m._compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:1043:43) cmderr [generateScript.sh] at Module._extensions..js (node:internal/modules/cjs/loader:1422:10) cmderr [generateScript.sh] at Object.require.extensions.<computed> [as .ts] (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:1046:12) cmderr [generateScript.sh] at Module.load (node:internal/modules/cjs/loader:1203:32) cmderr [generateScript.sh] at Function.Module._load (node:internal/modules/cjs/loader:1019:12) cmderr [generateScript.sh] at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:128:12) error Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/generateScript.sh warn Warning: Package processing is skipped as the SDK generation fails. Please look into the above generation errors or report this issue through https://aka.ms/azsdk/support/specreview-channel.
️⚠️ azure-powershell warning [Detail]
- For more instructions, please refer to the FAQ .
⚠️Warning in generating from b7d86b7f2e332d036a0144f8fc7e45ca8d3c79d5. SDK Automation 14.0.0command sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json command pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
⚠️Az.hybridcompute.DefaultTag [Preview SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/hybridcompute/armhybridcompute | https://apiview.dev/Assemblies/Review/cc99eb4c91204d199d8e40aed71bc06e?revisionId=e9fe04d81d7349d7a2bce9d5a55c6475 |
| JavaScript | @azure/arm-hybridcompute | https://apiview.dev/Assemblies/Review/bd79793b6b53409d8de21847c605dc64?revisionId=3825ebb040d54dea8d4f2334d7e4743f |
| Java | azure-resourcemanager-hybridcompute | https://apiview.dev/Assemblies/Review/b79886348ebe497b9ddc99d286cb6e99?revisionId=6376ce02960c423185a6de1eea0af28f |
| Swagger | Microsoft.HybridCompute | https://apiview.dev/Assemblies/Review/31dae74112a04fb7b3a4a58e2c398536?revisionId=3faa41fa73334dc2a8f194bcabd7b05a |
azp /run
@justinytchen you shouldn't ordinarily remove those labels yourself, breaking change reviewers should add their approval. Do you consider the breaking change output has false positives, or what?
/azp run
Azure Pipelines successfully started running 3 pipeline(s).
@TimLovellSmith Yeah, I'm a little confused why the changes are being marked as breaking, since relative to the previous preview version, I am only adding properties. I believed we did something similar (removing the BreakingChange label) for the previous preview API version PRs because we faced the same issue. For instance, here: https://github.com/Azure/azure-rest-api-specs/pull/28787
"disks": {
this is a bugfix I assume... #Resolved
Refers to: specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json:3057 in 2d67019. [](commit_id = 2d670192bb5b2fcab1ad32aecd1996aed6245eca, deletion_comment = False)
@TimLovellSmith Yeah, I'm a little confused why the changes are being marked as breaking, since relative to the previous preview version, I am only adding properties. I believed we did something similar (removing the BreakingChange label) for the previous preview API version PRs because we faced the same issue. For instance, here: #28787
Breaking changes compared with the last stable version as well as the latest preview.
"resources": {
Hmm I didn't think you're supposed to have "resources" as a top level property, is it not actually inside of MachineProperties?
Could you double check that your service actually returns this as a top level property? If you do, we don't need to panic and fix it right now, since that would, sigh, be breaking.
But if its actually a documentation bug of some kind we should fix it.
Refers to: specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json:3404 in 546e8d0. [](commit_id = 546e8d0b0c1faf2dc74288dd83d54c6afdeaa5cc, deletion_comment = False)
"resources": {
Is this new in the latest preview version, or was it already in the previous stable version?
In reply to: 2211564674
Refers to: specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json:3404 in 546e8d0. [](commit_id = 546e8d0b0c1faf2dc74288dd83d54c6afdeaa5cc, deletion_comment = False)
"description": "The correlation ID passed in from RSM per upgrade."
is this readonly? #Resolved
Refers to: specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json:3114 in 546e8d0. [](commit_id = 546e8d0b0c1faf2dc74288dd83d54c6afdeaa5cc, deletion_comment = False)
"description": "The correlation ID passed in from RSM per upgrade."
Are docs about RSM going to make sense to customers? #Resolved
Refers to: specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json:3114 in 546e8d0. [](commit_id = 546e8d0b0c1faf2dc74288dd83d54c6afdeaa5cc, deletion_comment = False)
"resources": {Hmm I didn't think you're supposed to have "resources" as a top level property, is it not actually inside of MachineProperties?
Could you double check that your service actually returns this as a top level property? If you do, we don't need to panic and fix it right now, since that would, sigh, be breaking.
But if its actually a documentation bug of some kind we should fix it.
Refers to: specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json:3404 in 546e8d0. [](commit_id = 546e8d0, deletion_comment = False)
We do return it as a top level property and it's been there for many preview versions as well as the last stable version
"description": "The correlation ID passed in from RSM per upgrade."is this readonly?
Refers to: specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json:3114 in 546e8d0. [](commit_id = 546e8d0, deletion_comment = False)
Not read-only - RSM will make PATCH calls to the machine and set the correlation ID, desired version, and other agent upgrade properties
"description": "The correlation ID passed in from RSM per upgrade."Are docs about RSM going to make sense to customers?
Refers to: specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json:3114 in 546e8d0. [](commit_id = 546e8d0, deletion_comment = False)
Will fix to make it more understandable to customers
@justinytchen So, by the way.... I just noticed you have networkSecurityPerimeter type definitions in here.
I've been getting RPs to try and standardize on using common-types for that. Could you please give that a try, and we can check if there is any blocker to standardizing, like it would lead to any breaking changes?
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/common-types/resource-management/v5/networksecurityperimeter.json
To be clear, I only want us to do this if its non-breaking, otherwise the benefits are unclear -- but I think in general if its non-breaking then there are clear maintainability benefits to getting it done.
@TimLovellSmith I updated the references to use the definitions in common-types if it didn't cause a breaking change. Regarding the breaking changes relative to the latest stable, what are the next steps?
We released a stable version back in 2022, and have released many preview versions since. One of those preview versions had a breaking change relative to the stable version, but the subsequent preview versions did not have a breaking change relative to that initial breaking change. Does this mean that every subsequent preview version we make now will have to go through a breaking change review?
Use this link https://aka.ms/brch for breaking change process.
Please remove the ARMChangesRequested Label once you have got the breaking change approval
Breaking changes reviewed and approved previously in #29070
/azp run
Azure Pipelines successfully started running 3 pipeline(s).
@ jutinytchen can I hear what those were?
Tried replacing, but there were too many breaking changes
@TimLovellSmith It was awhile back so I don't remember exactly, but it was mostly lots of small inconsistencies with properties and attributes like read-only, or slightly different enum values, types, etc
@mikekistler the stable api version has been approved and merged https://github.com/Azure/azure-rest-api-specs/pull/29954/files
/azp run
Azure Pipelines successfully started running 3 pipeline(s).
PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.