{Redis} Add examples for redis resource cmd#31564
Open
Conversation
️✔️AzureCLI-FullTest
|
️✔️AzureCLI-BreakingChangeTest
|
Collaborator
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
microsoft-github-policy-service
bot
requested review from
evelyn-ys,
yonzhan and
zhoxing-ms
microsoft-github-policy-service
bot
added
Redis Cache
Auto-Assign
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds usage examples to several Redis CLI commands to improve documentation clarity.
- Introduced
examplessections forredis firewall-rules create,redis patch-schedule create, andredis server-link create. - Ensured each example includes a brief name and a full
az redis ...command invocation.
Comments suppressed due to low confidence (1)
src/azure-cli/azure/cli/command_modules/redis/_help.py:101
- The
examples:key should be indented to match the existingtype,short-summary, andlong-summarykeys for consistent formatting.
examples:
| long-summary: Usage example - az redis server-link create --name testCacheName --resource-group testResourceGroup --cache-to-link secondTestCacheName --replication-role Secondary | ||
| examples: | ||
| - name: Adds a server link to the Redis cache (requires Premium SKU) | ||
| text: az redis server-link create -n cachename -g rg --replication-role Secondary --server-to-link cliredissec |
There was a problem hiding this comment.
The example uses --server-to-link, but the correct parameter is --cache-to-link as shown in the long-summary.
Suggested change
| text: az redis server-link create -n cachename -g rg --replication-role Secondary --server-to-link cliredissec | |
| text: az redis server-link create -n cachename -g rg --replication-role Secondary --cache-to-link cliredissec |
Contributor
Author
There was a problem hiding this comment.
cache-to-link in long summary does not exist. For now it's server-to-link
This file contains hidden or 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
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.
Related command
az redis firewall-rules create
az redis patch-schedule create
az redis server-link create
Description
Testing Guide
History Notes
[Component Name 1] BREAKING CHANGE:
az command a: Make some customer-facing breaking change[Component Name 2]
az command b: Add some customer-facing featureThis checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.