Microsoft Azure - API RedisManagementClient

Microsoft Azure / RedisManagementClient

RedisManagementClient

REST API for Azure Redis Cache Service.

Resources

FirewallRules

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules/{ruleName}

Deletes a single firewall rule in a specified redis cache.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`ruleName`	string	The name of the firewall rule.
`cacheName`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Responses

200Successfully deleted the rule

204Successfully deleted the rule

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules/{ruleName}

Gets a single firewall rule in a specified redis cache.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`ruleName`	string	The name of the firewall rule.
`cacheName`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Responses

200Successfully found the rule

Body

Name	Data Type	Description
`RedisFirewallRule`		A firewall rule on a redis cache has a name, and describes a contiguous range of IP addresses permitted to connect

Properties


                        properties

RedisFirewallRuleProperties

redis cache firewall rule properties


                        RedisFirewallRuleProperties

Specifies a range of IP addresses permitted to connect to the cache

Properties

`startIP`	string	lowest IP address included in the range
`endIP`	string	highest IP address included in the range

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules/{ruleName}

Create or update a redis cache firewall rule

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`ruleName`	string	The name of the firewall rule.
`cacheName`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Body

Name	Data Type	Description
`RedisFirewallRuleCreateParameters`		Parameters required for creating a firewall rule on redis cache.

Properties


                        properties

RedisFirewallRuleProperties

Properties required to create a firewall rule .


                        RedisFirewallRuleProperties

Specifies a range of IP addresses permitted to connect to the cache

Properties

`startIP`	string	lowest IP address included in the range
`endIP`	string	highest IP address included in the range

Responses

200Resource was successfully updated

Body

Name	Data Type	Description
`RedisFirewallRule`		A firewall rule on a redis cache has a name, and describes a contiguous range of IP addresses permitted to connect

Properties


                        properties

RedisFirewallRuleProperties

redis cache firewall rule properties


                        RedisFirewallRuleProperties

Specifies a range of IP addresses permitted to connect to the cache

Properties

`startIP`	string	lowest IP address included in the range
`endIP`	string	highest IP address included in the range

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends

201Resource was successfully created

Body

Name	Data Type	Description
`RedisFirewallRule`		A firewall rule on a redis cache has a name, and describes a contiguous range of IP addresses permitted to connect

Properties


                        properties

RedisFirewallRuleProperties

redis cache firewall rule properties


                        RedisFirewallRuleProperties

Specifies a range of IP addresses permitted to connect to the cache

Properties

`startIP`	string	lowest IP address included in the range
`endIP`	string	highest IP address included in the range

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules

Gets all firewall rules in the specified redis cache.

Request

Path

Name	Data Type	Description
`cacheName`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Responses

200Successfully got the current rules

Body

Name	Data Type	Description
`RedisFirewallRuleListResult`		The response of list firewall rules Redis operation.

Properties


                        value

array [RedisFirewallRule]

Results of the list firewall rules operation.


                        RedisFirewallRule

A firewall rule on a redis cache has a name, and describes a contiguous range of IP addresses permitted to connect

Properties


                        properties

RedisFirewallRuleProperties

redis cache firewall rule properties


                        RedisFirewallRuleProperties

Specifies a range of IP addresses permitted to connect to the cache

Properties

`startIP`	string	lowest IP address included in the range
`endIP`	string	highest IP address included in the range

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends


                        nextLink

string
Read-only

Link for next page of results.

Operations

GET

/providers/Microsoft.Cache/operations

Lists all of the available REST API operations of the Microsoft.Cache provider.

Request

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Responses

200Success. The response describes the list of operations.

Body

Name	Data Type	Description
`OperationListResult`		Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.

Properties


                        value

array [Operation]

List of operations supported by the resource provider.


                        Operation

object

REST API operation

Properties

`name`	string	Operation name: {provider}/{resource}/{operation}
`display`


                        nextLink

string
Read-only

URL to get the next set of operation list results if there are any.

PatchSchedules

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/patchSchedules

Gets all patch schedules in the specified redis cache (there is only one).

Request

Path

Name	Data Type	Description
`cacheName`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Responses

200Successfully got the current patch schedules

Body

Name	Data Type	Description
`RedisPatchScheduleListResult`		The response of list patch schedules Redis operation.

Properties


                        value

array [RedisPatchSchedule]

Results of the list patch schedules operation.


                        RedisPatchSchedule

Response to put/get patch schedules for Redis cache.

Properties


                        properties

ScheduleEntries

List of patch schedules for a Redis cache.


                        ScheduleEntries

List of patch schedules for a Redis cache.

Properties


                        scheduleEntries

array [ScheduleEntry]

List of patch schedules for a Redis cache.

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends


                        nextLink

string
Read-only

Link for next page of results.

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/{default}

Deletes the patching schedule of a redis cache (requires Premium SKU).

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`default`	string Allowed values: - `default`	Default string modeled as parameter for auto generation to work correctly.
`name`	string	The name of the redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Responses

200Success.

204Success.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/{default}

Gets the patching schedule of a redis cache (requires Premium SKU).

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`default`	string Allowed values: - `default`	Default string modeled as parameter for auto generation to work correctly.
`name`	string	The name of the redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Responses

200Response of get patch schedules.

Body

Name	Data Type	Description
`RedisPatchSchedule`		Response to put/get patch schedules for Redis cache.

Properties


                        properties

ScheduleEntries

List of patch schedules for a Redis cache.


                        ScheduleEntries

List of patch schedules for a Redis cache.

Properties


                        scheduleEntries

array [ScheduleEntry]

List of patch schedules for a Redis cache.


                        ScheduleEntry

Patch schedule entry for a Premium Redis Cache.

Properties

`startHourUtc`	integer	Start hour after which cache patching can start.
`maintenanceWindow`	string	ISO8601 timespan specifying how much time cache patching can take.
`dayOfWeek`	string Allowed values: - `Monday` - `Tuesday` - `Wednesday` - `Thursday` - `Friday` - `Saturday` - `Sunday` - `Everyday` - `Weekend`	Day of the week when a cache can be patched.

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/{default}

Create or replace the patching schedule for Redis cache (requires Premium SKU).

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`default`	string Allowed values: - `default`	Default string modeled as parameter for auto generation to work correctly.
`name`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Body

Name	Data Type	Description
`RedisPatchSchedule`		Response to put/get patch schedules for Redis cache.

Properties


                        properties

ScheduleEntries

List of patch schedules for a Redis cache.


                        ScheduleEntries

List of patch schedules for a Redis cache.

Properties


                        scheduleEntries

array [ScheduleEntry]

List of patch schedules for a Redis cache.


                        ScheduleEntry

Patch schedule entry for a Premium Redis Cache.

Properties

`startHourUtc`	integer	Start hour after which cache patching can start.
`maintenanceWindow`	string	ISO8601 timespan specifying how much time cache patching can take.
`dayOfWeek`	string Allowed values: - `Monday` - `Tuesday` - `Wednesday` - `Thursday` - `Friday` - `Saturday` - `Sunday` - `Everyday` - `Weekend`	Day of the week when a cache can be patched.

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends

Responses

200The patch schedule was successfully updated.

Body

Name	Data Type	Description
`RedisPatchSchedule`		Response to put/get patch schedules for Redis cache.

Properties


                        properties

ScheduleEntries

List of patch schedules for a Redis cache.


                        ScheduleEntries

List of patch schedules for a Redis cache.

Properties


                        scheduleEntries

array [ScheduleEntry]

List of patch schedules for a Redis cache.


                        ScheduleEntry

Patch schedule entry for a Premium Redis Cache.

Properties

`startHourUtc`	integer	Start hour after which cache patching can start.
`maintenanceWindow`	string	ISO8601 timespan specifying how much time cache patching can take.
`dayOfWeek`	string Allowed values: - `Monday` - `Tuesday` - `Wednesday` - `Thursday` - `Friday` - `Saturday` - `Sunday` - `Everyday` - `Weekend`	Day of the week when a cache can be patched.

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends

201The patch schedule was successfully created.

Body

Name	Data Type	Description
`RedisPatchSchedule`		Response to put/get patch schedules for Redis cache.

Properties


                        properties

ScheduleEntries

List of patch schedules for a Redis cache.


                        ScheduleEntries

List of patch schedules for a Redis cache.

Properties


                        scheduleEntries

array [ScheduleEntry]

List of patch schedules for a Redis cache.


                        ScheduleEntry

Patch schedule entry for a Premium Redis Cache.

Properties

