[Hub Generated] Review request for Microsoft.KeyVault to add version stable/2022-11-01
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
This PR adds a set of Managed HSM key operations CreateKeyIfNotExists/ List/Get Keys and KeyVersions via control plane. This will help integrate partners to call MHSM key operations via MHSM control plane itself.
ARM API Information (Control Plane)
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
- What's the purpose of the update?
- [ ] new service onboarding
- [x] new API version
- [ ] update existing version for new feature
- [ ] update existing version to fix swagger quality issue in s360
- [ ] Other, please clarify
- When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
- When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. We plan to deploy service next week, 10/10/2022.
- By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
Contribution checklist (MS Employees Only):
- [x] I commit to follow the Breaking Change Policy of "no breaking changes"
- [x] I have reviewed the documentation for the workflow.
- [x] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Applicability: :warning:
If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.
- Change to data plane APIs
- Adding new properties
- All removals
Otherwise your PR may be subject to ARM review requirements. Complete the following:
-
[x] Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
-
[x] Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
-
[ ] If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.
Hi, @riteshchitlangia1 Thanks for your PR. I am workflow bot for review process. Here are some small tips.
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 3 Warnings warning [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| common.json | 2022-11-01(4b0f04d) | 2022-07-01(main) |
| common.json | 2022-11-01(4b0f04d) | 2022-02-01-preview(main) |
| keys.json | 2022-11-01(4b0f04d) | 2022-07-01(main) |
| keys.json | 2022-11-01(4b0f04d) | 2022-02-01-preview(main) |
| keyvault.json | 2022-11-01(4b0f04d) | 2022-07-01(main) |
| keyvault.json | 2022-11-01(4b0f04d) | 2022-02-01-preview(main) |
| managedHsm.json | 2022-11-01(4b0f04d) | 2022-07-01(main) |
| managedHsm.json | 2022-11-01(4b0f04d) | 2022-02-01-preview(main) |
| providers.json | 2022-11-01(4b0f04d) | 2022-07-01(main) |
| providers.json | 2022-11-01(4b0f04d) | 2022-02-01-preview(main) |
| secrets.json | 2022-11-01(4b0f04d) | 2022-07-01(main) |
| secrets.json | 2022-11-01(4b0f04d) | 2022-02-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| :warning: 1027 - DefaultValueChanged | The new version has a different default value than the previous one. New: Microsoft.KeyVault/stable/2022-11-01/keys.json#L482:9 Old: Microsoft.KeyVault/preview/2022-02-01-preview/keys.json#L482:9 |
| :warning: 1027 - DefaultValueChanged | The new version has a different default value than the previous one. New: Microsoft.KeyVault/stable/2022-11-01/managedHsm.json#L1248:9 Old: Microsoft.KeyVault/preview/2022-02-01-preview/managedHsm.json#L1248:9 |
| :warning: 1027 - DefaultValueChanged | The new version has a different default value than the previous one. New: Microsoft.KeyVault/stable/2022-11-01/managedHsm.json#L1260:9 Old: Microsoft.KeyVault/preview/2022-02-01-preview/managedHsm.json#L1261:9 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 13 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2022-11 | package-2022-11(4b0f04d) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| :warning: PutRequestResponseScheme | A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'ManagedHsmKeys_CreateIfNotExist' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema' Location: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L14 |
|
| :warning: RequiredReadOnlySystemData | The response of operation:'ManagedHsmKeys_CreateIfNotExist' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L14 |
|
| :warning: RequiredReadOnlySystemData | The response of operation:'ManagedHsmKeys_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L72 |
|
| :warning: RequiredReadOnlySystemData | The response of operation:'ManagedHsmKeys_GetVersion' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L174 |
|
| :warning: 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.KeyVault/stable/2022-11-01/keysManagedHsm.json#L368 |
|
| :warning: 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.KeyVault/stable/2022-11-01/keysManagedHsm.json#L412 |
|
| :warning: AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L429 |
|
| :warning: SchemaDescriptionOrTitle | Schema should have a description or title. Location: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L477 |
|
| :warning: SchemaDescriptionOrTitle | Schema should have a description or title. Location: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L494 |
|
| :warning: SchemaDescriptionOrTitle | Schema should have a description or title. Location: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L515 |
|
| :warning: SchemaDescriptionOrTitle | Schema should have a description or title. Location: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L528 |
|
| :warning: SchemaDescriptionOrTitle | Schema should have a description or title. Location: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L541 |
|
| :warning: SchemaDescriptionOrTitle | Schema should have a description or title. Location: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L558 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
AllResourcesMustHaveDelete |
The resource Key does not have a corresponding delete operation. Location: Microsoft.KeyVault/stable/2022-11-01/keys.json#L13 |
TrackedResourcePatchOperation |
Tracked resource 'Key' must have patch operation that at least supports the update of tags. Location: Microsoft.KeyVault/stable/2022-11-01/keys.json#L13 |
DefinitionsPropertiesNamesCamelCase |
Property name should be camel case. Location: Microsoft.KeyVault/stable/2022-11-01/keys.json#L428 |
XmsParameterLocation |
The parameter 'SubscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.KeyVault/stable/2022-11-01/keys.json#L646 |
XmsParameterLocation |
The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.KeyVault/stable/2022-11-01/keys.json#L653 |
GetCollectionResponseSchema |
The response in the GET collection operation 'Keys_List' does not match the response definition in the individual GET operation 'Keys_Get' . Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L12 |
GetCollectionResponseSchema |
The response in the GET collection operation 'Keys_ListVersions' does not match the response definition in the individual GET operation 'Keys_GetVersion' . Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L12 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L14 |
AllResourcesMustHaveDelete |
The resource VaultAccessPolicyParameters does not have a corresponding delete operation. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L267 |
TrackedResourcePatchOperation |
Tracked resource 'VaultAccessPolicyParameters' must have patch operation that at least supports the update of tags. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L267 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L511 |
ParametersOrder |
The parameters:vaultName,location should be kept in the same order as they present in the path. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L512 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L567 |
ParametersOrder |
The parameters:vaultName,location should be kept in the same order as they present in the path. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L568 |
PostOperationAsyncResponseValidation |
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L568 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L601 |
PathContainsResourceType |
The path for the CURD methods do not contain a resource type. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L624 |
ResourceNameRestriction |
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L750 |
TrackedResourcePatchOperation |
Tracked resource 'PrivateEndpointConnection' must have patch operation that at least supports the update of tags. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L750 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L789 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L869 |
DeleteResponseBodyEmpty |
The delete response body must be empty. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L903 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L1067 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L1076 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L1216 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L1296 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L1333 |
NestedResourcesMustHaveListOperation |
The nested resource 'VaultAccessPolicyParameters' does not have list operation, please add it. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L1511 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L1780 |
XmsParameterLocation |
The parameter 'SubscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L2030 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 66 Errors, 0 Warnings failed [Detail]
Tag package-2022-11; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 47, untested: 0, failed: 28, passed: 19
Service API Readiness Test failed. Check pipeline artifact for detail report.
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
CLIENT_ERROR |
statusCode: 404, errorCode: DeletedVaultNotFound, errorMessage: The specified deleted vault 'vaultnamuwqdpo' does not exist. Ensure that the vault was indeed deleted and that it is in recoverable state. If soft delete was not enabled then the vault is permanently deleted. Follow this link for more information: https://go.microsoft.com/fwlink/?linkid=2149745 Source: runtime OperationId: Vaults_GetDeleted |
CLIENT_ERROR |
statusCode: 400, errorCode: InvalidApiVersionParameter, errorMessage: The api-version '2022-11-01' is invalid. The supported versions are '2022-12-01,2022-11-01-preview,2022-09-01,2022-06-01,2022-05-01,2022-03-01-preview,2022-01-01,2021-04-01,2021-01-01,2020-10-01,2020-09-01,2020-08-01,2020-07-01,2020-06-01,2020-05-01,2020-01-01,2019-11-01,2019-10-01,2019-09-01,2019-08-01,2019-07-01,2019-06-01,2019-05-10,2019-05-01,2019-03-01,2018-11-01,2018-09-01,2018-08-01,2018-07-01,2018-06-01,2018-05-01,2018-02-01,2018-01-01,2017-12-01,2017-08-01,2017-06-01,2017-05-10,2017-05-01,2017-03-01,2016-09-01,2016-07-01,2016-06-01,2016-02-01,2015-11-01,2015-01-01,2014-04-01-preview,2014-04-01,2014-01-01,2013-03-01,2014-02-26,2014-04'. Source: runtime OperationId: Vaults_List |
ENUM_MISMATCH |
No enum match for: 2022-11-01 Source: request OperationId: Vaults_List |
ENUM_CASE_MISMATCH |
Enum does not match case for: Standard Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: Get Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: List Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: Update Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: Create Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: Import Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: Delete Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: Recover Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: Backup Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: Restore Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: Get Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: List Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: Set Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: Delete Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: Recover Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: Backup Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: Restore Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: Get Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: List Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: Update Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: Create Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: Import Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: Delete Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: Recover Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: Backup Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: Restore Source: response OperationId: Vaults_ListBySubscription |
ENUM_CASE_MISMATCH |
Enum does not match case for: ManageContacts Source: response OperationId: Vaults_ListBySubscription |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
️🔄ApiDocPreview inProgress [Detail]
️❌SDK Breaking Change Tracking failed [Detail]
Breaking Changes Tracking
❌azure-sdk-for-go - sdk/resourcemanager/keyvault/armkeyvault - 2.0.0+ Struct `CloudErrorBody` has been removed + Struct `CloudError` has been removed
❌azure-sdk-for-js - @azure/arm-keyvault - 3.0.0+ Interface MhsmPrivateEndpointConnectionsDeleteHeaders no longer has parameter retryAfter
️⌛ azure-sdk-for-net-track2 pending [Detail]
️⌛ azure-sdk-for-python-track2 pending [Detail]
️⌛ azure-sdk-for-java pending [Detail]
️🔄 azure-sdk-for-go inProgress [Detail]
️⌛ azure-sdk-for-js pending [Detail]
️🔄 azure-resource-manager-schemas inProgress [Detail]
️🔄 azure-powershell inProgress [Detail]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/keyvault/armkeyvault | https://apiview.dev/Assemblies/Review/9ca081fb06fc4ac5a89384685b7e852c |
| Java | azure-resourcemanager-keyvault-generated | https://apiview.dev/Assemblies/Review/c92f73ecd05b43c6b9295ac29707d1ec |
| .Net | Azure.ResourceManager.KeyVault | There is no API change compared with the previous version |
| JavaScript | @azure/arm-keyvault | https://apiview.dev/Assemblies/Review/0e44898bb3234028a7622bf8e7b07c93 |
Hi @riteshchitlangia1, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic validation | Fix-SemanticValidation-Error | High |
| Model validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | high |
Hi, @riteshchitlangia1 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).
/azp run unifiedPipeline
No pipelines are associated with this pull request.
@qiaozha @ArcturusZhang could you have a look at the breakingchange of SDK?
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested
/azp run unifiedPipeline
No pipelines are associated with this pull request.
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️❌SDK Breaking Change Tracking failed [Detail]
Breaking Changes Tracking
❌azure-sdk-for-go - sdk/resourcemanager/keyvault/armkeyvault - 2.0.0+ Struct `CloudErrorBody` has been removed + Struct `CloudError` has been removed
❌azure-sdk-for-js - @azure/arm-keyvault - 3.0.0+ Interface ManagedHsmsListByResourceGroupNextOptionalParams no longer has parameter top + Interface ManagedHsmsListBySubscriptionNextOptionalParams no longer has parameter top + Interface MhsmPrivateEndpointConnectionsDeleteHeaders no longer has parameter retryAfter + Interface SecretsListNextOptionalParams no longer has parameter top + Interface VaultsListByResourceGroupNextOptionalParams no longer has parameter top + Interface VaultsListBySubscriptionNextOptionalParams no longer has parameter top + Interface VaultsListNextOptionalParams no longer has parameter top
️⚠️ azure-sdk-for-net-track2 warning [Detail]
⚠️Warning [Logs]Release - Generate from a188b86bdffb9a8240d9722590d5316b177373e7. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json command pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json warn No file changes detected after generation
️✔️Azure.ResourceManager.KeyVault [View full logs]info [Changelog]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs]Release - Generate from a188b86bdffb9a8240d9722590d5316b177373e7. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json cmderr [automation_generate.sh] cmderr [automation_generate.sh] npm notice New major version of npm available! 8.19.3 -> 9.4.1 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.4.1> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-keyvault [View full logs] [Release SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - Model ManagedHsmProperties has a new parameter security_domain_properties
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs]Release - Generate from a188b86bdffb9a8240d9722590d5316b177373e7. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json cmderr [init.sh] [notice] A new release of pip available: 22.3.1 -> 23.0 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] [notice] A new release of pip available: 22.3.1 -> 23.0 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
️✔️azure-resourcemanager-keyvault-generated [View full logs] [Release SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from a188b86bdffb9a8240d9722590d5316b177373e7. SDK Automation 14.0.0command sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json command generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
️✔️sdk/resourcemanager/keyvault/armkeyvault [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Struct `CloudError` has been removed info [Changelog] - Struct `CloudErrorBody` has been removed info [Changelog] info [Changelog] ### Features Added info [Changelog] info [Changelog] - New value `JSONWebKeyOperationRelease` added to type alias `JSONWebKeyOperation` info [Changelog] - New value `KeyPermissionsGetrotationpolicy`, `KeyPermissionsRelease`, `KeyPermissionsRotate`, `KeyPermissionsSetrotationpolicy` added to type alias `KeyPermissions` info [Changelog] - New type alias `ActivationStatus` with values `ActivationStatusActive`, `ActivationStatusFailed`, `ActivationStatusNotActivated`, `ActivationStatusUnknown` info [Changelog] - New type alias `KeyRotationPolicyActionType` with values `KeyRotationPolicyActionTypeNotify`, `KeyRotationPolicyActionTypeRotate` info [Changelog] - New function `NewManagedHsmKeysClient(string, azcore.TokenCredential, *arm.ClientOptions) (*ManagedHsmKeysClient, error)` info [Changelog] - New function `*ManagedHsmKeysClient.CreateIfNotExist(context.Context, string, string, string, ManagedHsmKeyCreateParameters, *ManagedHsmKeysClientCreateIfNotExistOptions) (ManagedHsmKeysClientCreateIfNotExistResponse, error)` info [Changelog] - New function `*ManagedHsmKeysClient.Get(context.Context, string, string, string, *ManagedHsmKeysClientGetOptions) (ManagedHsmKeysClientGetResponse, error)` info [Changelog] - New function `*ManagedHsmKeysClient.GetVersion(context.Context, string, string, string, string, *ManagedHsmKeysClientGetVersionOptions) (ManagedHsmKeysClientGetVersionResponse, error)` info [Changelog] - New function `*ManagedHsmKeysClient.NewListPager(string, string, *ManagedHsmKeysClientListOptions) *runtime.Pager[ManagedHsmKeysClientListResponse]` info [Changelog] - New function `*ManagedHsmKeysClient.NewListVersionsPager(string, string, string, *ManagedHsmKeysClientListVersionsOptions) *runtime.Pager[ManagedHsmKeysClientListVersionsResponse]` info [Changelog] - New function `*ManagedHsmsClient.CheckMhsmNameAvailability(context.Context, CheckMhsmNameAvailabilityParameters, *ManagedHsmsClientCheckMhsmNameAvailabilityOptions) (ManagedHsmsClientCheckMhsmNameAvailabilityResponse, error)` info [Changelog] - New struct `Action` info [Changelog] - New struct `CheckMhsmNameAvailabilityParameters` info [Changelog] - New struct `CheckMhsmNameAvailabilityResult` info [Changelog] - New struct `KeyReleasePolicy` info [Changelog] - New struct `KeyRotationPolicyAttributes` info [Changelog] - New struct `LifetimeAction` info [Changelog] - New struct `ManagedHSMSecurityDomainProperties` info [Changelog] - New struct `ManagedHsmAction` info [Changelog] - New struct `ManagedHsmKey` info [Changelog] - New struct `ManagedHsmKeyAttributes` info [Changelog] - New struct `ManagedHsmKeyCreateParameters` info [Changelog] - New struct `ManagedHsmKeyListResult` info [Changelog] - New struct `ManagedHsmKeyProperties` info [Changelog] - New struct `ManagedHsmKeyReleasePolicy` info [Changelog] - New struct `ManagedHsmKeyRotationPolicyAttributes` info [Changelog] - New struct `ManagedHsmKeysClient` info [Changelog] - New struct `ManagedHsmKeysClientListResponse` info [Changelog] - New struct `ManagedHsmKeysClientListVersionsResponse` info [Changelog] - New struct `ManagedHsmLifetimeAction` info [Changelog] - New struct `ManagedHsmRotationPolicy` info [Changelog] - New struct `ManagedHsmTrigger` info [Changelog] - New struct `ProxyResourceWithoutSystemData` info [Changelog] - New struct `RotationPolicy` info [Changelog] - New struct `Trigger` info [Changelog] - New field `ReleasePolicy` in struct `KeyProperties` info [Changelog] - New field `RotationPolicy` in struct `KeyProperties` info [Changelog] - New field `Etag` in struct `MHSMPrivateEndpointConnectionItem` info [Changelog] - New field `ID` in struct `MHSMPrivateEndpointConnectionItem` info [Changelog] - New field `SecurityDomainProperties` in struct `ManagedHsmProperties` info [Changelog] info [Changelog] Total 4 breaking change(s), 71 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from a188b86bdffb9a8240d9722590d5316b177373e7. SDK Automation 14.0.0command sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json warn File azure-sdk-for-js_tmp/initOutput.json not found to read command sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
️✔️@azure/arm-keyvault [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] **Features** info [Changelog] info [Changelog] - Added operation group ManagedHsmKeys info [Changelog] - Added operation ManagedHsms.checkMhsmNameAvailability info [Changelog] - Added Interface Action info [Changelog] - Added Interface CheckMhsmNameAvailabilityParameters info [Changelog] - Added Interface CheckMhsmNameAvailabilityResult info [Changelog] - Added Interface Key info [Changelog] - Added Interface KeyReleasePolicy info [Changelog] - Added Interface KeyRotationPolicyAttributes info [Changelog] - Added Interface LifetimeAction info [Changelog] - Added Interface ManagedHsm info [Changelog] - Added Interface ManagedHsmAction info [Changelog] - Added Interface ManagedHsmKey info [Changelog] - Added Interface ManagedHsmKeyAttributes info [Changelog] - Added Interface ManagedHsmKeyCreateParameters info [Changelog] - Added Interface ManagedHsmKeyListResult info [Changelog] - Added Interface ManagedHsmKeyProperties info [Changelog] - Added Interface ManagedHsmKeyReleasePolicy info [Changelog] - Added Interface ManagedHsmKeyRotationPolicyAttributes info [Changelog] - Added Interface ManagedHsmKeysCreateIfNotExistOptionalParams info [Changelog] - Added Interface ManagedHsmKeysGetOptionalParams info [Changelog] - Added Interface ManagedHsmKeysGetVersionOptionalParams info [Changelog] - Added Interface ManagedHsmKeysListNextOptionalParams info [Changelog] - Added Interface ManagedHsmKeysListOptionalParams info [Changelog] - Added Interface ManagedHsmKeysListVersionsNextOptionalParams info [Changelog] - Added Interface ManagedHsmKeysListVersionsOptionalParams info [Changelog] - Added Interface ManagedHsmLifetimeAction info [Changelog] - Added Interface ManagedHsmRotationPolicy info [Changelog] - Added Interface ManagedHsmsCheckMhsmNameAvailabilityOptionalParams info [Changelog] - Added Interface ManagedHsmsCreateOrUpdateHeaders info [Changelog] - Added Interface ManagedHsmsDeleteHeaders info [Changelog] - Added Interface ManagedHSMSecurityDomainProperties info [Changelog] - Added Interface ManagedHsmsPurgeDeletedHeaders info [Changelog] - Added Interface ManagedHsmsUpdateHeaders info [Changelog] - Added Interface ManagedHsmTrigger info [Changelog] - Added Interface MhsmPrivateEndpointConnection info [Changelog] - Added Interface MhsmPrivateLinkResource info [Changelog] - Added Interface PrivateEndpointConnection info [Changelog] - Added Interface PrivateLinkResource info [Changelog] - Added Interface ProxyResourceWithoutSystemData info [Changelog] - Added Interface RotationPolicy info [Changelog] - Added Interface Secret info [Changelog] - Added Interface SecretAttributes info [Changelog] - Added Interface Trigger info [Changelog] - Added Type Alias ActivationStatus info [Changelog] - Added Type Alias KeyRotationPolicyActionType info [Changelog] - Added Type Alias ManagedHsmKeysCreateIfNotExistResponse info [Changelog] - Added Type Alias ManagedHsmKeysGetResponse info [Changelog] - Added Type Alias ManagedHsmKeysGetVersionResponse info [Changelog] - Added Type Alias ManagedHsmKeysListNextResponse info [Changelog] - Added Type Alias ManagedHsmKeysListResponse info [Changelog] - Added Type Alias ManagedHsmKeysListVersionsNextResponse info [Changelog] - Added Type Alias ManagedHsmKeysListVersionsResponse info [Changelog] - Added Type Alias ManagedHsmsCheckMhsmNameAvailabilityResponse info [Changelog] - Added Type Alias ManagedHsmsPurgeDeletedResponse info [Changelog] - Interface KeyProperties has a new optional parameter releasePolicy info [Changelog] - Interface KeyProperties has a new optional parameter rotationPolicy info [Changelog] - Interface ManagedHsmProperties has a new optional parameter securityDomainProperties info [Changelog] - Interface MhsmPrivateEndpointConnectionItem has a new optional parameter etag info [Changelog] - Interface MhsmPrivateEndpointConnectionItem has a new optional parameter id info [Changelog] - Added Enum KnownActivationStatus info [Changelog] - Enum KnownJsonWebKeyOperation has a new value Release info [Changelog] - Enum KnownKeyPermissions has a new value Getrotationpolicy info [Changelog] - Enum KnownKeyPermissions has a new value Release info [Changelog] - Enum KnownKeyPermissions has a new value Rotate info [Changelog] - Enum KnownKeyPermissions has a new value Setrotationpolicy info [Changelog] - Added function getContinuationToken info [Changelog] info [Changelog] **Breaking Changes** info [Changelog] info [Changelog] - Interface ManagedHsmsListByResourceGroupNextOptionalParams no longer has parameter top info [Changelog] - Interface ManagedHsmsListBySubscriptionNextOptionalParams no longer has parameter top info [Changelog] - Interface MhsmPrivateEndpointConnectionsDeleteHeaders no longer has parameter retryAfter info [Changelog] - Interface SecretsListNextOptionalParams no longer has parameter top info [Changelog] - Interface VaultsListByResourceGroupNextOptionalParams no longer has parameter top info [Changelog] - Interface VaultsListBySubscriptionNextOptionalParams no longer has parameter top info [Changelog] - Interface VaultsListNextOptionalParams no longer has parameter top
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs]Release - Generate from a188b86bdffb9a8240d9722590d5316b177373e7. Schema Automation 14.0.0command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json cmderr [initScript.sh] WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm, cmderr [initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry. cmderr [initScript.sh] npm WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient... cmderr [initScript.sh] npm WARN old lockfile warn File azure-resource-manager-schemas_tmp/initOutput.json not found to read command .sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
️✔️keyvault [View full logs] [Release Schema Changes]
️❌ azure-powershell failed [Detail]
❌Failed [Logs]Release - Generate from a188b86bdffb9a8240d9722590d5316b177373e7. SDK Automation 14.0.0command sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json command pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
❌Az.keyvault [View full logs] [Release SDK Changes]
Hi @riteshchitlangia1, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval.
Hi @riteshchitlangia1 there are LintDiff error and ModelValidation error you need to fix, LintDiff error you can follow the [Staging] task to fix https://github.com/Azure/azure-rest-api-specs/pull/20839/checks?check_run_id=9039718480
Hi @riteshchitlangia1 there are LintDiff error and ModelValidation error you need to fix, LintDiff error you can follow the [Staging] task to fix https://github.com/Azure/azure-rest-api-specs/pull/20839/checks?check_run_id=9039718480
For LintDiff error there is already an existing suppression carried over from previous change for AKV APIs which had same property name which could not have camelCasing.
ModelValidation errors are from previous files and not newly introduced in this PR.
/azp run
Azure Pipelines successfully started running 1 pipeline(s).
For LintDiff I have seen the suppression, you can ignore this. For ModelValidation, there rules are new rules, you need to fix them. And before merged, the service should be deployed.
Sure, I will check out Model Validation errores again. Yes, I am going to start RP manifest deployment tomorrow.
Thanks, Ritesh
On Sun, Oct 30, 2022, 8:13 PM Tianxiang Chen @.***> wrote:
For LintDiff I have seen the suppression, you can ignore this. For ModelValidation, there rules are new rules, you need to fix them. And before merged, the service should be deployed.
— Reply to this email directly, view it on GitHub https://github.com/Azure/azure-rest-api-specs/pull/20839#issuecomment-1296481647, or unsubscribe https://github.com/notifications/unsubscribe-auth/AOLAWD4A2OA76XAECA7TCQ3WF42OPANCNFSM6AAAAAAQTR4Y3U . You are receiving this because you were mentioned.Message ID: @.***>
For LintDiff I have seen the suppression, you can ignore this. For ModelValidation, there rules are new rules, you need to fix them. And before merged, the service should be deployed.
ModelValidation errors are in files carried over from previous api-versions and not newly introduced in this PR, so will skip those.
For LintDiff I have seen the suppression, you can ignore this. For ModelValidation, there rules are new rules, you need to fix them. And before merged, the service should be deployed.
ModelValidation errors are in files carried over from previous api-versions and not newly introduced in this PR, so will skip those.
Yes, I have seen the previous version PR, that CI check passed, these rules are newly added. As a new api version we should keep it right to avoid carrying over to another new api version.
Hi, @riteshchitlangia1. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
Hi, @riteshchitlangia1. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
Hi, @riteshchitlangia1. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.
Hi @riteshchitlangia1, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki. If you want to know the production traffic statistic, please see ARM Traffic statistic. If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback. Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.
/azp run
Azure Pipelines successfully started running 1 pipeline(s).