-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Dev dataprotection microsoft.data protection 2023 08 01 #26372
Dev dataprotection microsoft.data protection 2023 08 01 #26372
Conversation
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
dataprotection.json | 2023-08-01(10dcdc6) | 2023-05-01(main) |
dataprotection.json | 2023-08-01(10dcdc6) | 2023-08-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Rule | Message |
---|---|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/validateForModifyBackup' removed or restructured? Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1369:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/fetchSecondaryRecoveryPoints' removed or restructured? Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1619:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/crossRegionRestore' removed or restructured? Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1694:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/validateCrossRegionRestore' removed or restructured? Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1772:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/fetchCrossRegionRestoreJob' removed or restructured? Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1850:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/fetchCrossRegionRestoreJobs' removed or restructured? Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1906:5 |
|
The new version is missing a path that was found in the old version. Was path '/{resourceId}/providers/Microsoft.DataProtection/backupInstances' removed or restructured? Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1965:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/{jobId}/triggerCancel' removed or restructured? Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2729:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/{jobId}/generateProgressUrl' removed or restructured? Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2793:5 |
|
The new version is missing a definition that was found in the old version. Was 'CrossRegionRestoreJobRequest' removed or renamed? New: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L3747:3 Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L4333:3 |
|
The new version is missing a definition that was found in the old version. Was 'CrossRegionRestoreJobsRequest' removed or renamed? New: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L3747:3 Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L4333:3 |
|
The new version is missing a definition that was found in the old version. Was 'FetchSecondaryRPsRequestParameters' removed or renamed? New: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L3747:3 Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L4333:3 |
|
The new version is missing a definition that was found in the old version. Was 'CmkKeyVaultProperties' removed or renamed? New: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L3747:3 Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L4333:3 |
|
The new version is missing a definition that was found in the old version. Was 'CmkKekIdentity' removed or renamed? New: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L3747:3 Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L4333:3 |
|
The new version is missing a definition that was found in the old version. Was 'encryptionSettings' removed or renamed? New: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L3747:3 Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L4333:3 |
|
The new version is missing a definition that was found in the old version. Was 'CrossRegionRestoreDetails' removed or renamed? New: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L3747:3 Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L4333:3 |
|
The new version is missing a definition that was found in the old version. Was 'ValidateCrossRegionRestoreRequestObject' removed or renamed? New: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L3747:3 Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L4333:3 |
|
The new version is missing a definition that was found in the old version. Was 'CrossRegionRestoreRequestObject' removed or renamed? New: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L3747:3 Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L4333:3 |
|
The new version is missing a definition that was found in the old version. Was 'ValidateForModifyBackupRequest' removed or renamed? New: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L3747:3 Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L4333:3 |
|
The new version is missing a client parameter that was found in the old version. Was 'ResourceId' removed or renamed? New: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L7609:3 Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L8427:3 |
|
The new version is missing a client parameter that was found in the old version. Was 'RestrictedVaultName' removed or renamed? New: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L7609:3 Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L8427:3 |
|
The new version has a different format than the previous one. New: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L6634:9 Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L7428:9 |
|
The new version has a different format than the previous one. New: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L6639:9 Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L7432:9 |
|
The new version is missing a property found in the old version. Was 'encryptionSettings' renamed or removed? New: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L7071:7 Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L7856:7 |
|
The new version is missing a property found in the old version. Was 'warningDetails' renamed or removed? New: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L6089:7 Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L6822:7 |
|
The new version is missing a property found in the old version. Was 'sourceDataStoreType' renamed or removed? New: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L3989:7 Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L4575:7 |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.6) | new version | base version |
---|---|---|
package-2023-08 | package-2023-08(10dcdc6) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L42 |
LroExtension |
Operations with a 202 response must specify x-ms-long-running-operation: true .Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L64 |
ParametersOrder |
The parameters:operationId,location should be kept in the same order as they present in the path. Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L64 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L94 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L307 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L426 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L440 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L467 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L476 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L526 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L532 |
LroExtension |
Operations with a 202 response must specify x-ms-long-running-operation: true .Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L545 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L580 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L740 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L788 |
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.DataProtection/stable/2023-08-01/dataprotection.json#L860 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L996 |
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.DataProtection/stable/2023-08-01/dataprotection.json#L1064 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L1128 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L1139 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L1193 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L1269 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L1345 |
LroExtension |
Operations with a 202 response must specify x-ms-long-running-operation: true .Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L1361 |
OperationIdNounVerb |
Per the Noun_Verb convention for Operation Ids, the noun 'BackupInstances' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L1366 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L1400 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L1400 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L1461 |
PostResponseCodes |
Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes. Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L1538 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DataProtection/stable/2023-08-01/dataprotection.json#L1595 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌
SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️
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.
️️✔️
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).
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
Hi @soumyapattnaik! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. |
"x-ms-identifiers": [], | ||
"type": "array" | ||
}, | ||
"stagingResourceGroupId": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it an azure resource ID? If so, please add "format": "arm-id" and "x-ms-arm-id-details".
https://github.com/Azure/autorest/blob/main/docs/extensions/readme.md#x-ms-arm-id-details
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
"description": "Gets or sets the staging RG Id for creating staging disks and snapshots during restore from vault.", | ||
"type": "string" | ||
}, | ||
"stagingStorageAccountId": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it an azure resource ID? If so, please add "format": "arm-id" and "x-ms-arm-id-details".
https://github.com/Azure/autorest/blob/main/docs/extensions/readme.md#x-ms-arm-id-details
Please address or respond to feedback from the ARM API reviewer. |
/pr RequestMerge |
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
Swagger pipeline restarted successfully, please wait for status update in this comment. |
* Adds base for updating Microsoft.DataProtection from version stable/2023-05-01 to version 2023-08-01 * Updates readme * Updates API version in new specs and examples * changes for vault tier * code review changes --------- Co-authored-by: Shashank Singh <shashank1306s@gmail.com>
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequested
is removed from your PR. This should cause the label
WaitForARMFeedback
to be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting help
section below.Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
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:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReview
label.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
Swagger-Suppression-Process
to get approval.
Getting help
and https://aka.ms/ci-fix.