`startHourUtc`	integer	Start hour after which cache patching can start.
`maintenanceWindow`	string	ISO8601 timespan specifying how much time cache patching can take.
`dayOfWeek`	string Allowed values: - `Monday` - `Tuesday` - `Wednesday` - `Thursday` - `Friday` - `Saturday` - `Sunday` - `Everyday` - `Weekend`	Day of the week when a cache can be patched.

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends

Redis

POST

/subscriptions/{subscriptionId}/providers/Microsoft.Cache/CheckNameAvailability

Checks that the redis cache name is valid and is not already in use.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Body

Name	Data Type	Description
`CheckNameAvailabilityParameters`		Parameters body to pass for resource name availability check.

Properties

`type`	string	Resource type. The only legal value of this property for checking redis cache name availability is 'Microsoft.Cache/redis'.
`name`	string	Resource name.

Responses

200Name is available

GET

/subscriptions/{subscriptionId}/providers/Microsoft.Cache/Redis

Gets all Redis caches in the specified subscription.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Responses

200OK

Body

Name	Data Type	Description
`RedisListResult`		The response of list Redis operation.

Properties


                        value

array [RedisResource]

List of Redis cache instances.


                        RedisResource

A single Redis item in List or Get Operation.

Properties


                        tags

object

Resource tags.


                        location

string

The geo-location where the resource lives


                        zones

array [string]

A list of availability zones denoting where the resource needs to come from.


                        properties

RedisProperties

Redis cache properties.


                        RedisProperties

Properties of the redis cache.

Properties

`subnetId`	string Pattern: `^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$`	The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network\|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1
`staticIP`	string Pattern: `^\d+\.\d+\.\d+\.\d+$`	Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.
`sku`	Sku	The SKU of the Redis cache to deploy.
`sslPort`	integer Read-only	Redis SSL port.
`redisVersion`	string Read-only	Redis version.
`provisioningState`	string Read-only Allowed values: - `Creating` - `Deleting` - `Disabled` - `Failed` - `Linking` - `Provisioning` - `RecoveringScaleFailure` - `Scaling` - `Succeeded` - `Unlinking` - `Unprovisioning` - `Updating`	Redis instance provisioning status.
`port`	integer Read-only	Redis non-SSL port.
`linkedServers`	array [RedisLinkedServer]	List of the linked servers associated with the cache
`hostName`	string Read-only	Redis host name.
`accessKeys`	RedisAccessKeys Read-only	The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache

Extends

RedisCreateProperties

Properties supplied to Create Redis operation.

Properties

Name Data Type Description


                        tenantSettings

object

A dictionary of tenant settings


                        shardCount

integer

The number of shards to be created on a Premium Cluster Cache.


                        redisConfiguration

object

All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc.


                        minimumTlsVersion

string
Allowed values:
- 1.0
- 1.1
- 1.2

Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')


                        enableNonSslPort

boolean

Specifies whether the non-ssl Redis server port (6379) is enabled.


                        subnetId

string
Pattern:

^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$

The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1


                        staticIP

string
Pattern: ^\d+\.\d+\.\d+\.\d+$

Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.

sku

Sku

The SKU of the Redis cache to deploy.

Sku

SKU parameters supplied to the create Redis operation.

Properties

`name`	string Allowed values: - `Basic` - `Standard` - `Premium`	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
`family`	string Allowed values: - `C` - `P`	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
`capacity`	integer	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).

Extends

TrackedResource

The resource model definition for a ARM tracked top level resource

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`tags`	object	Resource tags.
`location`	string	The geo-location where the resource lives

Extends


                        nextLink

string
Read-only

Link for next page of results.

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules/{ruleName}

Deletes a single firewall rule in a specified redis cache.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`ruleName`	string	The name of the firewall rule.
`cacheName`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Responses

200Successfully deleted the rule

204Successfully deleted the rule

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules/{ruleName}

Gets a single firewall rule in a specified redis cache.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`ruleName`	string	The name of the firewall rule.
`cacheName`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Responses

200Successfully found the rule

Body

Name	Data Type	Description
`RedisFirewallRule`		A firewall rule on a redis cache has a name, and describes a contiguous range of IP addresses permitted to connect

Properties


                        properties

RedisFirewallRuleProperties

redis cache firewall rule properties


                        RedisFirewallRuleProperties

Specifies a range of IP addresses permitted to connect to the cache

Properties

`startIP`	string	lowest IP address included in the range
`endIP`	string	highest IP address included in the range

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules/{ruleName}

Create or update a redis cache firewall rule

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`ruleName`	string	The name of the firewall rule.
`cacheName`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Body

Name	Data Type	Description
`RedisFirewallRuleCreateParameters`		Parameters required for creating a firewall rule on redis cache.

Properties


                        properties

RedisFirewallRuleProperties

Properties required to create a firewall rule .


                        RedisFirewallRuleProperties

Specifies a range of IP addresses permitted to connect to the cache

Properties

`startIP`	string	lowest IP address included in the range
`endIP`	string	highest IP address included in the range

Responses

200Resource was successfully updated

Body

Name	Data Type	Description
`RedisFirewallRule`		A firewall rule on a redis cache has a name, and describes a contiguous range of IP addresses permitted to connect

Properties


                        properties

RedisFirewallRuleProperties

redis cache firewall rule properties


                        RedisFirewallRuleProperties

Specifies a range of IP addresses permitted to connect to the cache

Properties

`startIP`	string	lowest IP address included in the range
`endIP`	string	highest IP address included in the range

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends

201Resource was successfully created

Body

Name	Data Type	Description
`RedisFirewallRule`		A firewall rule on a redis cache has a name, and describes a contiguous range of IP addresses permitted to connect

Properties


                        properties

RedisFirewallRuleProperties

redis cache firewall rule properties


                        RedisFirewallRuleProperties

Specifies a range of IP addresses permitted to connect to the cache

Properties

`startIP`	string	lowest IP address included in the range
`endIP`	string	highest IP address included in the range

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules

Gets all firewall rules in the specified redis cache.

Request

Path

Name	Data Type	Description
`cacheName`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Responses

200Successfully got the current rules

Body

Name	Data Type	Description
`RedisFirewallRuleListResult`		The response of list firewall rules Redis operation.

Properties


                        value

array [RedisFirewallRule]

Results of the list firewall rules operation.


                        RedisFirewallRule

A firewall rule on a redis cache has a name, and describes a contiguous range of IP addresses permitted to connect

Properties


                        properties

RedisFirewallRuleProperties

redis cache firewall rule properties


                        RedisFirewallRuleProperties

Specifies a range of IP addresses permitted to connect to the cache

Properties

`startIP`	string	lowest IP address included in the range
`endIP`	string	highest IP address included in the range

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends


                        nextLink

string
Read-only

Link for next page of results.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/patchSchedules

Gets all patch schedules in the specified redis cache (there is only one).

Request

Path

Name	Data Type	Description
`cacheName`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Responses

200Successfully got the current patch schedules

Body

Name	Data Type	Description
`RedisPatchScheduleListResult`		The response of list patch schedules Redis operation.

Properties


                        value

array [RedisPatchSchedule]

Results of the list patch schedules operation.


                        RedisPatchSchedule

Response to put/get patch schedules for Redis cache.

Properties


                        properties

ScheduleEntries

List of patch schedules for a Redis cache.


                        ScheduleEntries

List of patch schedules for a Redis cache.

Properties


                        scheduleEntries

array [ScheduleEntry]

List of patch schedules for a Redis cache.

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends


                        nextLink

string
Read-only

Link for next page of results.

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/export

Export data from the redis cache to blobs in a container.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`name`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Body

Name	Data Type	Description
`ExportRDBParameters`		Parameters for Redis export operation.

Properties

`prefix`	string	Prefix to use for exported files.
`format`	string	File format.
`container`	string	Container name to export to.

Responses

200Export operation succeeded.

202Export operation successfully enqueued; follow the Location header to poll for final outcome.

204Export operation succeeded.

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/forceReboot

Reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`name`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Body

Name	Data Type	Description
`RedisRebootParameters`		Specifies which Redis node(s) to reboot.

Properties

`shardId`	integer	If clustering is enabled, the ID of the shard to be rebooted.
`rebootType`	string Allowed values: - `PrimaryNode` - `SecondaryNode` - `AllNodes`	Which Redis node(s) to reboot. Depending on this value data loss is possible.

Responses

200Reboot operation successfully enqueued

Body

Name	Data Type	Description
`RedisForceRebootResponse`		Response to force reboot for Redis cache.

Properties


                        message

string
Read-only

Status message

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/import

Import data into Redis cache.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`name`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Body

Name	Data Type	Description
`ImportRDBParameters`		Parameters for Redis import operation.

