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

Emmelia ara v3 azure backup changes hardwaresecuritymodules microsoft.hardware security modules 2024-06-30-preview #29712

Conversation

emmeliaAra
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.

Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.
Updated the API version from preview/2023-12-10-preview to preview/2024-06-30-preview.
Copy link

openapi-pipeline-app bot commented Jul 5, 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 Jul 5, 2024

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 19 Errors, 127 Warnings failed [Detail]
Compared specs (v0.10.12) new version base version
cloudhsm.json 2024-06-30-preview(26c8a88) 2023-12-10-preview(main)
dedicatedhsm.json 2024-06-30-preview(26c8a88) 2021-11-30(main)
dedicatedhsm.json 2024-06-30-preview(26c8a88) 2018-10-31-preview(main)

The following breaking changes are detected by comparison with the latest stable version:

Only 23 items are listed, please refer to log for more details.

Rule Message
1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.HardwareSecurityModules/operations' removed or restructured?
Old: Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json#L37:5
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'SystemData' removed or renamed?
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L405:3
Old: Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json#L478:3
1011 - AddingResponseCode The new version adds a response code '202'.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L138:11
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.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json#L810:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L45:9
Old: Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json#L84:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L107:9
Old: Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json#L155:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L170:9
Old: Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json#L218:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L216:9
Old: Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json#L269:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L264:9
Old: Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json#L325:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L316:9
Old: Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json#L381:9
1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L366:9
Old: Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json#L431: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
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'id' renamed or removed?
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L407:7
Old: Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json#L537:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'id' renamed or removed?
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L418:7
Old: Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json#L547:7
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L170:9
Old: Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json#L226:11
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L216:9
Old: Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json#L277:11
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L366:9
Old: Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json#L439:11
1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
New: common-types/resource-management/v5/types.json#L511:9
Old: Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json#L867:9
1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
New: common-types/resource-management/v5/types.json#L534:9
Old: Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json#L880:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v5/types.json#L30:9
Old: Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json#L704:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v5/types.json#L511:9
Old: Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json#L867:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v5/types.json#L534:9
Old: Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json#L880:9
⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L56:13
Old: Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json#L104:13


The following breaking changes are detected by comparison with the latest preview version:

Only 23 items are listed, please refer to log for more details.

Rule Message
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.HardwareSecurityModules/operations' removed or restructured?
Old: Microsoft.HardwareSecurityModules/preview/2018-10-31-preview/dedicatedhsm.json#L37:5
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'CloudHsmClusterSecurityDomainProperties' removed or renamed?
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L1070:3
Old: Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/cloudhsm.json#L591:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'BackupProperties' removed or renamed?
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L1070:3
Old: Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/cloudhsm.json#L591:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'RestoreProperties' removed or renamed?
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L1070:3
Old: Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/cloudhsm.json#L591:3
⚠️ 1011 - AddingResponseCode The new version adds a response code '202'.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L138:11
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L87:13
Old: Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/cloudhsm.json#L87:13
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v6/types.json#L266:9
Old: Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/cloudhsm.json#L830:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L151:13
Old: Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/cloudhsm.json#L150:13
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L191:13
Old: Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/cloudhsm.json#L190:13
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L242:13
Old: Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/cloudhsm.json#L243:13
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L288:13
Old: Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/cloudhsm.json#L289:13
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L334:13
Old: Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/cloudhsm.json#L335:13
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L379:13
Old: Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/cloudhsm.json#L380:13
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L436:13
Old: Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/cloudhsm.json#L434:13
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L490:13
Old: Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/cloudhsm.json#L490:13
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L533:13
Old: Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/cloudhsm.json#L533:13
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L575:13
Old: Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/cloudhsm.json#L575:13
⚠️ 1023 - TypeFormatChanged The new version has a different format 'uri' than the previous one ''.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L142:15
Old: Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/cloudhsm.json#L142:15
⚠️ 1023 - TypeFormatChanged The new version has a different format 'uri' than the previous one ''.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L230:15
Old: Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/cloudhsm.json#L232:15
⚠️ 1023 - TypeFormatChanged The new version has a different format 'uri' than the previous one ''.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L478:15
Old: Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/cloudhsm.json#L479:15
⚠️ 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.HardwareSecurityModules/preview/2018-10-31-preview/dedicatedhsm.json#L708:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L45:9
Old: Microsoft.HardwareSecurityModules/preview/2018-10-31-preview/dedicatedhsm.json#L81:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L107:9
Old: Microsoft.HardwareSecurityModules/preview/2018-10-31-preview/dedicatedhsm.json#L149:9
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 26 Warnings warning [Detail]
Compared specs (v2.2.2) new version base version
package-preview-2024-06 package-preview-2024-06(26c8a88) default(main)

