azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Update redis.json
Add a note explaining the lack of importance of public network access for VNET injected caches
ARM (Control Plane) API Specification Update Pull Request
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, per this wiki doc.)
- [ ] 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.
- [x] Other, please clarify:
- Documentation update only.
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 have reviewed the general guidance on the spec PR review process: https://aka.ms/specprreview.
- [x] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data-plane related specifications.
- [x] I commit to follow the Breaking Change Policy.
- [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 request review from an ARM API Review board.
ARM API changes review
- If you want for the ARM team to review this PR, you must add the
ARMReviewlabel. - The automation may automatically add the
ARMReviewlabel, if appropriate.
If this happens, proceed according to guidance given in GitHub comments also added by the automation.
Breaking change review
If you have any breaking changes as defined in the Breaking Change Policy, follow the process outlined in the High-level Breaking Change Process doc.
Getting help
- For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
- For additional help, see https://aka.ms/azsdk/support/spectools.
Hi, @TimLovellSmith! Thank you for your pull request. To help get your PR merged:
Generated ApiView comment added to this PR. You can use ApiView to show API versions diff. ![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| redis.json | 2023-04-01(14f6480) | 2023-04-01(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.4) | new version | base version |
|---|---|---|
| package-2023-04 | package-2023-04(14f6480) | package-2023-04(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.Cache/CheckNameAvailability' Location: Microsoft.Cache/stable/2023-04-01/redis.json#L73 |
|
The schema 'Sku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L1856 |
|
The schema 'RedisCommonProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L1896 |
|
The schema 'RedisCreateProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2037 |
|
The schema 'RedisUpdateProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2069 |
|
The schema 'RedisProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2084 |
|
The schema 'RedisCreateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2167 |
|
The schema 'RedisUpdateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2207 |
|
The schema 'RedisAccessKeys' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2228 |
|
The schema 'RedisFirewallRule' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2243 |
|
The schema 'RedisFirewallRuleProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2269 |
|
The schema 'RedisFirewallRuleListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2286 |
|
The schema 'RedisResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2303 |
|
The schema 'RedisInstanceDetails' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2332 |
|
The schema 'RedisListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2370 |
|
The schema 'RedisRegenerateKeyParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2387 |
|
The schema 'RedisRebootParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2407 |
|
The integer type does not have a format, please add it. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2429 |
|
The schema 'ExportRDBParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2437 |
|
The schema 'ImportRDBParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2466 |
|
The schema 'ScheduleEntry' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2493 |
|
The schema 'ScheduleEntries' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2531 |
|
The schema 'RedisPatchSchedule' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2548 |
|
Tracked resource 'RedisPatchSchedule' must have patch operation that at least supports the update of tags. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2548 |
|
The schema 'RedisPatchScheduleListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2571 |
|
The schema 'RedisForceRebootResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2588 |
|
The schema 'RedisLinkedServer' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2598 |
|
The schema 'RedisLinkedServerWithProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2608 |
|
The schema 'RedisLinkedServerProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2623 |
|
The schema 'RedisLinkedServerWithPropertiesList' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2638 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️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.
️️✔️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]
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
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 [Logs]Release - Generate from 1ab919f9c740a0e8313b0b0370862ef217e671d7. 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.Redis [View full logs] [Release SDK Changes]info [Changelog]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs]Release - Generate from 1ab919f9c740a0e8313b0b0370862ef217e671d7. 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! 9.6.7 -> 9.8.1 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.8.1> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-redis [View full logs] [Release SDK Changes]info [Changelog]
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs]Release - Generate from 1ab919f9c740a0e8313b0b0370862ef217e671d7. 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 is available: 23.0.1 -> 23.2.1 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.1 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-redis-generated [View full logs] [Release SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from 1ab919f9c740a0e8313b0b0370862ef217e671d7. 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/redis/armredis [View full logs] [Release SDK Changes]info [Changelog] ### Other Changes info [Changelog] info [Changelog] Total 0 breaking change(s), 0 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from 1ab919f9c740a0e8313b0b0370862ef217e671d7. 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 cmderr [automation_generate.sh] [ERROR] Cannot generate changelog because the codes of local and npm may be the same.
️✔️@azure/arm-rediscache [View full logs] [Release SDK Changes]info [Changelog] error breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from 1ab919f9c740a0e8313b0b0370862ef217e671d7. Schema Automation 14.0.0command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json 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
️✔️redis [View full logs] [Release Schema Changes]
️❌ azure-powershell failed [Detail]
❌Pipeline Framework Failed [Logs]Release - Generate from 1ab919f9c740a0e8313b0b0370862ef217e671d7. 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 SSL error: syscall failure: Broken pipe Error: SSL error: syscall failure: Broken pipe
️✔️Az.redis.DefaultTag [View full logs]error Fatal error: SSL error: syscall failure: Broken pipe error The following packages are still pending: error Az.redis.DefaultTag
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/redis/armredis | https://apiview.dev/Assemblies/Review/66ebac2d3ba2440bbf51ba56638dfbcd |
| Java | azure-resourcemanager-redis-generated | https://apiview.dev/Assemblies/Review/9b0c092ca3ce4e83a7ddb963cab5dea8 |
| .Net | Azure.ResourceManager.Redis | There is no API change compared with the previous version |
| JavaScript | @azure/arm-rediscache | There is no API change compared with the previous version |
Hi, @TimLovellSmith. 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.
![microsoft-github-policy-service[bot] avatar](https://avatars.githubusercontent.com/in/95686?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @TimLovellSmith. 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.
No commit pushedDate could be found for PR 24729 in repo Azure/azure-rest-api-specs
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
@TimLovellSmith , @ajtiwari07 - sorry that took so long. Got lost in my inbox.
Hi, @TimLovellSmith. 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.
Next Steps to Merge
⚠️ This is an experimental comment. It may not always be up-to-date. ⚠️
✔️ 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).
Hi, @TimLovellSmith. 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.
Automatic PR validation started. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.
Swagger pipeline restarted successfully, please wait for status update in this comment.