Properties

`format`	string	File format.
`files`	array [string]	files to import.

Responses

200Import operation succeeded.

202Import operation successfully enqueued; follow the Location header to poll for final outcome.

204Import operation succeeded.

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/linkedServers/{linkedServerName}

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

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`linkedServerName`	string	The name of the linked server that is being added to the Redis cache.
`name`	string	The name of the redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Responses

200Linked server was successfully deleted.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/linkedServers/{linkedServerName}

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

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`linkedServerName`	string	The name of the linked server.
`name`	string	The name of the redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Responses

200Response of get linked server.

Body

Name	Data Type	Description
`RedisLinkedServerWithProperties`		Response to put/get linked server (with properties) for Redis cache.

Properties


                        properties

RedisLinkedServerProperties

Properties of the linked server.


                        RedisLinkedServerProperties

Properties of a linked server to be returned in get/put response

Properties

`serverRole`	string Allowed values: - `Primary` - `Secondary`	Role of the linked server.
`linkedRedisCacheLocation`	string	Location of the linked redis cache.
`linkedRedisCacheId`	string	Fully qualified resourceId of the linked redis cache.
`provisioningState`	string Read-only	Terminal state of the link between primary and secondary redis cache.

Extends

RedisLinkedServerCreateProperties

Create properties for a linked server

Properties

Name	Data Type	Description
`serverRole`	string Allowed values: - `Primary` - `Secondary`	Role of the linked server.
`linkedRedisCacheLocation`	string	Location of the linked redis cache.
`linkedRedisCacheId`	string	Fully qualified resourceId of the linked redis cache.

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/linkedServers/{linkedServerName}

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

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`linkedServerName`	string	The name of the linked server that is being added to the Redis cache.
`name`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Body

Name	Data Type	Description
`RedisLinkedServerCreateParameters`		Parameter required for creating a linked server to redis cache.

Properties


                        properties

RedisLinkedServerCreateProperties

Properties required to create a linked server.


                        RedisLinkedServerCreateProperties

Create properties for a linked server

Properties

`serverRole`	string Allowed values: - `Primary` - `Secondary`	Role of the linked server.
`linkedRedisCacheLocation`	string	Location of the linked redis cache.
`linkedRedisCacheId`	string	Fully qualified resourceId of the linked redis cache.

Responses

200The linked server was successfully added.

Body

Name	Data Type	Description
`RedisLinkedServerWithProperties`		Response to put/get linked server (with properties) for Redis cache.

Properties


                        properties

RedisLinkedServerProperties

Properties of the linked server.


                        RedisLinkedServerProperties

Properties of a linked server to be returned in get/put response

Properties

`serverRole`	string Allowed values: - `Primary` - `Secondary`	Role of the linked server.
`linkedRedisCacheLocation`	string	Location of the linked redis cache.
`linkedRedisCacheId`	string	Fully qualified resourceId of the linked redis cache.
`provisioningState`	string Read-only	Terminal state of the link between primary and secondary redis cache.

Extends

RedisLinkedServerCreateProperties

Create properties for a linked server

Properties

Name	Data Type	Description
`serverRole`	string Allowed values: - `Primary` - `Secondary`	Role of the linked server.
`linkedRedisCacheLocation`	string	Location of the linked redis cache.
`linkedRedisCacheId`	string	Fully qualified resourceId of the linked redis cache.

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends

201The linked server was successfully added.

Body

Name	Data Type	Description
`RedisLinkedServerWithProperties`		Response to put/get linked server (with properties) for Redis cache.

Properties


                        properties

RedisLinkedServerProperties

Properties of the linked server.


                        RedisLinkedServerProperties

Properties of a linked server to be returned in get/put response

Properties

`serverRole`	string Allowed values: - `Primary` - `Secondary`	Role of the linked server.
`linkedRedisCacheLocation`	string	Location of the linked redis cache.
`linkedRedisCacheId`	string	Fully qualified resourceId of the linked redis cache.
`provisioningState`	string Read-only	Terminal state of the link between primary and secondary redis cache.

Extends

RedisLinkedServerCreateProperties

Create properties for a linked server

Properties

Name	Data Type	Description
`serverRole`	string Allowed values: - `Primary` - `Secondary`	Role of the linked server.
`linkedRedisCacheLocation`	string	Location of the linked redis cache.
`linkedRedisCacheId`	string	Fully qualified resourceId of the linked redis cache.

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/linkedServers

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

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`name`	string	The name of the redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Responses

200Response of get linked servers.

Body

Name	Data Type	Description
`RedisLinkedServerWithPropertiesList`		List of linked servers (with properties) of a Redis cache.

Properties


                        value

array [RedisLinkedServerWithProperties]

List of linked servers (with properties) of a Redis cache.


                        RedisLinkedServerWithProperties

Response to put/get linked server (with properties) for Redis cache.

Properties


                        properties

RedisLinkedServerProperties

Properties of the linked server.


                        RedisLinkedServerProperties

Properties of a linked server to be returned in get/put response

Properties

`serverRole`	string Allowed values: - `Primary` - `Secondary`	Role of the linked server.
`linkedRedisCacheLocation`	string	Location of the linked redis cache.
`linkedRedisCacheId`	string	Fully qualified resourceId of the linked redis cache.
`provisioningState`	string Read-only	Terminal state of the link between primary and secondary redis cache.

Extends

RedisLinkedServerCreateProperties

Create properties for a linked server

Properties

Name	Data Type	Description
`serverRole`	string Allowed values: - `Primary` - `Secondary`	Role of the linked server.
`linkedRedisCacheLocation`	string	Location of the linked redis cache.
`linkedRedisCacheId`	string	Fully qualified resourceId of the linked redis cache.

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends


                        nextLink

string
Read-only

Link for next set.

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/listKeys

Retrieve a Redis cache's access keys. This operation requires write permission to the cache resource.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`name`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Responses

200Lists the keys for the specified Redis cache.

Body

Name	Data Type	Description
`RedisAccessKeys`		Redis cache access keys.

Properties

`secondaryKey`	string Read-only	The current secondary key that clients can use to authenticate with Redis cache.
`primaryKey`	string Read-only	The current primary key that clients can use to authenticate with Redis cache.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/listUpgradeNotifications

Gets any upgrade notifications for a Redis cache.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`name`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`history`	double	how many minutes in past to look for upgrade notifications
`api-version`	string	Client Api Version.

Responses

200All upgrade notifications in given time range

Body

Name	Data Type	Description
`NotificationListResponse`		The response of listUpgradeNotifications.

Properties


                        value

array [UpgradeNotification]

List of all notifications.


                        UpgradeNotification

Properties of upgrade notification.

Properties

`upsellNotification`	object Read-only	Details about this upgrade notification
`timestamp`	dateTime Read-only	Timestamp when upgrade notification occurred.
`name`	string Read-only	Name of upgrade notification.


                        nextLink

string
Read-only

Link for next set of notifications.

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/{default}

Deletes the patching schedule of a redis cache (requires Premium SKU).

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`default`	string Allowed values: - `default`	Default string modeled as parameter for auto generation to work correctly.
`name`	string	The name of the redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Responses

200Success.

204Success.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/{default}

Gets the patching schedule of a redis cache (requires Premium SKU).

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`default`	string Allowed values: - `default`	Default string modeled as parameter for auto generation to work correctly.
`name`	string	The name of the redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Responses

200Response of get patch schedules.

Body

Name	Data Type	Description
`RedisPatchSchedule`		Response to put/get patch schedules for Redis cache.

Properties


                        properties

ScheduleEntries

List of patch schedules for a Redis cache.


                        ScheduleEntries

List of patch schedules for a Redis cache.

Properties


                        scheduleEntries

array [ScheduleEntry]

List of patch schedules for a Redis cache.


                        ScheduleEntry

Patch schedule entry for a Premium Redis Cache.

Properties

`startHourUtc`	integer	Start hour after which cache patching can start.
`maintenanceWindow`	string	ISO8601 timespan specifying how much time cache patching can take.
`dayOfWeek`	string Allowed values: - `Monday` - `Tuesday` - `Wednesday` - `Thursday` - `Friday` - `Saturday` - `Sunday` - `Everyday` - `Weekend`	Day of the week when a cache can be patched.

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/{default}

Create or replace the patching schedule for Redis cache (requires Premium SKU).

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`default`	string Allowed values: - `default`	Default string modeled as parameter for auto generation to work correctly.
`name`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Body

Name	Data Type	Description
`RedisPatchSchedule`		Response to put/get patch schedules for Redis cache.

Properties


                        properties

ScheduleEntries

