azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Published
20 hours ago •
Azure
Azure
Adding api version redisenterprise microsoft.cache 2024 03 01 preview
ARM (Control Plane) API Specification Update Pull Request
[!TIP] Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.
[!NOTE] As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1, Breaking Changes review
If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.
Click here to see the details of Step 2, ARM review
See https://aka.ms/azsdk/pr-arm-review.
Click here to see the diagram footnotes
Diagram footnotes
[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
- [ ] New resource provider.
- [x] New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been generated using 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 OpenAPI spec quality issues in S360.
- [ ] Other, please clarify:
- edit this with your clarification
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood and followed the instructions by checking all the boxes:
- [x] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
- [x] I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.
Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the suppressions guide to get approval.
Getting help
- First, please carefully read through this PR description, from top to bottom. Please fill out the
Purpose of this PRandDue diligence checklist. - To understand what you must do next to merge this PR, see the
Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state. - For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
- For help with PR workflow diagram Step 2 (ARM review), see https://aka.ms/azsdk/pr-arm-review.
- If the PR CI checks appear to be stuck in
queuedstate, please add a comment with contents/azp run. This should result in a new comment denoting aPR validation pipelinehas started and the checks should be updated after few minutes. - If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.
Next Steps to Merge
✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 22 Errors, 36 Warnings failed [Detail]
| Compared specs (v0.10.8) | new version | base version |
|---|---|---|
| redisenterprise.json | 2024-03-01-preview(78a6e57) | 2024-02-01(main) |
| redisenterprise.json | 2024-03-01-preview(78a6e57) | 2023-10-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 5 Warnings warning [Detail]
| Compared specs (v2.2.0) | new version | base version |
|---|---|---|
| package-preview-2024-03 | package-preview-2024-03(78a6e57) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L1264 |
|
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L1358 |
|
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L1367 |
|
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L1370 |
|
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L1390 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Properties of a PATCH request body must not be required, property:type. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L201 |
|
Properties of a PATCH request body must not be required, property:name. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L201 |
|
A 202 response should include an Location response header. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L220 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L231 |
|
A 202 response should include an Location response header. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L264 |
|
A 202 response should include an Location response header. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L562 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L617 |
|
A 202 response should include an Location response header. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L654 |
|
A 202 response should include an Location response header. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L765 |
|
200 return code does not have a schema specified. LRO POST must 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. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L778 |
|
A 202 response should include an Location response header. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L824 |
|
200 return code does not have a schema specified. LRO POST must 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. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L837 |
|
A 202 response should include an Location response header. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L883 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L924 |
|
200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L984 |
|
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.Cache/preview/2024-03-01-preview/redisenterprise.json#L984 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L1037 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L1127 |
|
200 return code does not have a schema specified. LRO POST must 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. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L1144 |
|
A 202 response should include an Location response header. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L1190 |
|
200 return code does not have a schema specified. LRO POST must 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. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L1271 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L51 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L58 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L64 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L87 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L90 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L93 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L96 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L109 |
| :warning: RequiredReadOnlySystemData | The response of operation:'RedisEnterprise_Create' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/preview/2024-03-01-preview/redisenterprise.json#L116 |
️❌Avocado: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Cache/checkNameAvailability is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/redisenterprise/resource-manager/readme.md json: Microsoft.Cache/preview/2023-10-01-preview/redisenterprise.json |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
️✔️Succeeded in generating from b7a7a72f82fce66e9bd419ed9c775968d28ee4c5. 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
️✔️Azure.ResourceManager.RedisEnterprise [Preview SDK Changes]- Azure.ResourceManager.RedisEnterprise.1.2.0-alpha.20240426.1.nupkg
info [Changelog]
️⚠️ azure-sdk-for-python warning [Detail]
⚠️Warning in generating from b7a7a72f82fce66e9bd419ed9c775968d28ee4c5. 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 minor version of npm available! 10.5.0 -> 10.6.0 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.6.0> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️azure-mgmt-redisenterprise [Preview SDK Changes]- azure_mgmt_redisenterprise-2.0.0-py3-none-any.whl
- azure-mgmt-redisenterprise-2.0.0.zip
info [Changelog] ### Features Added info [Changelog] info [Changelog] - Added operation DatabasesOperations.begin_force_link_to_replication_group info [Changelog] - Added operation DatabasesOperations.begin_upgrade_db_redis_version info [Changelog] - Model Database has a new parameter defer_upgrade info [Changelog] - Model Database has a new parameter redis_version info [Changelog] - Model DatabaseUpdate has a new parameter defer_upgrade info [Changelog] - Model DatabaseUpdate has a new parameter redis_version
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning in generating from b7a7a72f82fce66e9bd419ed9c775968d28ee4c5. 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 cmderr [init.sh] npm notice New minor version of npm available! 10.5.0 -> 10.6.0 cmderr [init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.6.0> cmderr [init.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [init.sh] npm notice command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
️✔️azure-resourcemanager-redisenterprise [Preview SDK Changes]- pom.xml
- azure-resourcemanager-redisenterprise-2.1.0-beta.1-sources.jar
- azure-resourcemanager-redisenterprise-2.1.0-beta.1.jar
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded in generating from b7a7a72f82fce66e9bd419ed9c775968d28ee4c5. 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/redisenterprise/armredisenterprise [Preview SDK Changes]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded in generating from b7a7a72f82fce66e9bd419ed9c775968d28ee4c5. 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-redisenterprisecache [Preview SDK Changes]- azure-arm-redisenterprisecache-3.1.0-beta.1.tgz
️❌ azure-resource-manager-schemas failed [Detail]
❌Failed in generating from b7a7a72f82fce66e9bd419ed9c775968d28ee4c5. 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] notice cmderr [initScript.sh] npm notice New minor version of npm available! 10.5.0 -> 10.6.0 cmderr [initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.6.0> cmderr [initScript.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [initScript.sh] npm notice 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
❌redisenterprise/resource-manager [Preview Schema Changes]
️⚠️ azure-powershell warning [Detail]
⚠️Warning in generating from b7a7a72f82fce66e9bd419ed9c775968d28ee4c5. 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.redisenterprise.DefaultTag [Preview SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/redisenterprise/armredisenterprise | https://apiview.dev/Assemblies/Review/11a39c9126d14e2cafeab08f37e972c1?revisionId=7ae9f61521a5484089cb7d4b37169437 |
| .Net | Azure.ResourceManager.RedisEnterprise | https://apiview.dev/Assemblies/Review/519be863e4414804b6d539189357aa74?revisionId=0fb6edfd00464f22b18968561c1c40b6 |
| Java | azure-resourcemanager-redisenterprise | https://apiview.dev/Assemblies/Review/922e5e853b1844cda8068a39fa4a5805?revisionId=56a05f1ff4164f929c9b6dad279da5ec |
| JavaScript | @azure/arm-redisenterprisecache | https://apiview.dev/Assemblies/Review/8520553c701f4efca808faa010297808?revisionId=290cd848a52447c79b09c0c0cca3eece |
| Swagger | Microsoft.Cache | https://apiview.dev/Assemblies/Review/e4db30f33d024b679c2b8f1bb2fe6d19?revisionId=76c8b4bd860947e3b5f4d0cc075d9b31 |
Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Adding BreakingChange-Approved-BugFix since the change is introduced to satisfy a lint requirement adding a pattern that we're already using for cluster and database names
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
This PR is already approved in the private repo: https://github.com/Azure/azure-rest-api-specs-pr/pull/18002
We can fix the ErrorResponse warnings from old common types in the next version, I guess.
