API addition for supporting customer managed keys in Backup Service #11211
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Swagger Validation Report
|
| Rule | Message |
|---|---|
| 'PUT' operation 'BackupResourceEncryptionConfigs_Update' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.RecoveryServices/stable/2020-10-01/cmk.json#L70 |
|
| Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.RecoveryServices/stable/2020-10-01/cmk.json#L219 |
|
| 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: 'BackupResourceEncryptionConfigs_Update' Request Model: 'BackupResourceEncryptionConfigResource' Response Model: '' New: Microsoft.RecoveryServices/stable/2020-10-01/cmk.json#L65 |
|
| 200/201 Responses of long running operations must have a schema definition for return type. OperationId: 'BackupResourceEncryptionConfigs_Update', Response code: '200' New: Microsoft.RecoveryServices/stable/2020-10-01/cmk.json#L98 |
|
| The child tracked resource, 'operationResults' with immediate parent 'ProtectionContainerResource', must have a list by immediate parent operation. New: Microsoft.RecoveryServices/stable/2016-08-10/operations.json#L53 |
|
| The child tracked resource, 'operationResults' with immediate parent 'JobResource', must have a list by immediate parent operation. New: Microsoft.RecoveryServices/stable/2016-08-10/operations.json#L53 |
|
| The child tracked resource, 'operationResults' with immediate parent 'ProtectionPolicyResource', must have a list by immediate parent operation. New: Microsoft.RecoveryServices/stable/2016-08-10/operations.json#L53 |
|
| The child tracked resource, 'operations' with immediate parent 'ProtectionPolicyResource', must have a list by immediate parent operation. New: Microsoft.RecoveryServices/stable/2016-08-10/operations.json#L53 |
|
| The child tracked resource, 'operationsStatus' with immediate parent 'ProtectedItemResource', must have a list by immediate parent operation. New: Microsoft.RecoveryServices/stable/2016-08-10/operations.json#L53 |
️⚠️~[Staging] Avocado: 1 Warnings warning [Detail] [Expand]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/recoveryservicesbackup/resource-manager/readme.md tag: specification/recoveryservicesbackup/resource-manager/readme.md#tag-package-2020-10 |
️️✔️~[Staging] ModelValidation succeeded [Detail]
Validation passes for ModelValidation.
️️✔️~[Staging] SemanticValidation succeeded [Detail]
Validation passes for SemanticValidation.
️️✔️~[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail]
There are no breaking changes.
️️✔️~[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail]
There are no breaking changes.
|
Azure Pipelines successfully started running 1 pipeline(s). |
Azure CLI Extension Generation - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
azure-sdk-for-go - Release
|
azure-sdk-for-java - Release
|
azure-sdk-for-js - Release
|
azure-sdk-for-net - Release
|
azure-sdk-for-python - Release
- Breaking Change detected in SDK
|
Trenton Generation - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
azure-sdk-for-python-track2 - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
azure-resource-manager-schemas - Release
|
This was referenced Oct 15, 2020
|
Azure Pipelines successfully started running 1 pipeline(s). |
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @geethasmsft your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @qianwens |
majastrz
added
ARMChangesRequested
|
Can you fix this PR or create a new one where the first commit is the unchanged previous API version in the new location, so I can diff the delta easily. Alternatively, can you provide a link to the previous API version (in a PR or committed is fine)? |
majastrz
reviewed
Oct 29, 2020
| "application/json" | ||
| ], | ||
| "paths": { | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupEncryptionConfigs/backupResourceEncryptionConfig": { |
There was a problem hiding this comment.
backupResourceEncryptionConfig [](start = 152, length = 30)
Is this the only name that is allowed? If yes, the typical singleton resource pattern is to use one of these pre-approved names: default, main, current, latest. In addition you should also have the ability to list all backupEncryptionConfigs (yes, even if there's only one).
There was a problem hiding this comment.
We are considering retaining the backupResourceEncryptionConfigs, as this will break existing users. We will add the List API in the next pull request.
majastrz
reviewed
Oct 29, 2020
| } | ||
| } | ||
| }, | ||
| "put": { |
There was a problem hiding this comment.
put [](start = 7, length = 3)
I see that there's no delete. DOes this mean that the resource always exists and can only be updated?
There was a problem hiding this comment.
That is right. This can only be updated.
majastrz
reviewed
Oct 29, 2020
...icrosoft.RecoveryServices/stable/2020-10-01/examples/BackupResourceEncryptionConfig_Get.json
Show resolved
Hide resolved
majastrz
reviewed
Oct 29, 2020
...ecoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2020-10-01/bms.json
Outdated
Show resolved
Hide resolved
|
Please go through the contribution checklist added as part of the review and mark them completed. Also Please go through the ARM API Review Checklist. These steps are required before review can be continued. |
Swagger Generation Artifacts
|
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Hi, @geethasmsft Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com |
chiragg4u
added
ARMSignedOff
|
Marking ARMApproved based on the comment resolution. There are still some feedback which I would ask the team to resolve in the later versions. |
qianwens
approved these changes
Nov 9, 2020
giromm2ms
pushed a commit
to giromm2ms/azure-rest-api-specs
that referenced
this pull request
Dec 20, 2020
…zure#11211) * CMK Changes * CMK Changes2 * Undoing changes to prev versions * Fixing errors * json rename as per feedback * json rename as per feedback
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.
Please follow the link to find more details on PR review process.