List of patch schedules for a Redis cache.


                        ScheduleEntries

List of patch schedules for a Redis cache.

Properties


                        scheduleEntries

array [ScheduleEntry]

List of patch schedules for a Redis cache.


                        ScheduleEntry

Patch schedule entry for a Premium Redis Cache.

Properties

`startHourUtc`	integer	Start hour after which cache patching can start.
`maintenanceWindow`	string	ISO8601 timespan specifying how much time cache patching can take.
`dayOfWeek`	string Allowed values: - `Monday` - `Tuesday` - `Wednesday` - `Thursday` - `Friday` - `Saturday` - `Sunday` - `Everyday` - `Weekend`	Day of the week when a cache can be patched.

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends

Responses

200The patch schedule was successfully updated.

Body

Name	Data Type	Description
`RedisPatchSchedule`		Response to put/get patch schedules for Redis cache.

Properties


                        properties

ScheduleEntries

List of patch schedules for a Redis cache.


                        ScheduleEntries

List of patch schedules for a Redis cache.

Properties


                        scheduleEntries

array [ScheduleEntry]

List of patch schedules for a Redis cache.


                        ScheduleEntry

Patch schedule entry for a Premium Redis Cache.

Properties

`startHourUtc`	integer	Start hour after which cache patching can start.
`maintenanceWindow`	string	ISO8601 timespan specifying how much time cache patching can take.
`dayOfWeek`	string Allowed values: - `Monday` - `Tuesday` - `Wednesday` - `Thursday` - `Friday` - `Saturday` - `Sunday` - `Everyday` - `Weekend`	Day of the week when a cache can be patched.

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends

201The patch schedule was successfully created.

Body

Name	Data Type	Description
`RedisPatchSchedule`		Response to put/get patch schedules for Redis cache.

Properties


                        properties

ScheduleEntries

List of patch schedules for a Redis cache.


                        ScheduleEntries

List of patch schedules for a Redis cache.

Properties


                        scheduleEntries

array [ScheduleEntry]

List of patch schedules for a Redis cache.


                        ScheduleEntry

Patch schedule entry for a Premium Redis Cache.

Properties

`startHourUtc`	integer	Start hour after which cache patching can start.
`maintenanceWindow`	string	ISO8601 timespan specifying how much time cache patching can take.
`dayOfWeek`	string Allowed values: - `Monday` - `Tuesday` - `Wednesday` - `Thursday` - `Friday` - `Saturday` - `Sunday` - `Everyday` - `Weekend`	Day of the week when a cache can be patched.

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/regenerateKey

Regenerate Redis cache's access keys. This operation requires write permission to the cache resource.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`name`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Body

Name	Data Type	Description
`RedisRegenerateKeyParameters`		Specifies which Redis access keys to reset.

Properties


                        keyType

string
Allowed values:
- Primary
- Secondary

The Redis access key to regenerate.

Responses

200Lists the regenerated keys for Redis Cache

Body

Name	Data Type	Description
`RedisAccessKeys`		Redis cache access keys.

Properties

`secondaryKey`	string Read-only	The current secondary key that clients can use to authenticate with Redis cache.
`primaryKey`	string Read-only	The current primary key that clients can use to authenticate with Redis cache.

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}

Deletes a Redis cache.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`name`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Responses

200The redis cache was successfully deleted.

202The redis cache 'delete' operation was successfully enqueued; follow the Location header to poll for final outcome.

204The redis cache was successfully deleted.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}

Gets a Redis cache (resource description).

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`name`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Responses

200The redis cache was successfully found.

Body

Name	Data Type	Description
`RedisResource`		A single Redis item in List or Get Operation.

Properties


                        tags

object

Resource tags.


                        location

string

The geo-location where the resource lives


                        zones

array [string]

A list of availability zones denoting where the resource needs to come from.


                        properties

RedisProperties

Redis cache properties.


                        RedisProperties

Properties of the redis cache.

Properties


                        subnetId

string
Pattern:

^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$


                        staticIP

string
Pattern: ^\d+\.\d+\.\d+\.\d+$

Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.

sku

Sku

The SKU of the Redis cache to deploy.

Sku

SKU parameters supplied to the create Redis operation.

Properties

`name`	string Allowed values: - `Basic` - `Standard` - `Premium`	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
`family`	string Allowed values: - `C` - `P`	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
`capacity`	integer	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).


                        sslPort

integer
Read-only

Redis SSL port.


                        redisVersion

string
Read-only

Redis version.


                        provisioningState

string
Read-only
Allowed values:
- Creating
- Deleting
- Disabled
- Failed
- Linking
- Provisioning
- RecoveringScaleFailure
- Scaling
- Succeeded
- Unlinking
- Unprovisioning
- Updating

Redis instance provisioning status.


                        port

integer
Read-only

Redis non-SSL port.


                        linkedServers

array [RedisLinkedServer]

List of the linked servers associated with the cache


                        RedisLinkedServer

Linked server Id

Properties

id

string
Read-only

Linked server Id.


                        hostName

string
Read-only

Redis host name.


                        accessKeys

RedisAccessKeys
Read-only

The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache


                        RedisAccessKeys

Redis cache access keys.

Properties

`secondaryKey`	string Read-only	The current secondary key that clients can use to authenticate with Redis cache.
`primaryKey`	string Read-only	The current primary key that clients can use to authenticate with Redis cache.

Extends

RedisCreateProperties

Properties supplied to Create Redis operation.

Properties

Name Data Type Description


                        tenantSettings

object

A dictionary of tenant settings


                        shardCount

integer

The number of shards to be created on a Premium Cluster Cache.


                        redisConfiguration

object


                        minimumTlsVersion

string
Allowed values:
- 1.0
- 1.1
- 1.2

Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')


                        enableNonSslPort

boolean

Specifies whether the non-ssl Redis server port (6379) is enabled.


                        subnetId

string
Pattern:

^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$


                        staticIP

string
Pattern: ^\d+\.\d+\.\d+\.\d+$

Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.

sku

Sku

The SKU of the Redis cache to deploy.

Sku

SKU parameters supplied to the create Redis operation.

Properties

`name`	string Allowed values: - `Basic` - `Standard` - `Premium`	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
`family`	string Allowed values: - `C` - `P`	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
`capacity`	integer	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).

Extends

TrackedResource

The resource model definition for a ARM tracked top level resource

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`tags`	object	Resource tags.
`location`	string	The geo-location where the resource lives

Extends

PATCH

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}

Update an existing Redis cache.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`name`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Body

Name	Data Type	Description
`RedisUpdateParameters`		Parameters supplied to the Update Redis operation.

Properties


                        tags

object

Resource tags.


                        properties

RedisUpdateProperties

Redis cache properties.


                        RedisUpdateProperties

Patchable properties of the redis cache.

Properties


                        tenantSettings

object

A dictionary of tenant settings


                        shardCount

integer

The number of shards to be created on a Premium Cluster Cache.


                        redisConfiguration

object


                        minimumTlsVersion

string
Allowed values:
- 1.0
- 1.1
- 1.2

Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')


                        enableNonSslPort

boolean

Specifies whether the non-ssl Redis server port (6379) is enabled.

sku

Sku

The SKU of the Redis cache to deploy.

Sku

SKU parameters supplied to the create Redis operation.

Properties

`name`	string Allowed values: - `Basic` - `Standard` - `Premium`	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
`family`	string Allowed values: - `C` - `P`	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
`capacity`	integer	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).

Extends

RedisCommonProperties

Create/Update/Get common properties of the redis cache.

Properties

Name	Data Type	Description
`tenantSettings`	object	A dictionary of tenant settings
`shardCount`	integer	The number of shards to be created on a Premium Cluster Cache.
`redisConfiguration`	object	All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc.
`minimumTlsVersion`	string Allowed values: - `1.0` - `1.1` - `1.2`	Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')
`enableNonSslPort`	boolean	Specifies whether the non-ssl Redis server port (6379) is enabled.

Responses

200The existing redis cache was successfully updated. Check provisioningState to see detailed status.

Body

Name	Data Type	Description
`RedisResource`		A single Redis item in List or Get Operation.

Properties


                        tags

object

Resource tags.


                        location

string

The geo-location where the resource lives


                        zones

array [string]

A list of availability zones denoting where the resource needs to come from.


                        properties

RedisProperties

Redis cache properties.


                        RedisProperties

Properties of the redis cache.

Properties


                        subnetId

string
Pattern:

^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$


                        staticIP

string
Pattern: ^\d+\.\d+\.\d+\.\d+$

Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.

sku

Sku

The SKU of the Redis cache to deploy.

Sku

SKU parameters supplied to the create Redis operation.

Properties

