Skip to content

Asmitt dataprotection microsoft.data protection 2023 11 01#26663

Merged
asmitt merged 30 commits into
Azure:asmitt-dataprotection-Microsoft.DataProtection-2023-11-01from
soumyapattnaik:asmitt-dataprotection-Microsoft.DataProtection-2023-11-01
Nov 10, 2023
Merged

Asmitt dataprotection microsoft.data protection 2023 11 01#26663
asmitt merged 30 commits into
Azure:asmitt-dataprotection-Microsoft.DataProtection-2023-11-01from
soumyapattnaik:asmitt-dataprotection-Microsoft.DataProtection-2023-11-01

Conversation

@soumyapattnaik
Copy link
Copy Markdown
Contributor

@soumyapattnaik soumyapattnaik commented Nov 10, 2023

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.

diagram

[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!

  • New API version. (Such PR should have been generated with OpenAPI Hub).
  • 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 swagger 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:

Breaking changes review (Step 1)

  • If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
    you must follow the breaking changes process.
    IMPORTANT This applies even if:
    • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
    • You believe there is no need for you to request breaking change approval, for any reason.
      Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.

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

Shashank1306s and others added 30 commits August 10, 2023 10:52
…2023-04-01-preview to version 2023-06-01-preview
* Add RecoveryPointState to DataProtection

* Prettier fixes
* Add RecoveryPointState to DataProtection

* Prettier fixes
@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app Bot commented Nov 10, 2023

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ Your PR has breaking changes in the generated SDK for go (label: CI-BreakingChange-Go). Refer to step 3 in the PR workflow diagram (even if your PR is for data plane, not ARM).
  • ❌ Your PR has breaking changes in the generated SDK for javascript (label: CI-BreakingChange-JavaScript). Refer to step 3 in the PR workflow diagram (even if your PR is for data plane, not ARM).

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app Bot commented Nov 10, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 15 Warnings warning [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
dataprotection.json 2023-11-01(66e4102) 2023-08-01(main)
dataprotection.json 2023-11-01(66e4102) 2023-08-01-preview(main)

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

Rule Message
⚠️ 1005 - RemovedPath 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
⚠️ 1005 - RemovedPath 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
⚠️ 1005 - RemovedPath 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
⚠️ 1005 - RemovedPath 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
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'CmkKeyVaultProperties' removed or renamed?
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L4100:3
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L4333:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'CmkKekIdentity' removed or renamed?
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L4100:3
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L4333:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'encryptionSettings' removed or renamed?
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L4100:3
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L4333:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ValidateForModifyBackupRequest' removed or renamed?
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L4100:3
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L4333:3
⚠️ 1007 - RemovedClientParameter 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-11-01/dataprotection.json#L8107:3
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L8427:3
⚠️ 1007 - RemovedClientParameter 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-11-01/dataprotection.json#L8107:3
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L8427:3
⚠️ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L7115:9
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L7428:9
⚠️ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L7120:9
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L7432:9
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'encryptionSettings' renamed or removed?
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L7552:7
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L7856:7
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'sourceDataStoreType' renamed or removed?
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L4354:7
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L4575:7
⚠️ 1042 - ChangedParameterOrder The order of parameter 'parameters' was changed.
New: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1833:9
Old: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1915:9
️⚠️LintDiff: 1 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.6) new version base version
package-2023-11 package-2023-11(66e4102) package-2023-11(asmitt-dataprotection-Microsoft.DataProtection-2023-11-01)

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

Rule Message Related RPC [For API reviewers]
⚠️ 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.DataProtection/stable/2023-11-01/dataprotection.json#L7037


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-11-01/dataprotection.json#L42
LroExtension Operations with a 202 response must specify x-ms-long-running-operation: true.
Location: Microsoft.DataProtection/stable/2023-11-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-11-01/dataprotection.json#L64
GetOperation200 The get operation should only return 200.
Location: Microsoft.DataProtection/stable/2023-11-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-11-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-11-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-11-01/dataprotection.json#L440
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.DataProtection/stable/2023-11-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-11-01/dataprotection.json#L476
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.DataProtection/stable/2023-11-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-11-01/dataprotection.json#L532
LroExtension Operations with a 202 response must specify x-ms-long-running-operation: true.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L545
GetOperation200 The get operation should only return 200.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L580
OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: Microsoft.DataProtection/stable/2023-11-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-11-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-11-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-11-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-11-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-11-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-11-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-11-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-11-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-11-01/dataprotection.json#L1345
LroExtension Operations with a 202 response must specify x-ms-long-running-operation: true.
Location: Microsoft.DataProtection/stable/2023-11-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-11-01/dataprotection.json#L1366
GetOperation200 The get operation should only return 200.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1400
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.DataProtection/stable/2023-11-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-11-01/dataprotection.json#L1461
ParametersInPost $filter is a query parameter. Post operation must not contain any query parameter other than api-version.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1547
ParametersInPost $skipToken is a query parameter. Post operation must not contain any query parameter other than api-version.
Location: Microsoft.DataProtection/stable/2023-11-01/dataprotection.json#L1547
️️✔️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.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️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?

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app Bot commented Nov 10, 2023

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️⚠️SDK Breaking Change Tracking warning [Detail]

Only 0 items are rendered, please refer to log for more details.

️❌ azure-sdk-for-net-track2 failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️⚠️ azure-sdk-for-python-track2 warning [Detail]

Only 0 items are rendered, please refer to log for more details.

️⚠️ azure-sdk-for-java warning [Detail]

Only 0 items are rendered, please refer to log for more details.

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️❌ azure-powershell failed [Detail]

Only 0 items are rendered, please refer to log for more details.

Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app Bot commented Nov 10, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/dataprotection/armdataprotection Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
Java azure-resourcemanager-dataprotection Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
JavaScript @azure/arm-dataprotection Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
Swagger Microsoft.DataProtection Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

@microsoft-github-policy-service
Copy link
Copy Markdown
Contributor

Thank you for your contribution soumyapattnaik! We will review the pull request and get back to you soon.

@microsoft-github-policy-service microsoft-github-policy-service Bot added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Nov 10, 2023
@asmitt asmitt merged commit 6bed6b3 into Azure:asmitt-dataprotection-Microsoft.DataProtection-2023-11-01 Nov 10, 2023
kushalmehrotra713 pushed a commit that referenced this pull request Nov 28, 2023
…rsion stable/2023-11-01 (#26491)

* Adds base for updating Microsoft.DataProtection from version stable/2023-05-01 to version 2023-11-01

* Updates readme

* Updates API version in new specs and examples

* copied changes for CRR from api-version 2023-04-01-preview

* added replicated regions to vault and filters to fetch CRR jobs

* removed extension routing changes

* completed with warnings job changes

* Add RecoveryPointState to DataProtection

* Asmitt dataprotection microsoft.data protection 2023 11 01 (#26663)

* Adds base for updating Microsoft.DataProtection from version preview/2023-04-01-preview to version 2023-06-01-preview

* Updates readme

* Updates API version in new specs and examples

* changes for AKS vault tier restore

* address typos

* Adds base for updating Microsoft.DataProtection from version stable/2023-05-01 to version 2023-11-01

* Updates readme

* Updates API version in new specs and examples

* copied changes for CRR from api-version 2023-04-01-preview

* added replicated regions to vault and filters to fetch CRR jobs

* 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

* removed extension routing changes

* changes for vault tier

* completed with warnings job changes

* Add RecoveryPointState to DataProtection (#26426)

* Add RecoveryPointState to DataProtection

* Prettier fixes

* Adds base for updating Microsoft.DataProtection from version stable/2023-05-01 to version 2023-11-01

* Updates readme

* Updates API version in new specs and examples

* copied changes for CRR from api-version 2023-04-01-preview

* added replicated regions to vault and filters to fetch CRR jobs

* removed extension routing changes

* completed with warnings job changes

* Add RecoveryPointState to DataProtection (#26426)

* Add RecoveryPointState to DataProtection

* Prettier fixes

---------

Co-authored-by: Shashank Singh <shashank1306s@gmail.com>
Co-authored-by: asmitt <62243673+asmitt@users.noreply.github.com>
Co-authored-by: Ashish Mittal <asmitt@microsoft.com>
Co-authored-by: nickpacificomsft <144935783+nickpacificomsft@users.noreply.github.com>

* resolved lint issues

* added missing operation and schema description

* spelling fix

* lint error suppressions

* resolved warnings

* fixed operationId

---------

Co-authored-by: soumyapattnaik <33341338+soumyapattnaik@users.noreply.github.com>
Co-authored-by: Shashank Singh <shashank1306s@gmail.com>
Co-authored-by: nickpacificomsft <144935783+nickpacificomsft@users.noreply.github.com>
@soumyapattnaik soumyapattnaik deleted the asmitt-dataprotection-Microsoft.DataProtection-2023-11-01 branch December 1, 2023 13:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI-BreakingChange-Go CI-BreakingChange-JavaScript customer-reported Issues that are reported by GitHub users external to the Azure organization. resource-manager

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants