Microsoft.Cache (stable:2018-03-01)

2025/09/26 • 26 new, 26 deleted methods

Operations_List (new)
Description :  Lists all of the available REST API operations of the Microsoft.Cache provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Cache/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that describes the operation. ,
Required: False ,
}
{
provider:
{
Description: Friendly name of the resource provider ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: read, write, delete, listKeys/action, etc. ,
Required: False ,
}
string ,
resource:
{
Description: Resource type on which the operation is performed. ,
Required: False ,
}
string ,
description:
{
Description: Friendly name of the operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}
Redis_CheckNameAvailability (new)
Description :  Checks that the redis cache name is valid and is not already in use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Cache/CheckNameAvailability
{
parameters:
{
Description: Parameters supplied to the CheckNameAvailability Redis operation. The only supported resource type is 'Microsoft.Cache/redis' ,
Required: True ,
}
{
name:
{
Description: Resource name. ,
Required: True ,
}
string ,
type:
{
Description: Resource type. The only legal value of this property for checking redis cache name availability is 'Microsoft.Cache/redis'. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
Redis_ListUpgradeNotifications (new)
Description :  Gets any upgrade notifications for a Redis cache.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/listUpgradeNotifications
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
history:
{
Description: how many minutes in past to look for upgrade notifications ,
Format: double ,
Required: True ,
}
number ,
}

⚐ Response (200)

{
value:
{
Description: List of all notifications. ,
Required: False ,
}
[
{
name:
{
Description: Name of upgrade notification. ,
Required: False ,
}
string ,
timestamp:
{
Description: Timestamp when upgrade notification occurred. ,
Format: date-time ,
Required: False ,
}
string ,
upsellNotification:
{
Description: Details about this upgrade notification ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of notifications. ,
Required: False ,
}
string ,
}
Redis_Create (new)
Description :  Create or replace (overwrite/recreate, with potential downtime) an existing Redis cache.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create Redis operation. ,
Required: True ,
}
{
properties:
{
Description: Redis cache properties. ,
Required: True ,
}
{
sku:
{
Description: The SKU of the Redis cache to deploy. ,
Required: True ,
}
{
name:
{
Description: The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
family:
{
Description: The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). ,
Enum:
{
C: No description available. ,
P: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: 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, 5). ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
subnetId:
{
Description: 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 ,
Required: False ,
}
string ,
staticIP:
{
Description: Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
location:
{
Description: The geo-location where the resource lives ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Redis cache properties. ,
Required: True ,
}
{
redisVersion:
{
Description: Redis version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Redis instance provisioning status. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
Linking: No description available. ,
Provisioning: No description available. ,
RecoveringScaleFailure: No description available. ,
Scaling: No description available. ,
Succeeded: No description available. ,
Unlinking: No description available. ,
Unprovisioning: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Redis host name. ,
Required: False ,
}
string ,
port:
{
Description: Redis non-SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
sslPort:
{
Description: Redis SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
accessKeys:
{
Description: The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache ,
Required: False ,
}
{
primaryKey:
{
Description: The current primary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The current secondary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
}
,
linkedServers:
{
Description: List of the linked servers associated with the cache ,
Required: False ,
}
[
{
id:
{
Description: Linked server Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (200)

{
properties:
{
Description: Redis cache properties. ,
Required: True ,
}
{
redisVersion:
{
Description: Redis version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Redis instance provisioning status. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
Linking: No description available. ,
Provisioning: No description available. ,
RecoveringScaleFailure: No description available. ,
Scaling: No description available. ,
Succeeded: No description available. ,
Unlinking: No description available. ,
Unprovisioning: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Redis host name. ,
Required: False ,
}
string ,
port:
{
Description: Redis non-SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
sslPort:
{
Description: Redis SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
accessKeys:
{
Description: The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache ,
Required: False ,
}
{
primaryKey:
{
Description: The current primary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The current secondary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
}
,
linkedServers:
{
Description: List of the linked servers associated with the cache ,
Required: False ,
}
[
{
id:
{
Description: Linked server Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
Redis_Update (new)
Description :  Update an existing Redis cache.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update Redis operation. ,
Required: True ,
}
{
properties:
{
Description: Redis cache properties. ,
Required: False ,
}
{
sku:
{
Description: The SKU of the Redis cache to deploy. ,
Required: False ,
}
{
name:
{
Description: The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
family:
{
Description: The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). ,
Enum:
{
C: No description available. ,
P: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: 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, 5). ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Redis cache properties. ,
Required: True ,
}
{
redisVersion:
{
Description: Redis version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Redis instance provisioning status. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
Linking: No description available. ,
Provisioning: No description available. ,
RecoveringScaleFailure: No description available. ,
Scaling: No description available. ,
Succeeded: No description available. ,
Unlinking: No description available. ,
Unprovisioning: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Redis host name. ,
Required: False ,
}
string ,
port:
{
Description: Redis non-SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
sslPort:
{
Description: Redis SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
accessKeys:
{
Description: The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache ,
Required: False ,
}
{
primaryKey:
{
Description: The current primary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The current secondary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
}
,
linkedServers:
{
Description: List of the linked servers associated with the cache ,
Required: False ,
}
[
{
id:
{
Description: Linked server Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
Redis_Delete (new)
Description :  Deletes a Redis cache.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Redis_Get (new)
Description :  Gets a Redis cache (resource description).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Redis cache properties. ,
Required: True ,
}
{
redisVersion:
{
Description: Redis version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Redis instance provisioning status. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
Linking: No description available. ,
Provisioning: No description available. ,
RecoveringScaleFailure: No description available. ,
Scaling: No description available. ,
Succeeded: No description available. ,
Unlinking: No description available. ,
Unprovisioning: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Redis host name. ,
Required: False ,
}
string ,
port:
{
Description: Redis non-SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
sslPort:
{
Description: Redis SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
accessKeys:
{
Description: The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache ,
Required: False ,
}
{
primaryKey:
{
Description: The current primary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The current secondary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
}
,
linkedServers:
{
Description: List of the linked servers associated with the cache ,
Required: False ,
}
[
{
id:
{
Description: Linked server Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
Redis_ListByResourceGroup (new)
Description :  Lists all Redis caches in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Redis cache instances. ,
Required: False ,
}
[
{
properties:
{
Description: Redis cache properties. ,
Required: True ,
}
{
redisVersion:
{
Description: Redis version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Redis instance provisioning status. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
Linking: No description available. ,
Provisioning: No description available. ,
RecoveringScaleFailure: No description available. ,
Scaling: No description available. ,
Succeeded: No description available. ,
Unlinking: No description available. ,
Unprovisioning: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Redis host name. ,
Required: False ,
}
string ,
port:
{
Description: Redis non-SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
sslPort:
{
Description: Redis SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
accessKeys:
{
Description: The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache ,
Required: False ,
}
{
primaryKey:
{
Description: The current primary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The current secondary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
}
,
linkedServers:
{
Description: List of the linked servers associated with the cache ,
Required: False ,
}
[
{
id:
{
Description: Linked server Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: Link for next page of results. ,
Required: False ,
}
string ,
}
Redis_List (new)
Description :  Gets all Redis caches in the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Cache/Redis
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Redis cache instances. ,
Required: False ,
}
[
{
properties:
{
Description: Redis cache properties. ,
Required: True ,
}
{
redisVersion:
{
Description: Redis version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Redis instance provisioning status. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
Linking: No description available. ,
Provisioning: No description available. ,
RecoveringScaleFailure: No description available. ,
Scaling: No description available. ,
Succeeded: No description available. ,
Unlinking: No description available. ,
Unprovisioning: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Redis host name. ,
Required: False ,
}
string ,
port:
{
Description: Redis non-SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
sslPort:
{
Description: Redis SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
accessKeys:
{
Description: The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache ,
Required: False ,
}
{
primaryKey:
{
Description: The current primary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The current secondary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
}
,
linkedServers:
{
Description: List of the linked servers associated with the cache ,
Required: False ,
}
[
{
id:
{
Description: Linked server Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: Link for next page of results. ,
Required: False ,
}
string ,
}
Redis_ListKeys (new)
Description :  Retrieve a Redis cache's access keys. This operation requires write permission to the cache resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/listKeys
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryKey:
{
Description: The current primary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The current secondary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
}
Redis_RegenerateKey (new)
Description :  Regenerate Redis cache's access keys. This operation requires write permission to the cache resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/regenerateKey
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
parameters:
{
Description: Specifies which key to regenerate. ,
Required: True ,
}
{
keyType:
{
Description: The Redis access key to regenerate. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryKey:
{
Description: The current primary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The current secondary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
}
Redis_ForceReboot (new)
Description :  Reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/forceReboot
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
parameters:
{
Description: Specifies which Redis node(s) to reboot. ,
Required: True ,
}
{
rebootType:
{
Description: Which Redis node(s) to reboot. Depending on this value data loss is possible. ,
Enum:
{
PrimaryNode: No description available. ,
SecondaryNode: No description available. ,
AllNodes: No description available. ,
}
,
Required: True ,
}
enum ,
shardId:
{
Description: If clustering is enabled, the ID of the shard to be rebooted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
message:
{
Description: Status message ,
Required: False ,
}
string ,
}
Redis_ImportData (new)
Description :  Import data into Redis cache.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/import
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for Redis import operation. ,
Required: True ,
}
{
format:
{
Description: File format. ,
Required: False ,
}
string ,
files:
{
Description: files to import. ,
Required: True ,
}
[
string ,
]
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (204)

{}
Redis_ExportData (new)
Description :  Export data from the redis cache to blobs in a container.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/export
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for Redis export operation. ,
Required: True ,
}
{
format:
{
Description: File format. ,
Required: False ,
}
string ,
prefix:
{
Description: Prefix to use for exported files. ,
Required: True ,
}
string ,
container:
{
Description: Container name to export to. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (204)

{}
FirewallRules_ListByRedisResource (new)
Description :  Gets all firewall rules in the specified redis cache.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
cacheName:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list firewall rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: redis cache firewall rule properties ,
Required: True ,
}
{
startIP:
{
Description: lowest IP address included in the range ,
Required: True ,
}
string ,
endIP:
{
Description: highest IP address included in the range ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for next page of results. ,
Required: False ,
}
string ,
}
FirewallRules_CreateOrUpdate (new)
Description :  Create or update a redis cache firewall rule
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules/{ruleName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
cacheName:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
ruleName:
{
Description: The name of the firewall rule. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update redis firewall rule operation. ,
Required: True ,
}
{
properties:
{
Description: Properties required to create a firewall rule . ,
Required: True ,
}
{
startIP:
{
Description: lowest IP address included in the range ,
Required: True ,
}
string ,
endIP:
{
Description: highest IP address included in the range ,
Required: True ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: redis cache firewall rule properties ,
Required: True ,
}
{
startIP:
{
Description: lowest IP address included in the range ,
Required: True ,
}
string ,
endIP:
{
Description: highest IP address included in the range ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: redis cache firewall rule properties ,
Required: True ,
}
{
startIP:
{
Description: lowest IP address included in the range ,
Required: True ,
}
string ,
endIP:
{
Description: highest IP address included in the range ,
Required: True ,
}
string ,
}
,
}
FirewallRules_Get (new)
Description :  Gets a single firewall rule in a specified redis cache.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules/{ruleName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
cacheName:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
ruleName:
{
Description: The name of the firewall rule. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: redis cache firewall rule properties ,
Required: True ,
}
{
startIP:
{
Description: lowest IP address included in the range ,
Required: True ,
}
string ,
endIP:
{
Description: highest IP address included in the range ,
Required: True ,
}
string ,
}
,
}
FirewallRules_Delete (new)
Description :  Deletes a single firewall rule in a specified redis cache.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules/{ruleName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
cacheName:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
ruleName:
{
Description: The name of the firewall rule. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
PatchSchedules_ListByRedisResource (new)
Description :  Gets all patch schedules in the specified redis cache (there is only one).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/patchSchedules
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
cacheName:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list patch schedules operation. ,
Required: False ,
}
[
{
properties:
{
Description: List of patch schedules for a Redis cache. ,
Required: True ,
}
{
scheduleEntries:
{
Description: List of patch schedules for a Redis cache. ,
Required: True ,
}
[
{
dayOfWeek:
{
Description: Day of the week when a cache can be patched. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
Everyday: No description available. ,
Weekend: No description available. ,
}
,
Required: True ,
}
enum ,
startHourUtc:
{
Description: Start hour after which cache patching can start. ,
Format: int32 ,
Required: True ,
}
integer ,
maintenanceWindow:
{
Description: ISO8601 timespan specifying how much time cache patching can take. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link for next page of results. ,
Required: False ,
}
string ,
}
PatchSchedules_CreateOrUpdate (new)
Description :  Create or replace the patching schedule for Redis cache.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/{default}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
default:
{
Description: Default string modeled as parameter for auto generation to work correctly. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to set the patching schedule for Redis cache. ,
Required: True ,
}
{
properties:
{
Description: List of patch schedules for a Redis cache. ,
Required: True ,
}
{
scheduleEntries:
{
Description: List of patch schedules for a Redis cache. ,
Required: True ,
}
[
{
dayOfWeek:
{
Description: Day of the week when a cache can be patched. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
Everyday: No description available. ,
Weekend: No description available. ,
}
,
Required: True ,
}
enum ,
startHourUtc:
{
Description: Start hour after which cache patching can start. ,
Format: int32 ,
Required: True ,
}
integer ,
maintenanceWindow:
{
Description: ISO8601 timespan specifying how much time cache patching can take. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: List of patch schedules for a Redis cache. ,
Required: True ,
}
{
scheduleEntries:
{
Description: List of patch schedules for a Redis cache. ,
Required: True ,
}
[
{
dayOfWeek:
{
Description: Day of the week when a cache can be patched. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
Everyday: No description available. ,
Weekend: No description available. ,
}
,
Required: True ,
}
enum ,
startHourUtc:
{
Description: Start hour after which cache patching can start. ,
Format: int32 ,
Required: True ,
}
integer ,
maintenanceWindow:
{
Description: ISO8601 timespan specifying how much time cache patching can take. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: List of patch schedules for a Redis cache. ,
Required: True ,
}
{
scheduleEntries:
{
Description: List of patch schedules for a Redis cache. ,
Required: True ,
}
[
{
dayOfWeek:
{
Description: Day of the week when a cache can be patched. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
Everyday: No description available. ,
Weekend: No description available. ,
}
,
Required: True ,
}
enum ,
startHourUtc:
{
Description: Start hour after which cache patching can start. ,
Format: int32 ,
Required: True ,
}
integer ,
maintenanceWindow:
{
Description: ISO8601 timespan specifying how much time cache patching can take. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PatchSchedules_Delete (new)
Description :  Deletes the patching schedule of a redis cache.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/{default}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the redis cache. ,
Required: True ,
}
string ,
default:
{
Description: Default string modeled as parameter for auto generation to work correctly. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
PatchSchedules_Get (new)
Description :  Gets the patching schedule of a redis cache.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/{default}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the redis cache. ,
Required: True ,
}
string ,
default:
{
Description: Default string modeled as parameter for auto generation to work correctly. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: List of patch schedules for a Redis cache. ,
Required: True ,
}
{
scheduleEntries:
{
Description: List of patch schedules for a Redis cache. ,
Required: True ,
}
[
{
dayOfWeek:
{
Description: Day of the week when a cache can be patched. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
Everyday: No description available. ,
Weekend: No description available. ,
}
,
Required: True ,
}
enum ,
startHourUtc:
{
Description: Start hour after which cache patching can start. ,
Format: int32 ,
Required: True ,
}
integer ,
maintenanceWindow:
{
Description: ISO8601 timespan specifying how much time cache patching can take. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
LinkedServer_Create (new)
Description :  Adds a linked server to the Redis cache (requires Premium SKU).
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/linkedServers/{linkedServerName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
linkedServerName:
{
Description: The name of the linked server that is being added to the Redis cache. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create Linked server operation. ,
Required: True ,
}
{
properties:
{
Description: Properties required to create a linked server. ,
Required: True ,
}
{
linkedRedisCacheId:
{
Description: Fully qualified resourceId of the linked redis cache. ,
Required: True ,
}
string ,
linkedRedisCacheLocation:
{
Description: Location of the linked redis cache. ,
Required: True ,
}
string ,
serverRole:
{
Description: Role of the linked server. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the linked server. ,
Required: False ,
}
{
provisioningState:
{
Description: Terminal state of the link between primary and secondary redis cache. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the linked server. ,
Required: False ,
}
{
provisioningState:
{
Description: Terminal state of the link between primary and secondary redis cache. ,
Required: False ,
}
string ,
}
,
}
LinkedServer_Delete (new)
Description :  Deletes the linked server from a redis cache (requires Premium SKU).
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/linkedServers/{linkedServerName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the redis cache. ,
Required: True ,
}
string ,
linkedServerName:
{
Description: The name of the linked server that is being added to the Redis cache. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
LinkedServer_Get (new)
Description :  Gets the detailed information about a linked server of a redis cache (requires Premium SKU).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/linkedServers/{linkedServerName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the redis cache. ,
Required: True ,
}
string ,
linkedServerName:
{
Description: The name of the linked server. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the linked server. ,
Required: False ,
}
{
provisioningState:
{
Description: Terminal state of the link between primary and secondary redis cache. ,
Required: False ,
}
string ,
}
,
}
LinkedServer_List (new)
Description :  Gets the list of linked servers associated with this redis cache (requires Premium SKU).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/linkedServers
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the redis cache. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of linked servers (with properties) of a Redis cache. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the linked server. ,
Required: False ,
}
{
provisioningState:
{
Description: Terminal state of the link between primary and secondary redis cache. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for next set. ,
Required: False ,
}
string ,
}
Operations_List (removed)
Description :  Lists all of the available REST API operations of the Microsoft.Cache provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Cache/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that describes the operation. ,
Required: False ,
}
{
provider:
{
Description: Friendly name of the resource provider ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: read, write, delete, listKeys/action, etc. ,
Required: False ,
}
string ,
resource:
{
Description: Resource type on which the operation is performed. ,
Required: False ,
}
string ,
description:
{
Description: Friendly name of the operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}
Redis_CheckNameAvailability (removed)
Description :  Checks that the redis cache name is valid and is not already in use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Cache/CheckNameAvailability
{
parameters:
{
Description: Parameters supplied to the CheckNameAvailability Redis operation. The only supported resource type is 'Microsoft.Cache/redis' ,
Required: True ,
}
{
name:
{
Description: Resource name. ,
Required: True ,
}
string ,
type:
{
Description: Resource type. The only legal value of this property for checking redis cache name availability is 'Microsoft.Cache/redis'. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
Redis_ListUpgradeNotifications (removed)
Description :  Gets any upgrade notifications for a Redis cache.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/listUpgradeNotifications
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
history:
{
Description: how many minutes in past to look for upgrade notifications ,
Format: double ,
Required: True ,
}
number ,
}

⚐ Response (200)

{
value:
{
Description: List of all notifications. ,
Required: False ,
}
[
{
name:
{
Description: Name of upgrade notification. ,
Required: False ,
}
string ,
timestamp:
{
Description: Timestamp when upgrade notification occurred. ,
Format: date-time ,
Required: False ,
}
string ,
upsellNotification:
{
Description: Details about this upgrade notification ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of notifications. ,
Required: False ,
}
string ,
}
Redis_Create (removed)
Description :  Create or replace (overwrite/recreate, with potential downtime) an existing Redis cache.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create Redis operation. ,
Required: True ,
}
{
properties:
{
Description: Redis cache properties. ,
Required: True ,
}
{
sku:
{
Description: The SKU of the Redis cache to deploy. ,
Required: True ,
}
{
name:
{
Description: The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
family:
{
Description: The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). ,
Enum:
{
C: No description available. ,
P: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: 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, 5). ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
subnetId:
{
Description: 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 ,
Required: False ,
}
string ,
staticIP:
{
Description: Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
location:
{
Description: The geo-location where the resource lives ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Redis cache properties. ,
Required: True ,
}
{
redisVersion:
{
Description: Redis version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Redis instance provisioning status. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
Linking: No description available. ,
Provisioning: No description available. ,
RecoveringScaleFailure: No description available. ,
Scaling: No description available. ,
Succeeded: No description available. ,
Unlinking: No description available. ,
Unprovisioning: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Redis host name. ,
Required: False ,
}
string ,
port:
{
Description: Redis non-SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
sslPort:
{
Description: Redis SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
accessKeys:
{
Description: The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache ,
Required: False ,
}
{
primaryKey:
{
Description: The current primary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The current secondary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
}
,
linkedServers:
{
Description: List of the linked servers associated with the cache ,
Required: False ,
}
[
{
id:
{
Description: Linked server Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (200)

{
properties:
{
Description: Redis cache properties. ,
Required: True ,
}
{
redisVersion:
{
Description: Redis version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Redis instance provisioning status. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
Linking: No description available. ,
Provisioning: No description available. ,
RecoveringScaleFailure: No description available. ,
Scaling: No description available. ,
Succeeded: No description available. ,
Unlinking: No description available. ,
Unprovisioning: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Redis host name. ,
Required: False ,
}
string ,
port:
{
Description: Redis non-SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
sslPort:
{
Description: Redis SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
accessKeys:
{
Description: The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache ,
Required: False ,
}
{
primaryKey:
{
Description: The current primary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The current secondary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
}
,
linkedServers:
{
Description: List of the linked servers associated with the cache ,
Required: False ,
}
[
{
id:
{
Description: Linked server Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
Redis_Update (removed)
Description :  Update an existing Redis cache.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update Redis operation. ,
Required: True ,
}
{
properties:
{
Description: Redis cache properties. ,
Required: False ,
}
{
sku:
{
Description: The SKU of the Redis cache to deploy. ,
Required: False ,
}
{
name:
{
Description: The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
family:
{
Description: The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). ,
Enum:
{
C: No description available. ,
P: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: 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, 5). ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Redis cache properties. ,
Required: True ,
}
{
redisVersion:
{
Description: Redis version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Redis instance provisioning status. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
Linking: No description available. ,
Provisioning: No description available. ,
RecoveringScaleFailure: No description available. ,
Scaling: No description available. ,
Succeeded: No description available. ,
Unlinking: No description available. ,
Unprovisioning: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Redis host name. ,
Required: False ,
}
string ,
port:
{
Description: Redis non-SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
sslPort:
{
Description: Redis SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
accessKeys:
{
Description: The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache ,
Required: False ,
}
{
primaryKey:
{
Description: The current primary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The current secondary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
}
,
linkedServers:
{
Description: List of the linked servers associated with the cache ,
Required: False ,
}
[
{
id:
{
Description: Linked server Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
Redis_Delete (removed)
Description :  Deletes a Redis cache.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Redis_Get (removed)
Description :  Gets a Redis cache (resource description).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Redis cache properties. ,
Required: True ,
}
{
redisVersion:
{
Description: Redis version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Redis instance provisioning status. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
Linking: No description available. ,
Provisioning: No description available. ,
RecoveringScaleFailure: No description available. ,
Scaling: No description available. ,
Succeeded: No description available. ,
Unlinking: No description available. ,
Unprovisioning: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Redis host name. ,
Required: False ,
}
string ,
port:
{
Description: Redis non-SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
sslPort:
{
Description: Redis SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
accessKeys:
{
Description: The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache ,
Required: False ,
}
{
primaryKey:
{
Description: The current primary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The current secondary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
}
,
linkedServers:
{
Description: List of the linked servers associated with the cache ,
Required: False ,
}
[
{
id:
{
Description: Linked server Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
Redis_ListByResourceGroup (removed)
Description :  Lists all Redis caches in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Redis cache instances. ,
Required: False ,
}
[
{
properties:
{
Description: Redis cache properties. ,
Required: True ,
}
{
redisVersion:
{
Description: Redis version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Redis instance provisioning status. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
Linking: No description available. ,
Provisioning: No description available. ,
RecoveringScaleFailure: No description available. ,
Scaling: No description available. ,
Succeeded: No description available. ,
Unlinking: No description available. ,
Unprovisioning: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Redis host name. ,
Required: False ,
}
string ,
port:
{
Description: Redis non-SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
sslPort:
{
Description: Redis SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
accessKeys:
{
Description: The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache ,
Required: False ,
}
{
primaryKey:
{
Description: The current primary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The current secondary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
}
,
linkedServers:
{
Description: List of the linked servers associated with the cache ,
Required: False ,
}
[
{
id:
{
Description: Linked server Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: Link for next page of results. ,
Required: False ,
}
string ,
}
Redis_List (removed)
Description :  Gets all Redis caches in the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Cache/Redis
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Redis cache instances. ,
Required: False ,
}
[
{
properties:
{
Description: Redis cache properties. ,
Required: True ,
}
{
redisVersion:
{
Description: Redis version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Redis instance provisioning status. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
Linking: No description available. ,
Provisioning: No description available. ,
RecoveringScaleFailure: No description available. ,
Scaling: No description available. ,
Succeeded: No description available. ,
Unlinking: No description available. ,
Unprovisioning: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Redis host name. ,
Required: False ,
}
string ,
port:
{
Description: Redis non-SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
sslPort:
{
Description: Redis SSL port. ,
Format: int32 ,
Required: False ,
}
integer ,
accessKeys:
{
Description: The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache ,
Required: False ,
}
{
primaryKey:
{
Description: The current primary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The current secondary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
}
,
linkedServers:
{
Description: List of the linked servers associated with the cache ,
Required: False ,
}
[
{
id:
{
Description: Linked server Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: Link for next page of results. ,
Required: False ,
}
string ,
}
Redis_ListKeys (removed)
Description :  Retrieve a Redis cache's access keys. This operation requires write permission to the cache resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/listKeys
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryKey:
{
Description: The current primary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The current secondary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
}
Redis_RegenerateKey (removed)
Description :  Regenerate Redis cache's access keys. This operation requires write permission to the cache resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/regenerateKey
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
parameters:
{
Description: Specifies which key to regenerate. ,
Required: True ,
}
{
keyType:
{
Description: The Redis access key to regenerate. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryKey:
{
Description: The current primary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The current secondary key that clients can use to authenticate with Redis cache. ,
Required: False ,
}
string ,
}
Redis_ForceReboot (removed)
Description :  Reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/forceReboot
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
parameters:
{
Description: Specifies which Redis node(s) to reboot. ,
Required: True ,
}
{
rebootType:
{
Description: Which Redis node(s) to reboot. Depending on this value data loss is possible. ,
Enum:
{
PrimaryNode: No description available. ,
SecondaryNode: No description available. ,
AllNodes: No description available. ,
}
,
Required: True ,
}
enum ,
shardId:
{
Description: If clustering is enabled, the ID of the shard to be rebooted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
message:
{
Description: Status message ,
Required: False ,
}
string ,
}
Redis_ImportData (removed)
Description :  Import data into Redis cache.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/import
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for Redis import operation. ,
Required: True ,
}
{
format:
{
Description: File format. ,
Required: False ,
}
string ,
files:
{
Description: files to import. ,
Required: True ,
}
[
string ,
]
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (204)

{}
Redis_ExportData (removed)
Description :  Export data from the redis cache to blobs in a container.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/export
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for Redis export operation. ,
Required: True ,
}
{
format:
{
Description: File format. ,
Required: False ,
}
string ,
prefix:
{
Description: Prefix to use for exported files. ,
Required: True ,
}
string ,
container:
{
Description: Container name to export to. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (204)

{}
FirewallRules_ListByRedisResource (removed)
Description :  Gets all firewall rules in the specified redis cache.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
cacheName:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list firewall rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: redis cache firewall rule properties ,
Required: True ,
}
{
startIP:
{
Description: lowest IP address included in the range ,
Required: True ,
}
string ,
endIP:
{
Description: highest IP address included in the range ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for next page of results. ,
Required: False ,
}
string ,
}
FirewallRules_CreateOrUpdate (removed)
Description :  Create or update a redis cache firewall rule
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules/{ruleName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
cacheName:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
ruleName:
{
Description: The name of the firewall rule. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update redis firewall rule operation. ,
Required: True ,
}
{
properties:
{
Description: Properties required to create a firewall rule . ,
Required: True ,
}
{
startIP:
{
Description: lowest IP address included in the range ,
Required: True ,
}
string ,
endIP:
{
Description: highest IP address included in the range ,
Required: True ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: redis cache firewall rule properties ,
Required: True ,
}
{
startIP:
{
Description: lowest IP address included in the range ,
Required: True ,
}
string ,
endIP:
{
Description: highest IP address included in the range ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: redis cache firewall rule properties ,
Required: True ,
}
{
startIP:
{
Description: lowest IP address included in the range ,
Required: True ,
}
string ,
endIP:
{
Description: highest IP address included in the range ,
Required: True ,
}
string ,
}
,
}
FirewallRules_Get (removed)
Description :  Gets a single firewall rule in a specified redis cache.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules/{ruleName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
cacheName:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
ruleName:
{
Description: The name of the firewall rule. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: redis cache firewall rule properties ,
Required: True ,
}
{
startIP:
{
Description: lowest IP address included in the range ,
Required: True ,
}
string ,
endIP:
{
Description: highest IP address included in the range ,
Required: True ,
}
string ,
}
,
}
FirewallRules_Delete (removed)
Description :  Deletes a single firewall rule in a specified redis cache.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules/{ruleName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
cacheName:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
ruleName:
{
Description: The name of the firewall rule. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
PatchSchedules_ListByRedisResource (removed)
Description :  Gets all patch schedules in the specified redis cache (there is only one).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/patchSchedules
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
cacheName:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list patch schedules operation. ,
Required: False ,
}
[
{
properties:
{
Description: List of patch schedules for a Redis cache. ,
Required: True ,
}
{
scheduleEntries:
{
Description: List of patch schedules for a Redis cache. ,
Required: True ,
}
[
{
dayOfWeek:
{
Description: Day of the week when a cache can be patched. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
Everyday: No description available. ,
Weekend: No description available. ,
}
,
Required: True ,
}
enum ,
startHourUtc:
{
Description: Start hour after which cache patching can start. ,
Format: int32 ,
Required: True ,
}
integer ,
maintenanceWindow:
{
Description: ISO8601 timespan specifying how much time cache patching can take. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link for next page of results. ,
Required: False ,
}
string ,
}
PatchSchedules_CreateOrUpdate (removed)
Description :  Create or replace the patching schedule for Redis cache.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/{default}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
default:
{
Description: Default string modeled as parameter for auto generation to work correctly. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to set the patching schedule for Redis cache. ,
Required: True ,
}
{
properties:
{
Description: List of patch schedules for a Redis cache. ,
Required: True ,
}
{
scheduleEntries:
{
Description: List of patch schedules for a Redis cache. ,
Required: True ,
}
[
{
dayOfWeek:
{
Description: Day of the week when a cache can be patched. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
Everyday: No description available. ,
Weekend: No description available. ,
}
,
Required: True ,
}
enum ,
startHourUtc:
{
Description: Start hour after which cache patching can start. ,
Format: int32 ,
Required: True ,
}
integer ,
maintenanceWindow:
{
Description: ISO8601 timespan specifying how much time cache patching can take. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: List of patch schedules for a Redis cache. ,
Required: True ,
}
{
scheduleEntries:
{
Description: List of patch schedules for a Redis cache. ,
Required: True ,
}
[
{
dayOfWeek:
{
Description: Day of the week when a cache can be patched. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
Everyday: No description available. ,
Weekend: No description available. ,
}
,
Required: True ,
}
enum ,
startHourUtc:
{
Description: Start hour after which cache patching can start. ,
Format: int32 ,
Required: True ,
}
integer ,
maintenanceWindow:
{
Description: ISO8601 timespan specifying how much time cache patching can take. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: List of patch schedules for a Redis cache. ,
Required: True ,
}
{
scheduleEntries:
{
Description: List of patch schedules for a Redis cache. ,
Required: True ,
}
[
{
dayOfWeek:
{
Description: Day of the week when a cache can be patched. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
Everyday: No description available. ,
Weekend: No description available. ,
}
,
Required: True ,
}
enum ,
startHourUtc:
{
Description: Start hour after which cache patching can start. ,
Format: int32 ,
Required: True ,
}
integer ,
maintenanceWindow:
{
Description: ISO8601 timespan specifying how much time cache patching can take. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PatchSchedules_Delete (removed)
Description :  Deletes the patching schedule of a redis cache.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/{default}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the redis cache. ,
Required: True ,
}
string ,
default:
{
Description: Default string modeled as parameter for auto generation to work correctly. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
PatchSchedules_Get (removed)
Description :  Gets the patching schedule of a redis cache.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/{default}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the redis cache. ,
Required: True ,
}
string ,
default:
{
Description: Default string modeled as parameter for auto generation to work correctly. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: List of patch schedules for a Redis cache. ,
Required: True ,
}
{
scheduleEntries:
{
Description: List of patch schedules for a Redis cache. ,
Required: True ,
}
[
{
dayOfWeek:
{
Description: Day of the week when a cache can be patched. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
Everyday: No description available. ,
Weekend: No description available. ,
}
,
Required: True ,
}
enum ,
startHourUtc:
{
Description: Start hour after which cache patching can start. ,
Format: int32 ,
Required: True ,
}
integer ,
maintenanceWindow:
{
Description: ISO8601 timespan specifying how much time cache patching can take. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
LinkedServer_Create (removed)
Description :  Adds a linked server to the Redis cache (requires Premium SKU).
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/linkedServers/{linkedServerName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Redis cache. ,
Required: True ,
}
string ,
linkedServerName:
{
Description: The name of the linked server that is being added to the Redis cache. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create Linked server operation. ,
Required: True ,
}
{
properties:
{
Description: Properties required to create a linked server. ,
Required: True ,
}
{
linkedRedisCacheId:
{
Description: Fully qualified resourceId of the linked redis cache. ,
Required: True ,
}
string ,
linkedRedisCacheLocation:
{
Description: Location of the linked redis cache. ,
Required: True ,
}
string ,
serverRole:
{
Description: Role of the linked server. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the linked server. ,
Required: False ,
}
{
provisioningState:
{
Description: Terminal state of the link between primary and secondary redis cache. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the linked server. ,
Required: False ,
}
{
provisioningState:
{
Description: Terminal state of the link between primary and secondary redis cache. ,
Required: False ,
}
string ,
}
,
}
LinkedServer_Delete (removed)
Description :  Deletes the linked server from a redis cache (requires Premium SKU).
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/linkedServers/{linkedServerName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the redis cache. ,
Required: True ,
}
string ,
linkedServerName:
{
Description: The name of the linked server that is being added to the Redis cache. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
LinkedServer_Get (removed)
Description :  Gets the detailed information about a linked server of a redis cache (requires Premium SKU).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/linkedServers/{linkedServerName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the redis cache. ,
Required: True ,
}
string ,
linkedServerName:
{
Description: The name of the linked server. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the linked server. ,
Required: False ,
}
{
provisioningState:
{
Description: Terminal state of the link between primary and secondary redis cache. ,
Required: False ,
}
string ,
}
,
}
LinkedServer_List (removed)
Description :  Gets the list of linked servers associated with this redis cache (requires Premium SKU).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/linkedServers
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the redis cache. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of linked servers (with properties) of a Redis cache. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the linked server. ,
Required: False ,
}
{
provisioningState:
{
Description: Terminal state of the link between primary and secondary redis cache. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for next set. ,
Required: False ,
}
string ,
}