`name`	string Allowed values: - `Basic` - `Standard` - `Premium`	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
`family`	string Allowed values: - `C` - `P`	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
`capacity`	integer	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).


                        sslPort

integer
Read-only

Redis SSL port.


                        redisVersion

string
Read-only

Redis version.


                        provisioningState

Redis instance provisioning status.


                        port

integer
Read-only

Redis non-SSL port.


                        linkedServers

array [RedisLinkedServer]

List of the linked servers associated with the cache


                        RedisLinkedServer

Linked server Id

Properties

id

string
Read-only

Linked server Id.


                        hostName

string
Read-only

Redis host name.


                        accessKeys

RedisAccessKeys
Read-only

The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache


                        RedisAccessKeys

Redis cache access keys.

Properties

`secondaryKey`	string Read-only	The current secondary key that clients can use to authenticate with Redis cache.
`primaryKey`	string Read-only	The current primary key that clients can use to authenticate with Redis cache.

Extends

RedisCreateProperties

Properties supplied to Create Redis operation.

Properties

Name Data Type Description


                        tenantSettings

object

A dictionary of tenant settings


                        shardCount

integer

The number of shards to be created on a Premium Cluster Cache.


                        redisConfiguration

object


                        minimumTlsVersion

string
Allowed values:
- 1.0
- 1.1
- 1.2

Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')


                        enableNonSslPort

boolean

Specifies whether the non-ssl Redis server port (6379) is enabled.


                        subnetId

string
Pattern:

^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$


                        staticIP

string
Pattern: ^\d+\.\d+\.\d+\.\d+$

Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.

sku

Sku

The SKU of the Redis cache to deploy.

Sku

SKU parameters supplied to the create Redis operation.

Properties

`name`	string Allowed values: - `Basic` - `Standard` - `Premium`	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
`family`	string Allowed values: - `C` - `P`	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
`capacity`	integer	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).

Extends

TrackedResource

The resource model definition for a ARM tracked top level resource

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`tags`	object	Resource tags.
`location`	string	The geo-location where the resource lives

Extends

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}

Create or replace (overwrite/recreate, with potential downtime) an existing Redis cache.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`name`	string	The name of the Redis cache.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Body

Name	Data Type	Description
`RedisCreateParameters`		Parameters supplied to the Create Redis operation.

Properties


                        zones

array [string]

A list of availability zones denoting where the resource needs to come from.


                        tags

object

Resource tags.


                        properties

RedisCreateProperties

Redis cache properties.


                        RedisCreateProperties

Properties supplied to Create Redis operation.

Properties


                        tenantSettings

object

A dictionary of tenant settings


                        shardCount

integer

The number of shards to be created on a Premium Cluster Cache.


                        redisConfiguration

object


                        minimumTlsVersion

string
Allowed values:
- 1.0
- 1.1
- 1.2

Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')


                        enableNonSslPort

boolean

Specifies whether the non-ssl Redis server port (6379) is enabled.


                        subnetId

string
Pattern:

^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$


                        staticIP

string
Pattern: ^\d+\.\d+\.\d+\.\d+$

Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.

sku

Sku

The SKU of the Redis cache to deploy.

Sku

SKU parameters supplied to the create Redis operation.

Properties

`name`	string Allowed values: - `Basic` - `Standard` - `Premium`	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
`family`	string Allowed values: - `C` - `P`	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
`capacity`	integer	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).

Extends

RedisCommonProperties

Create/Update/Get common properties of the redis cache.

Properties

Name	Data Type	Description
`tenantSettings`	object	A dictionary of tenant settings
`shardCount`	integer	The number of shards to be created on a Premium Cluster Cache.
`redisConfiguration`	object	All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc.
`minimumTlsVersion`	string Allowed values: - `1.0` - `1.1` - `1.2`	Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')
`enableNonSslPort`	boolean	Specifies whether the non-ssl Redis server port (6379) is enabled.


                        location

string

The geo-location where the resource lives

Responses

200The existing redis cache was successfully updated. Check provisioningState to see detailed status.

Body

Name	Data Type	Description
`RedisResource`		A single Redis item in List or Get Operation.

Properties


                        tags

object

Resource tags.


                        location

string

The geo-location where the resource lives


                        zones

array [string]

A list of availability zones denoting where the resource needs to come from.


                        properties

RedisProperties

Redis cache properties.


                        RedisProperties

Properties of the redis cache.

Properties


                        subnetId

string
Pattern:

^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$


                        staticIP

string
Pattern: ^\d+\.\d+\.\d+\.\d+$

Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.

sku

Sku

The SKU of the Redis cache to deploy.

Sku

SKU parameters supplied to the create Redis operation.

Properties

`name`	string Allowed values: - `Basic` - `Standard` - `Premium`	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
`family`	string Allowed values: - `C` - `P`	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
`capacity`	integer	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).


                        sslPort

integer
Read-only

Redis SSL port.


                        redisVersion

string
Read-only

Redis version.


                        provisioningState

Redis instance provisioning status.


                        port

integer
Read-only

Redis non-SSL port.


                        linkedServers

array [RedisLinkedServer]

List of the linked servers associated with the cache


                        RedisLinkedServer

Linked server Id

Properties

id

string
Read-only

Linked server Id.


                        hostName

string
Read-only

Redis host name.


                        accessKeys

RedisAccessKeys
Read-only

The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache


                        RedisAccessKeys

Redis cache access keys.

Properties

`secondaryKey`	string Read-only	The current secondary key that clients can use to authenticate with Redis cache.
`primaryKey`	string Read-only	The current primary key that clients can use to authenticate with Redis cache.

Extends

RedisCreateProperties

Properties supplied to Create Redis operation.

Properties

Name Data Type Description


                        tenantSettings

object

A dictionary of tenant settings


                        shardCount

integer

The number of shards to be created on a Premium Cluster Cache.


                        redisConfiguration

object


                        minimumTlsVersion

string
Allowed values:
- 1.0
- 1.1
- 1.2

Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')


                        enableNonSslPort

boolean

Specifies whether the non-ssl Redis server port (6379) is enabled.


                        subnetId

string
Pattern:

^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$


                        staticIP

string
Pattern: ^\d+\.\d+\.\d+\.\d+$

Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.

sku

Sku

The SKU of the Redis cache to deploy.

Sku

SKU parameters supplied to the create Redis operation.

Properties

`name`	string Allowed values: - `Basic` - `Standard` - `Premium`	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
`family`	string Allowed values: - `C` - `P`	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
`capacity`	integer	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).

Extends

TrackedResource

The resource model definition for a ARM tracked top level resource

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`tags`	object	Resource tags.
`location`	string	The geo-location where the resource lives

Extends

201The new redis cache was successfully created. Check provisioningState to see detailed status.

Body

Name	Data Type	Description
`RedisResource`		A single Redis item in List or Get Operation.

Properties


                        tags

object

Resource tags.


                        location

string

The geo-location where the resource lives


                        zones

array [string]

A list of availability zones denoting where the resource needs to come from.


                        properties

RedisProperties

Redis cache properties.


                        RedisProperties

Properties of the redis cache.

Properties


                        subnetId

string
Pattern:

^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$


                        staticIP

string
Pattern: ^\d+\.\d+\.\d+\.\d+$

Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.

sku

Sku

The SKU of the Redis cache to deploy.

Sku

SKU parameters supplied to the create Redis operation.

Properties

`name`	string Allowed values: - `Basic` - `Standard` - `Premium`	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
`family`	string Allowed values: - `C` - `P`	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
`capacity`	integer	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).


                        sslPort

integer
Read-only

Redis SSL port.


                        redisVersion

string
Read-only

Redis version.


                        provisioningState

Redis instance provisioning status.


                        port

integer
Read-only

Redis non-SSL port.


                        linkedServers

array [RedisLinkedServer]

List of the linked servers associated with the cache


                        RedisLinkedServer

Linked server Id

Properties

id

string
Read-only

Linked server Id.


                        hostName

string
Read-only

Redis host name.


                        accessKeys

RedisAccessKeys
Read-only

The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache


                        RedisAccessKeys

Redis cache access keys.

Properties

`secondaryKey`	string Read-only	The current secondary key that clients can use to authenticate with Redis cache.
`primaryKey`	string Read-only	The current primary key that clients can use to authenticate with Redis cache.

Extends

RedisCreateProperties

Properties supplied to Create Redis operation.

Properties

Name Data Type Description


                        tenantSettings

object

A dictionary of tenant settings


                        shardCount

integer

The number of shards to be created on a Premium Cluster Cache.


                        redisConfiguration

object


                        minimumTlsVersion

