REST API for Azure Redis Cache Service.
Deletes a single firewall rule in a specified redis cache.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Gets a single firewall rule in a specified redis cache.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
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
|
RedisFirewallRuleProperties |
redis cache firewall rule properties |
||||||||||
Properties
|
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
Create or update a redis cache firewall rule
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
RedisFirewallRuleCreateParameters
|
Parameters required for creating a firewall rule on redis cache. |
properties
|
RedisFirewallRuleProperties |
Properties required to create a firewall rule . |
||||||||||
Properties
|
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
|
RedisFirewallRuleProperties |
redis cache firewall rule properties |
||||||||||
Properties
|
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
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
|
RedisFirewallRuleProperties |
redis cache firewall rule properties |
||||||||||
Properties
|
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
Gets all firewall rules in the specified redis cache.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
RedisFirewallRuleListResult
|
The response of list firewall rules Redis operation. |
value
|
array [RedisFirewallRule] |
Results of the list firewall rules operation. |
||||||||||||||||||||||||||||||||
Properties
Extends
ProxyResource
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags Properties
Extends |
||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
Link for next page of results. |
Lists all of the available REST API operations of the Microsoft.Cache provider.
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
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. |
value
|
array [Operation] |
List of operations supported by the resource provider. |
||||||||||
Properties
|
||||||||||||
nextLink
|
string Read-only |
URL to get the next set of operation list results if there are any. |
Gets all patch schedules in the specified redis cache (there is only one).
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
RedisPatchScheduleListResult
|
The response of list patch schedules Redis operation. |
value
|
array [RedisPatchSchedule] |
Results of the list patch schedules operation. |
|||||||||||||||||||||||||||||
Properties
Extends
ProxyResource
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags Properties
Extends |
|||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
Link for next page of results. |
Deletes the patching schedule of a redis cache (requires Premium SKU).
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Gets the patching schedule of a redis cache (requires Premium SKU).
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
RedisPatchSchedule
|
Response to put/get patch schedules for Redis cache. |
properties
|
ScheduleEntries |
List of patch schedules for a Redis cache. |
|||||||||||||||||||||||
Properties
|
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
Create or replace the patching schedule for Redis cache (requires Premium SKU).
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
RedisPatchSchedule
|
Response to put/get patch schedules for Redis cache. |
properties
|
ScheduleEntries |
List of patch schedules for a Redis cache. |
|||||||||||||||||||||||
Properties
|
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
Name | Data Type | Description |
---|---|---|
RedisPatchSchedule
|
Response to put/get patch schedules for Redis cache. |
properties
|
ScheduleEntries |
List of patch schedules for a Redis cache. |
|||||||||||||||||||||||
Properties
|
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
Name | Data Type | Description |
---|---|---|
RedisPatchSchedule
|
Response to put/get patch schedules for Redis cache. |
properties
|
ScheduleEntries |
List of patch schedules for a Redis cache. |
|||||||||||||||||||||||
Properties
|
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
Checks that the redis cache name is valid and is not already in use.
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 | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
CheckNameAvailabilityParameters
|
Parameters body to pass for resource name availability check. |
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. |
Gets all Redis caches in the specified subscription.
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 | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
RedisListResult
|
The response of list Redis operation. |
value
|
array [RedisResource] |
List of Redis cache instances. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
TrackedResource
The resource model definition for a ARM tracked top level resource Properties
Extends |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
Link for next page of results. |
Deletes a single firewall rule in a specified redis cache.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Gets a single firewall rule in a specified redis cache.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
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
|
RedisFirewallRuleProperties |
redis cache firewall rule properties |
||||||||||
Properties
|
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
Create or update a redis cache firewall rule
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
RedisFirewallRuleCreateParameters
|
Parameters required for creating a firewall rule on redis cache. |
properties
|
RedisFirewallRuleProperties |
Properties required to create a firewall rule . |
||||||||||
Properties
|
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
|
RedisFirewallRuleProperties |
redis cache firewall rule properties |
||||||||||
Properties
|
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
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
|
RedisFirewallRuleProperties |
redis cache firewall rule properties |
||||||||||
Properties
|
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
Gets all firewall rules in the specified redis cache.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
RedisFirewallRuleListResult
|
The response of list firewall rules Redis operation. |
value
|
array [RedisFirewallRule] |
Results of the list firewall rules operation. |
||||||||||||||||||||||||||||||||
Properties
Extends
ProxyResource
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags Properties
Extends |
||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
Link for next page of results. |
Gets all patch schedules in the specified redis cache (there is only one).
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
RedisPatchScheduleListResult
|
The response of list patch schedules Redis operation. |
value
|
array [RedisPatchSchedule] |
Results of the list patch schedules operation. |
|||||||||||||||||||||||||||||
Properties
Extends
ProxyResource
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags Properties
Extends |
|||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
Link for next page of results. |
Export data from the redis cache to blobs in a container.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
ExportRDBParameters
|
Parameters for Redis export operation. |
prefix
|
string |
Prefix to use for exported files. |
format
|
string |
File format. |
container
|
string |
Container name to export to. |
Reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
RedisRebootParameters
|
Specifies which Redis node(s) to reboot. |
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. |
Name | Data Type | Description |
---|---|---|
RedisForceRebootResponse
|
Response to force reboot for Redis cache. |
message
|
string Read-only |
Status message |
Import data into Redis cache.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
ImportRDBParameters
|
Parameters for Redis import operation. |
format
|
string |
File format. |
files
|
array [string] |
files to import. |
Deletes the linked server from a redis cache (requires Premium SKU).
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Gets the detailed information about a linked server of a redis cache (requires Premium SKU).
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
RedisLinkedServerWithProperties
|
Response to put/get linked server (with properties) for Redis cache. |
properties
|
RedisLinkedServerProperties |
Properties of the linked server. |
||||||||||||||||||||||||||||
Properties
Extends
RedisLinkedServerCreateProperties
Create properties for a linked server Properties
|
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
Adds a linked server to the Redis cache (requires Premium SKU).
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
RedisLinkedServerCreateParameters
|
Parameter required for creating a linked server to redis cache. |
properties
|
RedisLinkedServerCreateProperties |
Properties required to create a linked server. |
|||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
RedisLinkedServerWithProperties
|
Response to put/get linked server (with properties) for Redis cache. |
properties
|
RedisLinkedServerProperties |
Properties of the linked server. |
||||||||||||||||||||||||||||
Properties
Extends
RedisLinkedServerCreateProperties
Create properties for a linked server Properties
|
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
Name | Data Type | Description |
---|---|---|
RedisLinkedServerWithProperties
|
Response to put/get linked server (with properties) for Redis cache. |
properties
|
RedisLinkedServerProperties |
Properties of the linked server. |
||||||||||||||||||||||||||||
Properties
Extends
RedisLinkedServerCreateProperties
Create properties for a linked server Properties
|
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
Gets the list of linked servers associated with this redis cache (requires Premium SKU).
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
RedisLinkedServerWithPropertiesList
|
List of linked servers (with properties) of a Redis cache. |
value
|
array [RedisLinkedServerWithProperties] |
List of linked servers (with properties) of a Redis cache. |
||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
ProxyResource
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags Properties
Extends |
||||||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
Link for next set. |
Retrieve a Redis cache's access keys. This operation requires write permission to the cache resource.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
RedisAccessKeys
|
Redis cache access keys. |
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. |
Gets any upgrade notifications for a Redis cache.
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. |
Name | Data Type | Description |
---|---|---|
history
|
double |
how many minutes in past to look for upgrade notifications |
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
NotificationListResponse
|
The response of listUpgradeNotifications. |
value
|
array [UpgradeNotification] |
List of all notifications. |
|||||||||||||
Properties
|
|||||||||||||||
nextLink
|
string Read-only |
Link for next set of notifications. |
Deletes the patching schedule of a redis cache (requires Premium SKU).
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Gets the patching schedule of a redis cache (requires Premium SKU).
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
RedisPatchSchedule
|
Response to put/get patch schedules for Redis cache. |
properties
|
ScheduleEntries |
List of patch schedules for a Redis cache. |
|||||||||||||||||||||||
Properties
|
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
Create or replace the patching schedule for Redis cache (requires Premium SKU).
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
RedisPatchSchedule
|
Response to put/get patch schedules for Redis cache. |
properties
|
ScheduleEntries |
List of patch schedules for a Redis cache. |
|||||||||||||||||||||||
Properties
|
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
Name | Data Type | Description |
---|---|---|
RedisPatchSchedule
|
Response to put/get patch schedules for Redis cache. |
properties
|
ScheduleEntries |
List of patch schedules for a Redis cache. |
|||||||||||||||||||||||
Properties
|
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
Name | Data Type | Description |
---|---|---|
RedisPatchSchedule
|
Response to put/get patch schedules for Redis cache. |
properties
|
ScheduleEntries |
List of patch schedules for a Redis cache. |
|||||||||||||||||||||||
Properties
|
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
Regenerate Redis cache's access keys. This operation requires write permission to the cache resource.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
RedisRegenerateKeyParameters
|
Specifies which Redis access keys to reset. |
keyType
|
string Allowed values: - Primary - Secondary |
The Redis access key to regenerate. |
Name | Data Type | Description |
---|---|---|
RedisAccessKeys
|
Redis cache access keys. |
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. |
Deletes a Redis cache.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Gets a Redis cache (resource description).
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
RedisResource
|
A single Redis item in List or Get Operation. |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
RedisCreateProperties
Properties supplied to Create Redis operation. Properties
Extends |
The resource model definition for a ARM tracked top level resource
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 |
Update an existing Redis cache.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
RedisUpdateParameters
|
Parameters supplied to the Update Redis operation. |
tags
|
object |
Resource tags. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
properties
|
RedisUpdateProperties |
Redis cache properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
RedisCommonProperties
Create/Update/Get common properties of the redis cache. Properties
|
Name | Data Type | Description |
---|---|---|
RedisResource
|
A single Redis item in List or Get Operation. |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
RedisCreateProperties
Properties supplied to Create Redis operation. Properties
Extends |
The resource model definition for a ARM tracked top level resource
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 |
Create or replace (overwrite/recreate, with potential downtime) an existing Redis cache.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
RedisCreateParameters
|
Parameters supplied to the Create Redis operation. |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
RedisCommonProperties
Create/Update/Get common properties of the redis cache. Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
location
|
string |
The geo-location where the resource lives |
Name | Data Type | Description |
---|---|---|
RedisResource
|
A single Redis item in List or Get Operation. |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
RedisCreateProperties
Properties supplied to Create Redis operation. Properties
Extends |
The resource model definition for a ARM tracked top level resource
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 |
Name | Data Type | Description |
---|---|---|
RedisResource
|
A single Redis item in List or Get Operation. |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
RedisCreateProperties
Properties supplied to Create Redis operation. Properties
Extends |
The resource model definition for a ARM tracked top level resource
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 |
Lists all Redis caches in a resource group.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
RedisListResult
|
The response of list Redis operation. |
value
|
array [RedisResource] |
List of Redis cache instances. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
TrackedResource
The resource model definition for a ARM tracked top level resource Properties
Extends |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
Link for next page of results. |
Parameters body to pass for resource name availability check.
Name | Data Type | Description |
---|---|---|
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. |
Parameters for Redis export operation.
Name | Data Type | Description |
---|---|---|
prefix
|
string |
Prefix to use for exported files. |
format
|
string |
File format. |
container
|
string |
Container name to export to. |
Parameters for Redis import operation.
Name | Data Type | Description |
---|---|---|
format
|
string |
File format. |
files
|
array [string] |
files to import. |
The response of listUpgradeNotifications.
Name | Data Type | Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
value
|
array [UpgradeNotification] |
List of all notifications. |
|||||||||||||
Properties
|
|||||||||||||||
nextLink
|
string Read-only |
Link for next set of notifications. |
REST API operation
Name | Data Type | Description |
---|---|---|
name
|
string |
Operation name: {provider}/{resource}/{operation} |
display
|
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.
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
value
|
array [Operation] |
List of operations supported by the resource provider. |
||||||||||
Properties
|
||||||||||||
nextLink
|
string Read-only |
URL to get the next set of operation list results if there are any. |
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
The Resource definition.
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
Redis cache access keys.
Name | Data Type | Description |
---|---|---|
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. |
Create/Update/Get common properties of the redis cache.
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. |
Parameters supplied to the Create Redis operation.
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
RedisCommonProperties
Create/Update/Get common properties of the redis cache. Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
location
|
string |
The geo-location where the resource lives |
Properties supplied to Create Redis operation.
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. |
|||||||||||||
Properties
|
Create/Update/Get common properties of the redis cache.
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. |
A firewall rule on a redis cache has a name, and describes a contiguous range of IP addresses permitted to connect
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
properties
|
RedisFirewallRuleProperties |
redis cache firewall rule properties |
||||||||||
Properties
|
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
Parameters required for creating a firewall rule on redis cache.
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
properties
|
RedisFirewallRuleProperties |
Properties required to create a firewall rule . |
||||||||||
Properties
|
The response of list firewall rules Redis operation.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
value
|
array [RedisFirewallRule] |
Results of the list firewall rules operation. |
||||||||||||||||||||||||||||||||
Properties
Extends
ProxyResource
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags Properties
Extends |
||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
Link for next page of results. |
Specifies a range of IP addresses permitted to connect to the cache
Name | Data Type | Description |
---|---|---|
startIP
|
string |
lowest IP address included in the range |
endIP
|
string |
highest IP address included in the range |
Response to force reboot for Redis cache.
Name | Data Type | Description |
---|---|---|
message
|
string Read-only |
Status message |
Linked server Id
Name | Data Type | Description |
---|---|---|
id
|
string Read-only |
Linked server Id. |
Parameter required for creating a linked server to redis cache.
Name | Data Type | Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
properties
|
RedisLinkedServerCreateProperties |
Properties required to create a linked server. |
|||||||||||||
Properties
|
Create properties for a linked server
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. |
Properties of a linked server to be returned in get/put response
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. |
Create properties for a linked server
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. |
Response to put/get linked server (with properties) for Redis cache.
Name | Data Type | Description | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
properties
|
RedisLinkedServerProperties |
Properties of the linked server. |
||||||||||||||||||||||||||||
Properties
Extends
RedisLinkedServerCreateProperties
Create properties for a linked server Properties
|
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
List of linked servers (with properties) of a Redis cache.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
value
|
array [RedisLinkedServerWithProperties] |
List of linked servers (with properties) of a Redis cache. |
||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
ProxyResource
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags Properties
Extends |
||||||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
Link for next set. |
The response of list Redis operation.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
value
|
array [RedisResource] |
List of Redis cache instances. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
TrackedResource
The resource model definition for a ARM tracked top level resource Properties
Extends |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
Link for next page of results. |
Response to put/get patch schedules for Redis cache.
Name | Data Type | Description | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
properties
|
ScheduleEntries |
List of patch schedules for a Redis cache. |
|||||||||||||||||||||||
Properties
|
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
The response of list patch schedules Redis operation.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
value
|
array [RedisPatchSchedule] |
Results of the list patch schedules operation. |
|||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
ProxyResource
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags Properties
Extends |
|||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
Link for next page of results. |
Properties of the redis cache.
Name | Data Type | Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. |
|||||||||||||
Properties
|
|||||||||||||||
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 |
|||||||||||||
Properties
|
|||||||||||||||
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 |
|||||||||||||
Properties
|
Properties supplied to Create Redis operation.
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. |
|||||||||||||
Properties
|
Specifies which Redis node(s) to reboot.
Name | Data Type | Description |
---|---|---|
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. |
Specifies which Redis access keys to reset.
Name | Data Type | Description |
---|---|---|
keyType
|
string Allowed values: - Primary - Secondary |
The Redis access key to regenerate. |
A single Redis item in List or Get Operation.
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
RedisCreateProperties
Properties supplied to Create Redis operation. Properties
Extends |
The resource model definition for a ARM tracked top level resource
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 |
Parameters supplied to the Update Redis operation.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
tags
|
object |
Resource tags. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
properties
|
RedisUpdateProperties |
Redis cache properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
RedisCommonProperties
Create/Update/Get common properties of the redis cache. Properties
|
Patchable properties of the redis cache.
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. |
|||||||||||||
sku
|
Sku |
The SKU of the Redis cache to deploy. |
|||||||||||||
Properties
|
Create/Update/Get common properties of the redis cache.
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. |
The Resource definition.
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
List of patch schedules for a Redis cache.
Name | Data Type | Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
scheduleEntries
|
array [ScheduleEntry] |
List of patch schedules for a Redis cache. |
|||||||||||||
Properties
|
Patch schedule entry for a Premium Redis Cache.
Name | Data Type | Description |
---|---|---|
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. |
SKU parameters supplied to the create Redis operation.
Name | Data Type | Description |
---|---|---|
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). |
The resource model definition for a ARM tracked top level resource
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 |
The Resource definition.
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Resource type. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
Properties of upgrade notification.
Name | Data Type | Description |
---|---|---|
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. |
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Azure Active Directory OAuth2 Flow.
Flow:implicit
https://login.microsoftonline.com/common/oauth2/authorize
user_impersonation
: impersonate your user accountOrigin - 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 |