az redis server-link

Manage Redis server links.

Commands

Name	Description	Type	Status
az redis server-link create	Adds a server link to the Redis cache (requires Premium SKU).	Core	GA
az redis server-link delete	Deletes the linked server from a redis cache (requires Premium SKU).	Core	GA
az redis server-link list	Gets the list of linked servers associated with this redis cache (requires Premium SKU).	Core	GA
az redis server-link show	Gets the detailed information about a linked server of a redis cache (requires Premium SKU).	Core	GA

az redis server-link create

Edit

Adds a server link to the Redis cache (requires Premium SKU).

Usage example - az redis server-link create --name testCacheName --resource-group testResourceGroup --cache-to-link secondTestCacheName --replication-role Secondary.

az redis server-link create --name
                            --replication-role {Primary, Secondary}
                            --resource-group
                            --server-to-link
                            [--acquire-policy-token]
                            [--change-reference]

Required Parameters

--name -n

Name of the Redis cache.

--replication-role

Role of the redis cache to be linked.

Property	Value
Accepted values:	Primary, Secondary

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--server-to-link

Resource ID or name of the redis cache to be linked.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az redis server-link delete

Edit

Deletes the linked server from a redis cache (requires Premium SKU).

az redis server-link delete --linked-server-name
                            --name
                            --resource-group
                            [--acquire-policy-token]
                            [--change-reference]

Required Parameters

--linked-server-name

Name of the linked redis cache.

--name -n

Name of the Redis cache.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az redis server-link list

Edit

Gets the list of linked servers associated with this redis cache (requires Premium SKU).

az redis server-link list --name
                          --resource-group

Required Parameters

--name -n

Name of the Redis cache.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az redis server-link show

Edit

Gets the detailed information about a linked server of a redis cache (requires Premium SKU).

az redis server-link show --linked-server-name
                          --name
                          --resource-group

Required Parameters

--linked-server-name

Name of the linked redis cache.

--name -n

Name of the Redis cache.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

Feedback

Was this page helpful?