Skip to content
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.

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

justinytchen hybridcompute microsoft.hybrid compute 2024 07 31 preview #29560

Conversation

justinytchen
Copy link
Member

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section 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.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • 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:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • 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 PR and Due diligence checklist.
  • If you don't have permissions to remove or add labels to the PR, request write access per 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 Merge comment. 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 queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has 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.

Copy link

openapi-pipeline-app bot commented Jun 25, 2024

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Copy link

openapi-pipeline-app bot commented Jun 25, 2024

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.

Rule Message
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L354:9
Old: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L44:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L417:9
Old: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L100:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L473:9
Old: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L156:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L520:9
Old: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L203:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L892:9
Old: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L271:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L955:9
Old: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L334:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L1022:9
Old: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L401:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L1071:9
Old: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L443:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L1110:9
Old: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L482:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L1177:9
Old: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L549:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L1259:9
Old: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L631:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L1332:9
Old: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L704:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L1388:9
Old: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L760:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L1447:9
Old: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L819:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L1521:9
Old: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L893:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L1585:9
Old: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L957:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HybridCompute/preview/2024-07-31-preview/HybridCompute.json#L1681:9
Old: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L1053:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: common-types/resource-management/v5/types.json#L632:5
Old: common-types/resource-management/v3/types.json#L622:5
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: common-types/resource-management/v5/types.json#L204:9
Old: common-types/resource-management/v3/types.json#L204:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: common-types/resource-management/v5/types.json#L210:9
Old: common-types/resource-management/v3/types.json#L209:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
1029 - ReadonlyPropertyChanged The read only property has changed from 'true' to 'false'.
New: common-types/resource-management/v5/privatelinks.json#L143:9
Old: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L928:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.HybridCompute/preview/2024-07-31-preview/privateLinkScopes.json#L119:9
Old: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L119:9


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.

Rule Message
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v5/networksecurityperimeter.json#L96:9
Old: Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L1116:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v5/networksecurityperimeter.json#L140:9
Old: Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L1205:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v5/networksecurityperimeter.json#L173:9
Old: Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L1210:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v5/networksecurityperimeter.json#L279:9
Old: Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L1428:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v5/networksecurityperimeter.json#L115:9
Old: Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L1138:9
⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) 'Other' from the old version.
New: common-types/resource-management/v5/networksecurityperimeter.json#L140:9
Old: Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L1205:9
⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) 'enforced, audit, learning' from the old version.
New: common-types/resource-management/v5/networksecurityperimeter.json#L279:9
Old: Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L1428:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L1089:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/networksecurityperimeter.json#L195:11
Old: Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L1224:11
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/networksecurityperimeter.json#L217:9
Old: Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L1383:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: common-types/resource-management/v5/networksecurityperimeter.json#L229:9
Old: Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L1388:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'uri' than the previous one ''.
New: common-types/resource-management/v5/networksecurityperimeter.json#L53:9
Old: Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L1412:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: common-types/resource-management/v5/types.json#L204:9
Old: common-types/resource-management/v3/types.json#L204:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: common-types/resource-management/v5/types.json#L210:9
Old: common-types/resource-management/v3/types.json#L209:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: common-types/resource-management/v5/types.json#L14:9
Old: common-types/resource-management/v3/types.json#L14:9
⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'true' to 'false'.
New: common-types/resource-management/v5/privatelinks.json#L143:9
Old: Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L1663:9
⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
New: common-types/resource-management/v5/networksecurityperimeter.json#L104:11
Old: Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L1125:11
⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
New: common-types/resource-management/v5/networksecurityperimeter.json#L130:9
Old: Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L1193:9
⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
New: common-types/resource-management/v5/networksecurityperimeter.json#L140:9
Old: Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L1205:9
⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
New: common-types/resource-management/v5/networksecurityperimeter.json#L173:9
Old: Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L1210:9
⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
New: common-types/resource-management/v5/networksecurityperimeter.json#L195:11
Old: Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L1224:11
⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'true' to 'false'.
New: common-types/resource-management/v5/networksecurityperimeter.json#L326:9
Old: Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L1347:9
️️✔️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]
⚠️ 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]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Jun 25, 2024

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.0
    command	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.0
    command	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 npm@10.8.2
    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.0
    command	./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.0
    command	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.0
    command	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.0
    command	.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 npm@10.8.2
    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/ts-node@9.0.0_typescript@5.3.3/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/ts-node@9.0.0_typescript@5.3.3/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/ts-node@9.0.0_typescript@5.3.3/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/ts-node@9.0.0_typescript@5.3.3/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/ts-node@9.0.0_typescript@5.3.3/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/ts-node@9.0.0_typescript@5.3.3/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/ts-node@9.0.0_typescript@5.3.3/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.0
    command	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]