[must fix]The following errors/warnings are introduced by current PR:

Only 23 items are listed, please refer to log for more details.

Rule Message Related RPC [For API reviewers]
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L88
⚠️ PatchSkuProperty The patch operation body parameter schema should contain property 'sku'.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L121
RPC-Patch-V1-09
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L152
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L192
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L243
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L289
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L335
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of privatelinks.json.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L374
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L380
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L437
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L491
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L534
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L576
⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'validatebackupproperties' in:'CloudHsmClusters_ValidateBackup'. Consider updating the operationId
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L595
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L663
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L747
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L812
⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'validaterestoreproperties' in:'CloudHsmClusters_ValidateRestore'. Consider updating the operationId
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L834
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L902
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L987
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L1052
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L1146
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L1454


The following errors/warnings exist before current PR submission:

Rule Message
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:type.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L126
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.HardwareSecurityModules/preview/2024-06-30-preview/cloudhsm.json#L395
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L84
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L150
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L200
ProvisioningStateValidation ProvisioningState must have terminal states: Succeeded, Failed and Canceled.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L521
⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'DedicatedHsmModel'. Consider using the plural form of 'DedicatedHsm' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L42
⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'DedicatedHsmModel'. Consider using the plural form of 'DedicatedHsm' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L104
⚠️ PatchSkuProperty The patch operation body parameter schema should contain property 'sku'.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L114
⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'DedicatedHsmModel'. Consider using the plural form of 'DedicatedHsm' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L167
⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'DedicatedHsmModel'. Consider using the plural form of 'DedicatedHsm' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L214
⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'DedicatedHsmModel'. Consider using the plural form of 'DedicatedHsm' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L262
⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'DedicatedHsmModel'. Consider using the plural form of 'DedicatedHsm' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L314
⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'DedicatedHsmModel'. Consider using the plural form of 'DedicatedHsm' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/dedicatedhsm.json#L363
️️✔️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 Jul 5, 2024

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️⚠️ azure-sdk-for-python warning [Detail]
    For more instructions, please refer to the FAQ .
  • ⚠️Warning in generating from 86a9d50dad8274488987d5970a3961b59b4e961c. 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] 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-hardwaresecuritymodules [Preview SDK Changes]
️❌ azure-resource-manager-schemas failed [Detail]
    For more instructions, please refer to the FAQ .
  • Code Generator Failed in generating from 86a9d50dad8274488987d5970a3961b59b4e961c. 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-sdk-for-go succeeded [Detail] [Expand]
    For more instructions, please refer to the FAQ .
  • ️✔️Succeeded in generating from 86a9d50dad8274488987d5970a3961b59b4e961c. 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/hardwaresecuritymodules/armhardwaresecuritymodules [Preview SDK Changes]
️⚠️ azure-powershell warning [Detail]
    For more instructions, please refer to the FAQ .
  • ⚠️Warning in generating from 86a9d50dad8274488987d5970a3961b59b4e961c. 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.hardwaresecuritymodules.DefaultTag [Preview SDK Changes]
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    For more instructions, please refer to the FAQ .
  • ️✔️Succeeded in generating from 86a9d50dad8274488987d5970a3961b59b4e961c. 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-hardwaresecuritymodules [Preview SDK Changes]
    info	[Changelog]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Jul 5, 2024

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/hardwaresecuritymodules/armhardwaresecuritymodules https://apiview.dev/Assemblies/Review/f41402790b9144c8ab8fd2377a592ed8?revisionId=cf62735c45a24a23a08ae690633b149e
Java azure-resourcemanager-hardwaresecuritymodules https://apiview.dev/Assemblies/Review/d242e2e1b4124f1b88d8260f77e624b1?revisionId=989ab4f5c47b4490aec1130a17fa4eab
Swagger Microsoft.HardwareSecurityModules https://apiview.dev/Assemblies/Review/a6149fb1577e4af2a73a0055ae8f3621?revisionId=ccf66f3e537e4db7b16b032ac3ad7184

@AzureRestAPISpecReview AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Jul 5, 2024
@emmeliaAra emmeliaAra changed the title Emmelia ara v3 azure backup changes hardwaresecuritymodules microsoft.hardware security modules 2024 06 30 preview Emmelia ara v3 azure backup changes hardwaresecuritymodules microsoft.hardware security modules 2024-06-30-preview Jul 5, 2024
@emmeliaAra emmeliaAra marked this pull request as ready for review July 5, 2024 11:46
@emmeliaAra
Copy link
Member Author

