Skip to content

Commit bad9086

Browse files
flang-msftflang-msft
committed
Fixed most Lint suggestions, minor edits
1 parent 82ae9ad commit bad9086

File tree

1 file changed

+53
-44
lines changed

1 file changed

+53
-44
lines changed

‎articles/azure-cache-for-redis/cache-configure.md

Lines changed: 53 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ ms.custom: devx-track-azurepowershell
1111

1212
---
1313
# How to configure Azure Cache for Redis
14+
1415
This article describes the configurations available for your Azure Cache for Redis instances. This article also covers the default Redis server configuration for Azure Cache for Redis instances.
1516

1617
> [!NOTE]
@@ -19,6 +20,7 @@ This article describes the configurations available for your Azure Cache for Red
1920
>
2021
2122
## Configure Azure Cache for Redis settings
23+
2224
[!INCLUDE [redis-cache-create](../../includes/redis-cache-browse.md)]
2325

2426
Azure Cache for Redis settings are viewed and configured on the **Azure Cache for Redis** on the left using the **Resource Menu**.
@@ -33,32 +35,31 @@ You can view and configure the following settings using the **Resource Menu**.
3335
* [Tags](#tags)
3436
* [Diagnose and solve problems](#diagnose-and-solve-problems)
3537
* [Settings](#settings)
36-
* [Access keys](#access-keys)
37-
* [Advanced settings](#advanced-settings)
38-
* [Azure Cache for Redis Advisor](#azure-cache-for-redis-advisor)
39-
* [Scale](#scale)
40-
* [Cluster size](#cluster-size)
41-
* [Data persistence](#redis-data-persistence)
42-
* [Schedule updates](#schedule-updates)
43-
* [Geo-replication](#geo-replication)
44-
* [Virtual Network](#virtual-network)
45-
* [Firewall](#firewall)
46-
* [Properties](#properties)
47-
* [Locks](#locks)
48-
* [Automation script](#automation-script)
38+
* [Access keys](#access-keys)
39+
* [Advanced settings](#advanced-settings)
40+
* [Azure Cache for Redis Advisor](#azure-cache-for-redis-advisor)
41+
* [Scale](#scale)
42+
* [Cluster size](#cluster-size)
43+
* [Data persistence](#redis-data-persistence)
44+
* [Schedule updates](#schedule-updates)
45+
* [Geo-replication](#geo-replication)
46+
* [Virtual Network](#virtual-network)
47+
* [Firewall](#firewall)
48+
* [Properties](#properties)
49+
* [Locks](#locks)
50+
* [Automation script](#automation-script)
4951
* Administration
50-
* [Import data](#importexport)
51-
* [Export data](#importexport)
52-
* [Reboot](#reboot)
52+
* [Import data](#importexport)
53+
* [Export data](#importexport)
54+
* [Reboot](#reboot)
5355
* [Monitoring](#monitoring)
54-
* [Redis metrics](#redis-metrics)
55-
* [Alert rules](#alert-rules)
56-
[Diagnostics](#diagnostics)
56+
* [Redis metrics](#redis-metrics)
57+
* [Alert rules](#alert-rules)
58+
* [Diagnostics](#diagnostics)
5759
* Support & troubleshooting settings
5860
* [Resource health](#resource-health)
5961
* [New support request](#new-support-request)
6062

61-
6263
## Overview
6364

6465
**Overview** provides you with basic information about your cache, such as name, ports, pricing tier, and selected cache metrics.
@@ -75,14 +76,12 @@ The **Access control (IAM)** section provides support for Azure role-based acces
7576

7677
The **Tags** section helps you organize your resources. For more information, see [Using tags to organize your Azure resources](../azure-resource-manager/management/tag-resources.md).
7778

78-
7979
### Diagnose and solve problems
8080

8181
Select **Diagnose and solve problems** to be provided with common issues and strategies for resolving them.
8282

83-
84-
8583
## Settings
84+
8685
The **Settings** section allows you to access and configure the following settings for your cache.
8786

8887
* [Access keys](#access-keys)
@@ -99,21 +98,22 @@ The **Settings** section allows you to access and configure the following settin
9998
* [Locks](#locks)
10099
* [Automation script](#automation-script)
101100

102-
103-
104101
### Access keys
102+
105103
Select **Access keys** to view or regenerate the access keys for your cache. These keys are used by the clients connecting to your cache.
106104

107105
![Azure Cache for Redis Access Keys](./media/cache-configure/redis-cache-manage-keys.png)
108106

109107
### Advanced settings
108+
110109
The following settings are configured on the **Advanced settings** on the left.
111110

112111
* [Access Ports](#access-ports)
113112
* [Memory policies](#memory-policies)
114113
* [Keyspace notifications (advanced settings)](#keyspace-notifications-advanced-settings)
115114

116115
#### Access Ports
116+
117117
By default, non-TLS/SSL access is disabled for new caches. To enable the non-TLS port, Select **No** for **Allow access only via SSL** on the **Advanced settings** on the left and then Select **Save**.
118118

119119
> [!NOTE]
@@ -122,7 +122,9 @@ By default, non-TLS/SSL access is disabled for new caches. To enable the non-TLS
122122
![Azure Cache for Redis Access Ports](./media/cache-configure/redis-cache-access-ports.png)
123123

124124
<a name="maxmemory-policy-and-maxmemory-reserved"></a>
125+
125126
#### Memory policies
127+
126128
The **Maxmemory policy**, **maxmemory-reserved**, and **maxfragmentationmemory-reserved** settings on the **Advanced settings** on the left configure the memory policies for the cache.
127129

128130
![Azure Cache for Redis Maxmemory Policy](./media/cache-configure/redis-cache-maxmemory-policy.png)
@@ -140,17 +142,18 @@ For more information about `maxmemory` policies, see [Eviction policies](https:/
140142

141143
The **maxmemory-reserved** setting configures the amount of memory, in MB per instance in a cluster, that is reserved for non-cache operations, such as replication during failover. Setting this value allows you to have a more consistent Redis server experience when your load varies. This value should be set higher for workloads that write large amounts of data. When memory is reserved for such operations, it's unavailable for storage of cached data.
142144

143-
The **maxfragmentationmemory-reserved** setting configures the amount of memory, in MB per instance in a cluster, that is reserved to accommodate for memory fragmentation. Setting this value allows you to have a more consistent Redis server experience when the cache is full or close to full and the fragmentation ratio is high. When memory is reserved for such operations, it's unavailable for storage of cached data.
145+
The **maxfragmentationmemory-reserved** setting configures the amount of memory, in MB per instance in a cluster, that is reserved to accommodate for memory fragmentation. When you set this value, you to have a more consistent Redis server experience when the cache is full or close to full and the fragmentation ratio is high. When memory is reserved for such operations, it's unavailable for storage of cached data.
144146

145147
One thing to consider when choosing a new memory reservation value (**maxmemory-reserved** or **maxfragmentationmemory-reserved**) is how this change might affect a cache that is already running with large amounts of data in it. For instance, if you have a 53-GB cache with 49 GB of data, then change the reservation value to 8 GB, this change will drop the max available memory for the system down to 45 GB. If either your current `used_memory` or your `used_memory_rss` values are higher than the new limit of 45 GB, then the system will have to evict data until both `used_memory` and `used_memory_rss` are below 45 GB. Eviction can increase server load and memory fragmentation. For more information on cache metrics such as `used_memory` and `used_memory_rss`, see [Available metrics and reporting intervals](cache-how-to-monitor.md#available-metrics-and-reporting-intervals).
146148

147149
> [!IMPORTANT]
148150
> The **maxmemory-reserved** and **maxfragmentationmemory-reserved** settings are available only for Standard and Premium caches.
149-
>
151+
>
150152
> The `noeviction` eviction policy is the only memory policy that's available for an Enterprise tier cache.
151153
>
152154
153155
#### Keyspace notifications (advanced settings)
156+
154157
Redis keyspace notifications are configured on the **Advanced settings** on the left. Keyspace notifications allow clients to receive notifications when certain events occur.
155158

156159
![Azure Cache for Redis Advanced Settings](./media/cache-configure/redis-cache-advanced-settings.png)
@@ -162,9 +165,10 @@ Redis keyspace notifications are configured on the **Advanced settings** on the
162165
163166
For more information, see [Redis Keyspace Notifications](https://redis.io/topics/notifications). For sample code, see the [KeySpaceNotifications.cs](https://github.com/rustd/RedisSamples/blob/master/HelloWorld/KeySpaceNotifications.cs) file in the [Hello world](https://github.com/rustd/RedisSamples/tree/master/HelloWorld) sample.
164167

165-
166168
<a name="recommendations"></a>
169+
167170
## Azure Cache for Redis Advisor
171+
168172
The **Azure Cache for Redis Advisor** on the left displays recommendations for your cache. During normal operations, no recommendations are displayed.
169173

170174
![Screenshot that shows where the recommendations are displayed.](./media/cache-configure/redis-cache-no-recommendations.png)
@@ -211,20 +215,19 @@ To change the cluster size, use the slider or type a number between 1 and 10 in
211215
>
212216
>
213217
214-
215218
### Redis data persistence
216219

217220
Select **Data persistence** to enable, disable, or configure data persistence for your premium cache. Azure Cache for Redis offers Redis persistence using either RDB persistence or AOF persistence.
218221

219222
For more information, see [How to configure persistence for a Premium Azure Cache for Redis](cache-how-to-premium-persistence.md).
220223

221-
222224
> [!IMPORTANT]
223225
> Redis data persistence is only available for Premium caches.
224226
>
225227
>
226228
227229
### Schedule updates
230+
228231
The **Schedule updates on the left allow you to choose a maintenance window for Redis server updates for your cache.
229232

230233
> [!IMPORTANT]
@@ -248,6 +251,7 @@ For more information and instructions, see [Azure Cache for Redis administration
248251
>
249252
250253
### Virtual Network
254+
251255
The **Virtual Network** section allows you to configure the virtual network settings for your cache. For information on creating a premium cache with VNET support and updating its settings, see [How to configure Virtual Network Support for a Premium Azure Cache for Redis](cache-how-to-premium-vnet.md).
252256

253257
> [!IMPORTANT]
@@ -271,18 +275,21 @@ You can specify firewall rules with a start and end IP address range. When firew
271275
>
272276
273277
### Properties
278+
274279
Select **Properties** to view information about your cache, including the cache endpoint and ports.
275280

276281
![Azure Cache for Redis Properties](./media/cache-configure/redis-cache-properties.png)
277282

278283
### Locks
284+
279285
The **Locks** section allows you to lock a subscription, resource group, or resource to prevent other users in your organization from accidentally deleting or modifying critical resources. For more information, see [Lock resources with Azure Resource Manager](../azure-resource-manager/management/lock-resources.md).
280286

281287
### Automation script
282288

283289
Select **Automation script** to build and export a template of your deployed resources for future deployments. For more information about working with templates, see [Deploy resources with Azure Resource Manager templates](../azure-resource-manager/templates/deploy-powershell.md).
284290

285291
## Administration settings
292+
286293
The settings in the **Administration** section allow you to perform the following administrative tasks for your cache.
287294

288295
![Administration](./media/cache-configure/redis-cache-administration.png)
@@ -291,8 +298,8 @@ The settings in the **Administration** section allow you to perform the followin
291298
* [Export data](#importexport)
292299
* [Reboot](#reboot)
293300

294-
295301
### Import/Export
302+
296303
Import/Export is an Azure Cache for Redis data management operation, which allows you to import and export data in the cache by importing and exporting an Azure Cache for Redis Database (RDB) snapshot from a premium cache to a page blob in an Azure Storage Account. Import/Export enables you to migrate between different Azure Cache for Redis instances or populate the cache with data before use.
297304

298305
Import can be used to bring Redis compatible RDB files from any Redis server running in any cloud or environment, including Redis running on Linux, Windows, or any cloud provider such as Amazon Web Services and others. Importing data is an easy way to create a cache with pre-populated data. During the import process, Azure Cache for Redis loads the RDB files from Azure storage into memory, and then inserts the keys into the cache.
@@ -305,6 +312,7 @@ Export allows you to export the data stored in Azure Cache for Redis to Redis co
305312
>
306313
307314
### Reboot
315+
308316
The **Reboot** on the left allows you to reboot the nodes of your cache. This reboot capability enables you to test your application for resiliency if there is a failure of a cache node.
309317

310318
![Reboot](./media/cache-configure/redis-cache-reboot.png)
@@ -320,7 +328,6 @@ To reboot one or more nodes of your cache, select the desired nodes and select *
320328
>
321329
>
322330
323-
324331
## Monitoring
325332

326333
The **Monitoring** section allows you to configure diagnostics and monitoring for your Azure Cache for Redis.
@@ -333,11 +340,12 @@ For more information on Azure Cache for Redis monitoring and diagnostics, see [H
333340
* [Diagnostics](#diagnostics)
334341

335342
### Redis metrics
336-
select **Redis metrics** to [view metrics](cache-how-to-monitor.md#view-cache-metrics) for your cache.
343+
344+
Select **Redis metrics** to [view metrics](cache-how-to-monitor.md#view-cache-metrics) for your cache.
337345

338346
### Alert rules
339347

340-
select **Alert rules** to configure alerts based on Azure Cache for Redis metrics. For more information, see [Alerts](cache-how-to-monitor.md#alerts).
348+
Select **Alert rules** to configure alerts based on Azure Cache for Redis metrics. For more information, see [Alerts](cache-how-to-monitor.md#alerts).
341349

342350
### Diagnostics
343351

@@ -349,6 +357,7 @@ By default, cache metrics in Azure Monitor are [stored for 30 days](../azure-mon
349357
>
350358
351359
## Support & troubleshooting settings
360+
352361
The settings in the **Support + troubleshooting** section provide you with options for resolving issues with your cache.
353362

354363
![Support + troubleshooting](./media/cache-configure/redis-cache-support-troubleshooting.png)
@@ -357,6 +366,7 @@ The settings in the **Support + troubleshooting** section provide you with optio
357366
* [New support request](#new-support-request)
358367

359368
### Resource health
369+
360370
**Resource health** watches your resource and tells you if it's running as expected. For more information about the Azure Resource health service, see [Azure Resource health overview](../service-health/resource-health-overview.md).
361371

362372
> [!NOTE]
@@ -365,13 +375,11 @@ The settings in the **Support + troubleshooting** section provide you with optio
365375
>
366376
367377
### New support request
368-
Select **New support request** to open a support request for your cache.
369-
370-
371-
372378

379+
Select **New support request** to open a support request for your cache.
373380

374381
## Default Redis server configuration
382+
375383
New Azure Cache for Redis instances are configured with the following default Redis configuration values:
376384

377385
> [!NOTE]
@@ -440,9 +448,8 @@ For more information about databases, see [What are Redis databases?](cache-deve
440448
>
441449
>
442450
443-
444-
445451
## Redis commands not supported in Azure Cache for Redis
452+
446453
> [!IMPORTANT]
447454
> Because configuration and management of Azure Cache for Redis instances is managed by Microsoft, the following commands are disabled. If you try to invoke them, you receive an error message similar to `"(error) ERR unknown command"`.
448455
>
@@ -461,11 +468,13 @@ For more information about databases, see [What are Redis databases?](cache-deve
461468
For more information about Redis commands, see [https://redis.io/commands](https://redis.io/commands).
462469

463470
## Redis console
471+
464472
You can securely issue commands to your Azure Cache for Redis instances using the **Redis Console**, which is available in the Azure portal for all cache tiers.
465473

466474
> [!IMPORTANT]
467-
> - The Redis Console does not work with [VNET](cache-how-to-premium-vnet.md). When your cache is part of a VNET, only clients in the VNET can access the cache. Because Redis Console runs in your local browser, which is outside the VNET, it can't connect to your cache.
468-
> - Not all Redis commands are supported in Azure Cache for Redis. For a list of Redis commands that are disabled for Azure Cache for Redis, see the previous [Redis commands not supported in Azure Cache for Redis](#redis-commands-not-supported-in-azure-cache-for-redis) section. For more information about Redis commands, see [https://redis.io/commands](https://redis.io/commands).
475+
>
476+
> * The Redis Console does not work with [VNET](cache-how-to-premium-vnet.md). When your cache is part of a VNET, only clients in the VNET can access the cache. Because Redis Console runs in your local browser, which is outside the VNET, it can't connect to your cache.
477+
> * Not all Redis commands are supported in Azure Cache for Redis. For a list of Redis commands that are disabled for Azure Cache for Redis, see the previous [Redis commands not supported in Azure Cache for Redis](#redis-commands-not-supported-in-azure-cache-for-redis) section. For more information about Redis commands, see [https://redis.io/commands](https://redis.io/commands).
469478
>
470479
>
471480
@@ -477,7 +486,6 @@ To issue commands against your cache instance, type the command you want into th
477486

478487
![Screenshot thas shows the Redis Console with the input command and results.](./media/cache-configure/redis-console.png)
479488

480-
481489
### Using the Redis Console with a premium clustered cache
482490

483491
When using the Redis Console with a premium clustered cache, you can issue commands to a single shard of the cache. To issue a command to a specific shard, first connect to the shard you want by selecting it on the shard picker.
@@ -493,13 +501,14 @@ shard1>get myKey
493501

494502
In the previous example, shard 1 is the selected shard, but `myKey` is located in shard 0, as indicated by the `(shard 0)` portion of the error message. In this example, to access `myKey`, select shard 0 using the shard picker, and then issue the desired command.
495503

496-
497504
## Move your cache to a new subscription
505+
498506
You can move your cache to a new subscription by selecting **Move**.
499507

500508
![Move Azure Cache for Redis](./media/cache-configure/redis-cache-move.png)
501509

502510
For information on moving resources from one resource group to another, and from one subscription to another, see [Move resources to new resource group or subscription](../azure-resource-manager/management/move-resource-group-and-subscription.md).
503511

504512
## Next steps
513+
505514
* For more information on working with Redis commands, see [How can I run Redis commands?](cache-development-faq.md#how-can-i-run-redis-commands)

0 commit comments

Comments
 (0)