string
Allowed values:
- 1.0
- 1.1
- 1.2

Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')


                        enableNonSslPort

boolean

Specifies whether the non-ssl Redis server port (6379) is enabled.


                        subnetId

string
Pattern:

^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$


                        staticIP

string
Pattern: ^\d+\.\d+\.\d+\.\d+$

Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.

sku

Sku

The SKU of the Redis cache to deploy.

Sku

SKU parameters supplied to the create Redis operation.

Properties

`name`	string Allowed values: - `Basic` - `Standard` - `Premium`	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
`family`	string Allowed values: - `C` - `P`	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
`capacity`	integer	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).

Extends

TrackedResource

The resource model definition for a ARM tracked top level resource

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`tags`	object	Resource tags.
`location`	string	The geo-location where the resource lives

Extends

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis

Lists all Redis caches in a resource group.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Client Api Version.

Responses

200OK

Body

Name	Data Type	Description
`RedisListResult`		The response of list Redis operation.

Properties


                        value

array [RedisResource]

List of Redis cache instances.


                        RedisResource

A single Redis item in List or Get Operation.

Properties


                        tags

object

Resource tags.


                        location

string

The geo-location where the resource lives


                        zones

array [string]

A list of availability zones denoting where the resource needs to come from.


                        properties

RedisProperties

Redis cache properties.


                        RedisProperties

Properties of the redis cache.

Properties

`subnetId`	string Pattern: `^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$`	The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network\|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1
`staticIP`	string Pattern: `^\d+\.\d+\.\d+\.\d+$`	Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.
`sku`	Sku	The SKU of the Redis cache to deploy.
`sslPort`	integer Read-only	Redis SSL port.
`redisVersion`	string Read-only	Redis version.
`provisioningState`	string Read-only Allowed values: - `Creating` - `Deleting` - `Disabled` - `Failed` - `Linking` - `Provisioning` - `RecoveringScaleFailure` - `Scaling` - `Succeeded` - `Unlinking` - `Unprovisioning` - `Updating`	Redis instance provisioning status.
`port`	integer Read-only	Redis non-SSL port.
`linkedServers`	array [RedisLinkedServer]	List of the linked servers associated with the cache
`hostName`	string Read-only	Redis host name.
`accessKeys`	RedisAccessKeys Read-only	The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache

Extends

RedisCreateProperties

Properties supplied to Create Redis operation.

Properties

Name Data Type Description


                        tenantSettings

object

A dictionary of tenant settings


                        shardCount

integer

The number of shards to be created on a Premium Cluster Cache.


                        redisConfiguration

object


                        minimumTlsVersion

string
Allowed values:
- 1.0
- 1.1
- 1.2

Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')


                        enableNonSslPort

boolean

Specifies whether the non-ssl Redis server port (6379) is enabled.


                        subnetId

string
Pattern:

^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$


                        staticIP

string
Pattern: ^\d+\.\d+\.\d+\.\d+$

Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.

sku

Sku

The SKU of the Redis cache to deploy.

Sku

SKU parameters supplied to the create Redis operation.

Properties

`name`	string Allowed values: - `Basic` - `Standard` - `Premium`	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
`family`	string Allowed values: - `C` - `P`	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
`capacity`	integer	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).

Extends

TrackedResource

The resource model definition for a ARM tracked top level resource

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`tags`	object	Resource tags.
`location`	string	The geo-location where the resource lives

Extends


                        nextLink

string
Read-only

Link for next page of results.

Models

CheckNameAvailabilityParameters

ExportRDBParameters

ImportRDBParameters

NotificationListResponse

The response of listUpgradeNotifications.

Properties

Name Data Type Description


                        value

array [UpgradeNotification]

List of all notifications.


                        UpgradeNotification

Properties of upgrade notification.

Properties

`upsellNotification`	object Read-only	Details about this upgrade notification
`timestamp`	dateTime Read-only	Timestamp when upgrade notification occurred.
`name`	string Read-only	Name of upgrade notification.


                        nextLink

string
Read-only

Link for next set of notifications.

Operation

OperationListResult

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends

Resource

The Resource definition.

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

RedisAccessKeys

RedisCommonProperties

Create/Update/Get common properties of the redis cache.

Properties

Name	Data Type	Description
`tenantSettings`	object	A dictionary of tenant settings
`shardCount`	integer	The number of shards to be created on a Premium Cluster Cache.
`redisConfiguration`	object	All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc.
`minimumTlsVersion`	string Allowed values: - `1.0` - `1.1` - `1.2`	Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')
`enableNonSslPort`	boolean	Specifies whether the non-ssl Redis server port (6379) is enabled.

RedisCreateParameters

Parameters supplied to the Create Redis operation.

Properties

Name Data Type Description


                        zones

array [string]

A list of availability zones denoting where the resource needs to come from.


                        tags

object

Resource tags.


                        properties

RedisCreateProperties

Redis cache properties.


                        RedisCreateProperties

Properties supplied to Create Redis operation.

Properties


                        tenantSettings

object

A dictionary of tenant settings


                        shardCount

integer

The number of shards to be created on a Premium Cluster Cache.


                        redisConfiguration

object


                        minimumTlsVersion

string
Allowed values:
- 1.0
- 1.1
- 1.2

Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')


                        enableNonSslPort

boolean

Specifies whether the non-ssl Redis server port (6379) is enabled.


                        subnetId

string
Pattern:

^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$


                        staticIP

string
Pattern: ^\d+\.\d+\.\d+\.\d+$

Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.

sku

Sku

The SKU of the Redis cache to deploy.

Sku

SKU parameters supplied to the create Redis operation.

Properties

`name`	string Allowed values: - `Basic` - `Standard` - `Premium`	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
`family`	string Allowed values: - `C` - `P`	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
`capacity`	integer	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).

Extends

RedisCommonProperties

Create/Update/Get common properties of the redis cache.

Properties

Name	Data Type	Description
`tenantSettings`	object	A dictionary of tenant settings
`shardCount`	integer	The number of shards to be created on a Premium Cluster Cache.
`redisConfiguration`	object	All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc.
`minimumTlsVersion`	string Allowed values: - `1.0` - `1.1` - `1.2`	Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')
`enableNonSslPort`	boolean	Specifies whether the non-ssl Redis server port (6379) is enabled.


                        location

string

The geo-location where the resource lives

RedisCreateProperties

Properties supplied to Create Redis operation.

Properties

Name Data Type Description


                        tenantSettings

object

A dictionary of tenant settings


                        shardCount

integer

The number of shards to be created on a Premium Cluster Cache.


                        redisConfiguration

object


                        minimumTlsVersion

string
Allowed values:
- 1.0
- 1.1
- 1.2

Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')


                        enableNonSslPort

boolean

Specifies whether the non-ssl Redis server port (6379) is enabled.


                        subnetId

string
Pattern:

^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$


                        staticIP

string
Pattern: ^\d+\.\d+\.\d+\.\d+$

Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.

sku

Sku

The SKU of the Redis cache to deploy.

Sku

SKU parameters supplied to the create Redis operation.

Properties

`name`	string Allowed values: - `Basic` - `Standard` - `Premium`	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
`family`	string Allowed values: - `C` - `P`	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
`capacity`	integer	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).

Extends

RedisCommonProperties

Create/Update/Get common properties of the redis cache.

Properties

Name	Data Type	Description
`tenantSettings`	object	A dictionary of tenant settings
`shardCount`	integer	The number of shards to be created on a Premium Cluster Cache.
`redisConfiguration`	object	All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc.
`minimumTlsVersion`	string Allowed values: - `1.0` - `1.1` - `1.2`	Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')
`enableNonSslPort`	boolean	Specifies whether the non-ssl Redis server port (6379) is enabled.

RedisFirewallRule

A firewall rule on a redis cache has a name, and describes a contiguous range of IP addresses permitted to connect

Properties

Name Data Type Description


                        properties

RedisFirewallRuleProperties

redis cache firewall rule properties


                        RedisFirewallRuleProperties

Specifies a range of IP addresses permitted to connect to the cache

Properties

`startIP`	string	lowest IP address included in the range
`endIP`	string	highest IP address included in the range

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends

RedisFirewallRuleCreateParameters

RedisFirewallRuleListResult

The response of list firewall rules Redis operation.

Properties

Name Data Type Description


                        value

array [RedisFirewallRule]

Results of the list firewall rules operation.


                        RedisFirewallRule

A firewall rule on a redis cache has a name, and describes a contiguous range of IP addresses permitted to connect

Properties


                        properties

RedisFirewallRuleProperties

redis cache firewall rule properties


                        RedisFirewallRuleProperties

Specifies a range of IP addresses permitted to connect to the cache