Hi, @mikekistler
Can you please help with the breaking change on this PR. The changes are already approved in another PR after joining office hours and we need to duplicate the spec version for a preview version.

Already approved PR link: #28651

Copy link
Member

@mikekistler mikekistler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Azure Versioning policy does not allow a GA and a preview API version with the same date. Since PR #28651 is adding this 2024-06-30 GA API version, the new preview must have an API version that is 2024-07-01-preview or later.

Furthermore, you need to merge #28651, and then rerun the pipeline checks before this PR is merged. That should clear any breaking changes issues and if not we'll need to understand why.

@emmeliaAra
Copy link
Member Author

The Azure Versioning policy does not allow a GA and a preview API version with the same date. Since PR #28651 is adding this 2024-06-30 GA API version, the new preview must have an API version that is 2024-07-01-preview or later.

Furthermore, you need to merge #28651, and then rerun the pipeline checks before this PR is merged. That should clear any breaking changes issues and if not we'll need to understand why.

@mikekistler we are planning to release the Preview version and then the GA version. Will it be okay to update the GA version to 2024-07-01 (stable) instead ? We will wait to merge this one and then re-check the breaking changes on the GA PR.

@mikekistler
Copy link
Member

Please come to Breaking Change office hours on Monday at 10AM PT, or schedule a separate meeting with me if that's not convenient, so we can talk through this.

@emmeliaAra
Copy link
Member Author

Please come to Breaking Change office hours on Monday at 10AM PT, or schedule a separate meeting with me if that's not convenient, so we can talk through this.

will do, thanks!

@AzureRestAPISpecReview AzureRestAPISpecReview added the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label Jul 8, 2024
@mikekistler mikekistler added the BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. label Jul 8, 2024
"resourceId": {
"type": "string",
"description": "The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...",
"format": "arm-id"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"type": "string",
"description": "The Azure blob storage container Uri which contains the backup",
"format": "uri"
},

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just to be clear , the secret part of the sas uri is not present here right ?

Copy link
Member Author

@emmeliaAra emmeliaAra Jul 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

right, we do not return the SAS token in the result, just the blob storage account and the container: "https://myaccount.blob.core.windows.net/container/container",

}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}/backup": {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

backup

Please keep in mind that by choosing to model these as POSTS , you will not be able to trigger these in ARM templates or invoke these as part of ARM policy affects . Is this acceptable for your scenarios ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @raosuhas, what is ARM policy affect?

@raosuhas raosuhas added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jul 15, 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 Jul 15, 2024
@AzureRestAPISpecReview AzureRestAPISpecReview removed the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label Jul 31, 2024
@AzureRestAPISpecReview AzureRestAPISpecReview added the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label Jul 31, 2024
@emmeliaAra
Copy link
Member Author

Can you please fix the LintDiff warnings introduced in this PR : https://github.com/Azure/azure-rest-api-specs/pull/29712/checks?check_run_id=27324030518

Hi @raosuhas, resolved the LintDiff warnings were possible. Please have a look at the ones below:

For LatestVersionOfCommonTypesMustBeUsed: I am using v6 and it is saying to use latest v5. Shall I downgrade or is it a false positive ?

For PatchSkuProperty: Our service does not support Patch update. I added x-ms-mutability[read, create] in SKU definition (link)

For EnumInsteadOfBoolean: This value used to be an enum but it was confusing to customers. It can only have 2 values. ApprovedFips or NotApprovedFips so we made it a Boolean instead.

For PageableOperation: the get operation that the warning is flagged on, it is just a GET on a specific resource and it will only return max one dedicated HSM resource and never a list.

Thanks!

@emmeliaAra emmeliaAra removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Aug 1, 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 Aug 1, 2024
@emmeliaAra
Copy link
Member Author

@raosuhas gentle ping. Made some changes based on the feedback, can you have a look on the updates?

@rkmanda rkmanda added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Aug 10, 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 10, 2024
@emmeliaAra emmeliaAra added PublishToCustomers Acknowledgement the changes will be published to Azure customers. and removed PublishToCustomers Acknowledgement the changes will be published to Azure customers. labels Aug 12, 2024
@emmeliaAra emmeliaAra added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Aug 20, 2024
@emmeliaAra emmeliaAra dismissed mikekistler’s stale review August 20, 2024 09:54

Had an offline call, and changes are approved with breaking-Change approved label

@emmeliaAra emmeliaAra merged commit e8a00d5 into Azure:main Aug 21, 2024
28 of 30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. 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. ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants