Skip to content

{Redis} Add examples for redis resource cmd #31564

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

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion src/azure-cli/azure/cli/command_modules/redis/_help.py
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,9 @@
type: command
short-summary: Create a redis cache firewall rule.
long-summary: Usage example - az redis firewall-rules create --name testCacheName --resource-group testResourceGroup --start-ip 10.10.10.10 --end-ip 20.20.20.20 --rule-name 10to20
examples:
- name: Create a redis cache firewall rule
text: az redis firewall-rules create -n cachename -g rg --start-ip 127.0.0.1 --end-ip 127.0.0.1 --rule-name rulename
"""

helps['redis firewall-rules update'] = """
Expand Down Expand Up @@ -134,6 +137,9 @@
type: command
short-summary: Create patching schedule for Redis cache.
long-summary: Usage example - az redis patch-schedule create --name testCacheName --resource-group testResourceGroup --schedule-entries '[{"dayOfWeek":"Tuesday","startHourUtc":"00","maintenanceWindow":"PT5H"}]'
examples:
- name: Create patching schedule for Redis cache
text: az redis patch-schedule create -n cachename -g rg --schedule-entries '[{"dayOfWeek":"Monday","startHourUtc":"00","maintenanceWindow":"PT5H"}]'
"""

helps['redis patch-schedule update'] = """
Expand All @@ -150,7 +156,9 @@
helps['redis server-link create'] = """
type: command
short-summary: Adds a server link to the Redis cache (requires Premium SKU).
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
Copy link
Preview

Copilot AI May 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copilot uses AI. Check for mistakes.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cache-to-link in long summary does not exist. For now it's server-to-link

"""

helps['redis update'] = """
Expand Down