Properties

`startIP`	string	lowest IP address included in the range
`endIP`	string	highest IP address included in the range

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends


                        nextLink

string
Read-only

Link for next page of results.

RedisFirewallRuleProperties

RedisForceRebootResponse

RedisLinkedServer

RedisLinkedServerCreateParameters

RedisLinkedServerCreateProperties

RedisLinkedServerProperties

Properties of a linked server to be returned in get/put response

Properties

Name	Data Type	Description
`serverRole`	string Allowed values: - `Primary` - `Secondary`	Role of the linked server.
`linkedRedisCacheLocation`	string	Location of the linked redis cache.
`linkedRedisCacheId`	string	Fully qualified resourceId of the linked redis cache.
`provisioningState`	string Read-only	Terminal state of the link between primary and secondary redis cache.

Extends

RedisLinkedServerCreateProperties

Create properties for a linked server

Properties

Name	Data Type	Description
`serverRole`	string Allowed values: - `Primary` - `Secondary`	Role of the linked server.
`linkedRedisCacheLocation`	string	Location of the linked redis cache.
`linkedRedisCacheId`	string	Fully qualified resourceId of the linked redis cache.

RedisLinkedServerWithProperties

Response to put/get linked server (with properties) for Redis cache.

Properties

Name Data Type Description


                        properties

RedisLinkedServerProperties

Properties of the linked server.


                        RedisLinkedServerProperties

Properties of a linked server to be returned in get/put response

Properties

`serverRole`	string Allowed values: - `Primary` - `Secondary`	Role of the linked server.
`linkedRedisCacheLocation`	string	Location of the linked redis cache.
`linkedRedisCacheId`	string	Fully qualified resourceId of the linked redis cache.
`provisioningState`	string Read-only	Terminal state of the link between primary and secondary redis cache.

Extends

RedisLinkedServerCreateProperties

Create properties for a linked server

Properties

Name	Data Type	Description
`serverRole`	string Allowed values: - `Primary` - `Secondary`	Role of the linked server.
`linkedRedisCacheLocation`	string	Location of the linked redis cache.
`linkedRedisCacheId`	string	Fully qualified resourceId of the linked redis cache.

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends

RedisLinkedServerWithPropertiesList

List of linked servers (with properties) of a Redis cache.

Properties

Name Data Type Description


                        value

array [RedisLinkedServerWithProperties]

List of linked servers (with properties) of a Redis cache.


                        RedisLinkedServerWithProperties

Response to put/get linked server (with properties) for Redis cache.

Properties


                        properties

RedisLinkedServerProperties

Properties of the linked server.


                        RedisLinkedServerProperties

Properties of a linked server to be returned in get/put response

Properties

`serverRole`	string Allowed values: - `Primary` - `Secondary`	Role of the linked server.
`linkedRedisCacheLocation`	string	Location of the linked redis cache.
`linkedRedisCacheId`	string	Fully qualified resourceId of the linked redis cache.
`provisioningState`	string Read-only	Terminal state of the link between primary and secondary redis cache.

Extends

RedisLinkedServerCreateProperties

Create properties for a linked server

Properties

Name	Data Type	Description
`serverRole`	string Allowed values: - `Primary` - `Secondary`	Role of the linked server.
`linkedRedisCacheLocation`	string	Location of the linked redis cache.
`linkedRedisCacheId`	string	Fully qualified resourceId of the linked redis cache.

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends


                        nextLink

string
Read-only

Link for next set.

RedisListResult

The response of list Redis operation.

Properties

Name Data Type Description


                        value

array [RedisResource]

List of Redis cache instances.


                        RedisResource

A single Redis item in List or Get Operation.

Properties


                        tags

object

Resource tags.


                        location

string

The geo-location where the resource lives


                        zones

array [string]

A list of availability zones denoting where the resource needs to come from.


                        properties

RedisProperties

Redis cache properties.


                        RedisProperties

Properties of the redis cache.

Properties


                        subnetId

string
Pattern:

^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$


                        staticIP

string
Pattern: ^\d+\.\d+\.\d+\.\d+$

Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.

sku

Sku

The SKU of the Redis cache to deploy.

Sku

SKU parameters supplied to the create Redis operation.

Properties

`name`	string Allowed values: - `Basic` - `Standard` - `Premium`	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
`family`	string Allowed values: - `C` - `P`	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
`capacity`	integer	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).


                        sslPort

integer
Read-only

Redis SSL port.


                        redisVersion

string
Read-only

Redis version.


                        provisioningState

Redis instance provisioning status.


                        port

integer
Read-only

Redis non-SSL port.


                        linkedServers

array [RedisLinkedServer]

List of the linked servers associated with the cache


                        RedisLinkedServer

Linked server Id

Properties

id

string
Read-only

Linked server Id.


                        hostName

string
Read-only

Redis host name.


                        accessKeys

RedisAccessKeys
Read-only

The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache


                        RedisAccessKeys

Redis cache access keys.

Properties

`secondaryKey`	string Read-only	The current secondary key that clients can use to authenticate with Redis cache.
`primaryKey`	string Read-only	The current primary key that clients can use to authenticate with Redis cache.

Extends

RedisCreateProperties

Properties supplied to Create Redis operation.

Properties

Name Data Type Description


                        tenantSettings

object

A dictionary of tenant settings


                        shardCount

integer

The number of shards to be created on a Premium Cluster Cache.


                        redisConfiguration

object


                        minimumTlsVersion

string
Allowed values:
- 1.0
- 1.1
- 1.2

Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')


                        enableNonSslPort

boolean

Specifies whether the non-ssl Redis server port (6379) is enabled.


                        subnetId

string
Pattern:

^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$


                        staticIP

string
Pattern: ^\d+\.\d+\.\d+\.\d+$

Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.

sku

Sku

The SKU of the Redis cache to deploy.

Sku

SKU parameters supplied to the create Redis operation.

Properties

`name`	string Allowed values: - `Basic` - `Standard` - `Premium`	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
`family`	string Allowed values: - `C` - `P`	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
`capacity`	integer	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).

Extends

TrackedResource

The resource model definition for a ARM tracked top level resource

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`tags`	object	Resource tags.
`location`	string	The geo-location where the resource lives

Extends


                        nextLink

string
Read-only

Link for next page of results.

RedisPatchSchedule

Response to put/get patch schedules for Redis cache.

Properties

Name Data Type Description


                        properties

ScheduleEntries

List of patch schedules for a Redis cache.


                        ScheduleEntries

List of patch schedules for a Redis cache.

Properties


                        scheduleEntries

array [ScheduleEntry]

List of patch schedules for a Redis cache.


                        ScheduleEntry

Patch schedule entry for a Premium Redis Cache.

Properties

`startHourUtc`	integer	Start hour after which cache patching can start.
`maintenanceWindow`	string	ISO8601 timespan specifying how much time cache patching can take.
`dayOfWeek`	string Allowed values: - `Monday` - `Tuesday` - `Wednesday` - `Thursday` - `Friday` - `Saturday` - `Sunday` - `Everyday` - `Weekend`	Day of the week when a cache can be patched.

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends

RedisPatchScheduleListResult

The response of list patch schedules Redis operation.

Properties

Name Data Type Description


                        value

array [RedisPatchSchedule]

Results of the list patch schedules operation.


                        RedisPatchSchedule

Response to put/get patch schedules for Redis cache.

Properties


                        properties

ScheduleEntries

List of patch schedules for a Redis cache.


                        ScheduleEntries

List of patch schedules for a Redis cache.

Properties


                        scheduleEntries

array [ScheduleEntry]

List of patch schedules for a Redis cache.


                        ScheduleEntry

Patch schedule entry for a Premium Redis Cache.

Properties

`startHourUtc`	integer	Start hour after which cache patching can start.
`maintenanceWindow`	string	ISO8601 timespan specifying how much time cache patching can take.
`dayOfWeek`	string Allowed values: - `Monday` - `Tuesday` - `Wednesday` - `Thursday` - `Friday` - `Saturday` - `Sunday` - `Everyday` - `Weekend`	Day of the week when a cache can be patched.

Extends

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

Extends


                        nextLink

string
Read-only

Link for next page of results.

RedisProperties

Properties of the redis cache.

Properties

Name Data Type Description


                        subnetId

string
Pattern:

^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$


                        staticIP

string
Pattern: ^\d+\.\d+\.\d+\.\d+$

Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.

sku

Sku

The SKU of the Redis cache to deploy.

Sku

SKU parameters supplied to the create Redis operation.

Properties

`name`	string Allowed values: - `Basic` - `Standard` - `Premium`	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
`family`	string Allowed values: - `C` - `P`	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
`capacity`	integer	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).


                        sslPort