Posted by Swagger Pipeline | How to fix these errors?

@justinytchen
Copy link
Member Author

azp /run

@justinytchen justinytchen removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Jun 26, 2024
@AzureRestAPISpecReview AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Jun 26, 2024
@ramoka178
Copy link
Contributor

@ramoka178 I fixed the new path, though I'm not sure why it's still being flagged (I believe there are 12 segments). The RP name given twice is intentional - it is an extension resource from the same provider. The example requests support this as well (see the previous API versions' examples)

"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridCompute/networkConfigurations/current",

I am not sure about the example. Also, I have not seen the format of duplicating the RP name in the API itself.
I believe the API path should be of {resourceType}/{resourceName} format, which is not present for the last part of "providers/Microsoft.HybridCompute/networkConfigurations/current"

You could post your issue in https://teams.microsoft.com/l/channel/19%3A4f661242c446452e895359cc3ef45125%40thread.tacv2/ARM%20linter%20rules?groupId=0cab4ce9-7691-42ae-82e3-460d4346a710&tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47 for any guidance.

Also there are other errors in BodyTopLevelProperties , that are not related to value/nextLink issue. Please fix them as well.

@ramoka178 ramoka178 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Aug 28, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 28, 2024
@justinytchen
Copy link
Member Author

@ramoka178 These changes (the HybridCompute provider being listed twice and the AgentVersion top level properties) have been approved and are in previous preview versions. Changing these would be breaking changes. We can potentially make a change to the AgentVersion APIs but the networkconfiguration path will be very difficult to change

@justinytchen
Copy link
Member Author

Previous preview API version with AgentVersion top level properties: #29070

@justinytchen justinytchen added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 30, 2024
@justinytchen
Copy link
Member Author

Went to office hours, talked about the networkConfiguration/current path, which would be discussed internally (in the ARM team) to figure out the resolution. Also discussed the AgentVersion response, where the top level properties has already been approved.
Both of these changes have been in the past few preview API versions and are released, so it would be difficult to change (i.e. breaking change)

@ramoka178
Copy link
Contributor

Went to office hours, talked about the networkConfiguration/current path, which would be discussed internally (in the ARM team) to figure out the resolution. Also discussed the AgentVersion response, where the top level properties has already been approved. Both of these changes have been in the past few preview API versions and are released, so it would be difficult to change (i.e. breaking change)

For next API reviewer: Asked this question on https://teams.microsoft.com/l/message/19:78cd6c72c41240dc84a36523af60b88a@thread.tacv2/1725044502273?tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47&groupId=0cab4ce9-7691-42ae-82e3-460d4346a710&parentMessageId=1725044502273&teamName=ARM%20API%20Reviewers&channelName=ARM%20swagger%20reviews&createdTime=1725044502273

@AzureRestAPISpecReview AzureRestAPISpecReview removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 4, 2024
@openapi-pipeline-app openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 4, 2024
Justin Chen added 2 commits September 4, 2024 13:52
…-07-31-preview' of https://github.com/Azure/azure-rest-api-specs into justinytchen-hybridcompute-Microsoft.HybridCompute-2024-07-31-preview
@AzureRestAPISpecReview AzureRestAPISpecReview removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 4, 2024
@justinytchen justinytchen added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 6, 2024
@gary-x-li gary-x-li added Approved-Suppression and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 9, 2024
@justinytchen justinytchen dismissed mikekistler’s stale review September 10, 2024 16:43

Previous stable api version has been released

@justinytchen justinytchen removed the request for review from mikekistler September 10, 2024 16:44
@justinytchen justinytchen merged commit a9980ec into main Sep 10, 2024
27 of 31 checks passed
@justinytchen justinytchen deleted the justinytchen-hybridcompute-Microsoft.HybridCompute-2024-07-31-preview branch September 10, 2024 16:53
jaskisin pushed a commit to jaskisin/azure-rest-api-specs that referenced this pull request Sep 16, 2024
Azure#29560)

Updated preview version with 2024-07-31-preview to add FirmwareProfile, HardwareProfile, and StorageProfile to Machine Properties in Hybrid Compute Machine Resource

---------

Co-authored-by: Justin Chen <juschen@microsoft.com>
Co-authored-by: Tim Lovell-Smith <tilovell@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-Suppression ArcReview ArcSignedOff ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-Approved-Previously Changes were reviewed and approved in a previous PR BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required new-api-version PublishToCustomers Acknowledgement the changes will be published to Azure customers. resource-manager SuppressionReviewRequired
Projects
None yet
Development

Successfully merging this pull request may close these issues.