integer
Read-only

Redis SSL port.


                        redisVersion

string
Read-only

Redis version.


                        provisioningState

Redis instance provisioning status.


                        port

integer
Read-only

Redis non-SSL port.


                        linkedServers

array [RedisLinkedServer]

List of the linked servers associated with the cache


                        RedisLinkedServer

Linked server Id

Properties

id

string
Read-only

Linked server Id.


                        hostName

string
Read-only

Redis host name.


                        accessKeys

RedisAccessKeys
Read-only

The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache


                        RedisAccessKeys

Redis cache access keys.

Properties

`secondaryKey`	string Read-only	The current secondary key that clients can use to authenticate with Redis cache.
`primaryKey`	string Read-only	The current primary key that clients can use to authenticate with Redis cache.

Extends

RedisCreateProperties

Properties supplied to Create Redis operation.

Properties

Name Data Type Description


                        tenantSettings

object

A dictionary of tenant settings


                        shardCount

integer

The number of shards to be created on a Premium Cluster Cache.


                        redisConfiguration

object


                        minimumTlsVersion

string
Allowed values:
- 1.0
- 1.1
- 1.2

Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')


                        enableNonSslPort

boolean

Specifies whether the non-ssl Redis server port (6379) is enabled.


                        subnetId

string
Pattern:

^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$


                        staticIP

string
Pattern: ^\d+\.\d+\.\d+\.\d+$

Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.

sku

Sku

The SKU of the Redis cache to deploy.

Sku

SKU parameters supplied to the create Redis operation.

Properties

`name`	string Allowed values: - `Basic` - `Standard` - `Premium`	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
`family`	string Allowed values: - `C` - `P`	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
`capacity`	integer	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).

Extends

RedisRebootParameters

RedisRegenerateKeyParameters

RedisResource

A single Redis item in List or Get Operation.

Properties

Name Data Type Description


                        tags

object

Resource tags.


                        location

string

The geo-location where the resource lives


                        zones

array [string]

A list of availability zones denoting where the resource needs to come from.


                        properties

RedisProperties

Redis cache properties.


                        RedisProperties

Properties of the redis cache.

Properties


                        subnetId

string
Pattern:

^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$


                        staticIP

string
Pattern: ^\d+\.\d+\.\d+\.\d+$

Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.

sku

Sku

The SKU of the Redis cache to deploy.

Sku

SKU parameters supplied to the create Redis operation.

Properties

`name`	string Allowed values: - `Basic` - `Standard` - `Premium`	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
`family`	string Allowed values: - `C` - `P`	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
`capacity`	integer	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).


                        sslPort

integer
Read-only

Redis SSL port.


                        redisVersion

string
Read-only

Redis version.


                        provisioningState

Redis instance provisioning status.


                        port

integer
Read-only

Redis non-SSL port.


                        linkedServers

array [RedisLinkedServer]

List of the linked servers associated with the cache


                        RedisLinkedServer

Linked server Id

Properties

id

string
Read-only

Linked server Id.


                        hostName

string
Read-only

Redis host name.


                        accessKeys

RedisAccessKeys
Read-only

The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache


                        RedisAccessKeys

Redis cache access keys.

Properties

`secondaryKey`	string Read-only	The current secondary key that clients can use to authenticate with Redis cache.
`primaryKey`	string Read-only	The current primary key that clients can use to authenticate with Redis cache.

Extends

RedisCreateProperties

Properties supplied to Create Redis operation.

Properties

Name Data Type Description


                        tenantSettings

object

A dictionary of tenant settings


                        shardCount

integer

The number of shards to be created on a Premium Cluster Cache.


                        redisConfiguration

object


                        minimumTlsVersion

string
Allowed values:
- 1.0
- 1.1
- 1.2

Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')


                        enableNonSslPort

boolean

Specifies whether the non-ssl Redis server port (6379) is enabled.


                        subnetId

string
Pattern:

^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$


                        staticIP

string
Pattern: ^\d+\.\d+\.\d+\.\d+$

Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.

sku

Sku

The SKU of the Redis cache to deploy.

Sku

SKU parameters supplied to the create Redis operation.

Properties

`name`	string Allowed values: - `Basic` - `Standard` - `Premium`	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
`family`	string Allowed values: - `C` - `P`	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
`capacity`	integer	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).

Extends

TrackedResource

The resource model definition for a ARM tracked top level resource

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`tags`	object	Resource tags.
`location`	string	The geo-location where the resource lives

Extends

RedisUpdateParameters

Parameters supplied to the Update Redis operation.

Properties

Name Data Type Description


                        tags

object

Resource tags.


                        properties

RedisUpdateProperties

Redis cache properties.


                        RedisUpdateProperties

Patchable properties of the redis cache.

Properties


                        tenantSettings

object

A dictionary of tenant settings


                        shardCount

integer

The number of shards to be created on a Premium Cluster Cache.


                        redisConfiguration

object


                        minimumTlsVersion

string
Allowed values:
- 1.0
- 1.1
- 1.2

Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')


                        enableNonSslPort

boolean

Specifies whether the non-ssl Redis server port (6379) is enabled.

sku

Sku

The SKU of the Redis cache to deploy.

Sku

SKU parameters supplied to the create Redis operation.

Properties

`name`	string Allowed values: - `Basic` - `Standard` - `Premium`	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
`family`	string Allowed values: - `C` - `P`	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
`capacity`	integer	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).

Extends

RedisCommonProperties

Create/Update/Get common properties of the redis cache.

Properties

Name	Data Type	Description
`tenantSettings`	object	A dictionary of tenant settings
`shardCount`	integer	The number of shards to be created on a Premium Cluster Cache.
`redisConfiguration`	object	All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc.
`minimumTlsVersion`	string Allowed values: - `1.0` - `1.1` - `1.2`	Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')
`enableNonSslPort`	boolean	Specifies whether the non-ssl Redis server port (6379) is enabled.

RedisUpdateProperties

Patchable properties of the redis cache.

Properties

Name Data Type Description


                        tenantSettings

object

A dictionary of tenant settings


                        shardCount

integer

The number of shards to be created on a Premium Cluster Cache.


                        redisConfiguration

object


                        minimumTlsVersion

string
Allowed values:
- 1.0
- 1.1
- 1.2

Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')


                        enableNonSslPort

boolean

Specifies whether the non-ssl Redis server port (6379) is enabled.

sku

Sku

The SKU of the Redis cache to deploy.

Sku

SKU parameters supplied to the create Redis operation.

Properties

`name`	string Allowed values: - `Basic` - `Standard` - `Premium`	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
`family`	string Allowed values: - `C` - `P`	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
`capacity`	integer	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).

Extends

RedisCommonProperties

Create/Update/Get common properties of the redis cache.

Properties

Name	Data Type	Description
`tenantSettings`	object	A dictionary of tenant settings
`shardCount`	integer	The number of shards to be created on a Premium Cluster Cache.
`redisConfiguration`	object	All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc.
`minimumTlsVersion`	string Allowed values: - `1.0` - `1.1` - `1.2`	Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')
`enableNonSslPort`	boolean	Specifies whether the non-ssl Redis server port (6379) is enabled.

Resource

ScheduleEntries

List of patch schedules for a Redis cache.

Properties

Name Data Type Description


                        scheduleEntries

array [ScheduleEntry]

List of patch schedules for a Redis cache.


                        ScheduleEntry

Patch schedule entry for a Premium Redis Cache.

Properties

`startHourUtc`	integer	Start hour after which cache patching can start.
`maintenanceWindow`	string	ISO8601 timespan specifying how much time cache patching can take.
`dayOfWeek`	string Allowed values: - `Monday` - `Tuesday` - `Wednesday` - `Thursday` - `Friday` - `Saturday` - `Sunday` - `Everyday` - `Weekend`	Day of the week when a cache can be patched.

ScheduleEntry

Sku

TrackedResource

The resource model definition for a ARM tracked top level resource

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`tags`	object	Resource tags.
`location`	string	The geo-location where the resource lives

Extends

Resource

The Resource definition.

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.

UpgradeNotification

Authentication

Oauth2

'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1

Azure Active Directory OAuth2 Flow.

Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Scopes:

user_impersonation: impersonate your user account

Metadata (Technical Details)

Origin - Format	`swagger`
Origin - Url	`https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/redis/resource-manager/Microsoft.Cache/stable/2018-03-01/redis.json`
Origin - Version	`2.0`
Preferred	`Yes`
Provider Name	`azure.com`
Service Name	`redis`
API Version	`2018-03-01`

Comments

Loading comments ...