Microsoft.Cache (stable:2024-11-01)

2025/09/03 • 1 new, 40 updated methods

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
{
api-version: string ,
subscriptionId: string ,
parameters:
{
name: string ,
type: string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Operations_List (updated)
Description List the operations for the provider
Reference Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "Description": {
    "new": "List the operations for the provider",
    "old": "Lists all of the available REST API operations of the Microsoft.Cache provider."
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Required": {
            "new": true,
            "old": false
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Cache/operations
{
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
name: string ,
display:
{
provider: string ,
operation: string ,
resource: string ,
description: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
AsyncOperationStatus_Get (updated)
Description For checking the ongoing status of an operation
Reference Link ¶

⚶ Changes

{
  "#id": "AsyncOperationStatus_Get",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Cache/locations/{location}/asyncOperations/{operationId}
{
api-version: string ,
location: string ,
operationId: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
properties: object ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Redis_ListBySubscription (updated)
Description Gets all Redis caches in the specified subscription.
Reference Link ¶

⚶ Changes

{
  "#id": "Redis_ListBySubscription",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The RedisResource items on this page",
            "old": "List of Redis cache instances."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": [
              {
                "properties": [
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Creating",
                          "A create operation is in progress."
                        ],
                        [
                          "Deleting",
                          "A delete operation is in progress."
                        ],
                        [
                          "Disabled",
                          "The cache is disabled and cannot be used."
                        ],
                        [
                          "Failed",
                          "An operation such as create or update failed. If you failed to create the cache it will not be in a usable state, so you should delete and recreate it."
                        ],
                        [
                          "Linking",
                          "Georeplication link is in progress"
                        ],
                        [
                          "Provisioning",
                          "An operation is in progress"
                        ],
                        [
                          "RecoveringScaleFailure",
                          "A scaling operation encountered an error and recovery is in progress."
                        ],
                        [
                          "Scaling",
                          "A scaling operation is in progress"
                        ],
                        [
                          "Succeeded",
                          "The most recent operation successfully completed"
                        ],
                        [
                          "Unlinking",
                          "Georeplication unlink is in progress"
                        ],
                        [
                          "Unprovisioning",
                          "The cache may be being disabled"
                        ],
                        [
                          "Updating",
                          "An update operation is in progress."
                        ],
                        [
                          "ConfiguringAAD",
                          "An AAD configuration update operation is in progress."
                        ]
                      ],
                      "old": [
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Disabled",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ],
                        [
                          "Linking",
                          ""
                        ],
                        [
                          "Provisioning",
                          ""
                        ],
                        [
                          "RecoveringScaleFailure",
                          ""
                        ],
                        [
                          "Scaling",
                          ""
                        ],
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Unlinking",
                          ""
                        ],
                        [
                          "Unprovisioning",
                          ""
                        ],
                        [
                          "Updating",
                          ""
                        ],
                        [
                          "ConfiguringAAD",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "privateEndpointConnections": {
                      "Description": {
                        "new": "The private endpoint connection resource.",
                        "old": "The Private Endpoint Connection resource."
                      },
                      "$properties": {
                        "properties": [
                          {
                            "@added_36f9f4a7d37d4bd6be6409a96677d7f5": {
                              "#name": "groupIds",
                              "Description": "The group ids for the private endpoint resource.",
                              "Required": false,
                              "Type": "array",
                              "$items": {
                                "Type": "string"
                              }
                            }
                          },
                          {
                            "#name": "privateEndpoint",
                            "Description": {
                              "new": "The private endpoint resource.",
                              "old": "The resource of private end point."
                            },
                            "$properties": [
                              {
                                "#name": "id",
                                "Description": {
                                  "new": "The ARM identifier for private endpoint.",
                                  "old": "The ARM identifier for Private Endpoint"
                                }
                              }
                            ]
                          }
                        ]
                      }
                    }
                  }
                ]
              },
              {
                "#name": "zones",
                "Description": {
                  "new": "The availability zones.",
                  "old": "A list of availability zones denoting where the resource needs to come from."
                }
              },
              {
                "#name": "identity",
                "Description": {
                  "new": "The managed service identities assigned to this resource.",
                  "old": "The identity of the resource."
                }
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link for next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Cache/redis
{
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
hostName: string ,
port: integer ,
sslPort: integer ,
accessKeys:
{
primaryKey: string ,
secondaryKey: string ,
}
,
linkedServers:
[
{
id: string ,
}
,
]
,
instances:
[
{
sslPort: integer ,
nonSslPort: integer ,
zone: string ,
shardId: integer ,
isMaster: boolean ,
isPrimary: boolean ,
}
,
]
,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
}
,
zones:
[
string ,
]
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Redis_ListByResourceGroup (updated)
Description Lists all Redis caches in a resource group.
Reference Link ¶

⚶ Changes

{
  "#id": "Redis_ListByResourceGroup",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The RedisResource items on this page",
            "old": "List of Redis cache instances."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": [
              {
                "properties": [
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Creating",
                          "A create operation is in progress."
                        ],
                        [
                          "Deleting",
                          "A delete operation is in progress."
                        ],
                        [
                          "Disabled",
                          "The cache is disabled and cannot be used."
                        ],
                        [
                          "Failed",
                          "An operation such as create or update failed. If you failed to create the cache it will not be in a usable state, so you should delete and recreate it."
                        ],
                        [
                          "Linking",
                          "Georeplication link is in progress"
                        ],
                        [
                          "Provisioning",
                          "An operation is in progress"
                        ],
                        [
                          "RecoveringScaleFailure",
                          "A scaling operation encountered an error and recovery is in progress."
                        ],
                        [
                          "Scaling",
                          "A scaling operation is in progress"
                        ],
                        [
                          "Succeeded",
                          "The most recent operation successfully completed"
                        ],
                        [
                          "Unlinking",
                          "Georeplication unlink is in progress"
                        ],
                        [
                          "Unprovisioning",
                          "The cache may be being disabled"
                        ],
                        [
                          "Updating",
                          "An update operation is in progress."
                        ],
                        [
                          "ConfiguringAAD",
                          "An AAD configuration update operation is in progress."
                        ]
                      ],
                      "old": [
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Disabled",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ],
                        [
                          "Linking",
                          ""
                        ],
                        [
                          "Provisioning",
                          ""
                        ],
                        [
                          "RecoveringScaleFailure",
                          ""
                        ],
                        [
                          "Scaling",
                          ""
                        ],
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Unlinking",
                          ""
                        ],
                        [
                          "Unprovisioning",
                          ""
                        ],
                        [
                          "Updating",
                          ""
                        ],
                        [
                          "ConfiguringAAD",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "privateEndpointConnections": {
                      "Description": {
                        "new": "The private endpoint connection resource.",
                        "old": "The Private Endpoint Connection resource."
                      },
                      "$properties": {
                        "properties": [
                          {
                            "@added_6b7e0f704ffc4cc9a1ae9abcaf2fcead": {
                              "#name": "groupIds",
                              "Description": "The group ids for the private endpoint resource.",
                              "Required": false,
                              "Type": "array",
                              "$items": {
                                "Type": "string"
                              }
                            }
                          },
                          {
                            "#name": "privateEndpoint",
                            "Description": {
                              "new": "The private endpoint resource.",
                              "old": "The resource of private end point."
                            },
                            "$properties": [
                              {
                                "#name": "id",
                                "Description": {
                                  "new": "The ARM identifier for private endpoint.",
                                  "old": "The ARM identifier for Private Endpoint"
                                }
                              }
                            ]
                          }
                        ]
                      }
                    }
                  }
                ]
              },
              {
                "#name": "zones",
                "Description": {
                  "new": "The availability zones.",
                  "old": "A list of availability zones denoting where the resource needs to come from."
                }
              },
              {
                "#name": "identity",
                "Description": {
                  "new": "The managed service identities assigned to this resource.",
                  "old": "The identity of the resource."
                }
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link for next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
hostName: string ,
port: integer ,
sslPort: integer ,
accessKeys:
{
primaryKey: string ,
secondaryKey: string ,
}
,
linkedServers:
[
{
id: string ,
}
,
]
,
instances:
[
{
sslPort: integer ,
nonSslPort: integer ,
zone: string ,
shardId: integer ,
isMaster: boolean ,
isPrimary: boolean ,
}
,
]
,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
}
,
zones:
[
string ,
]
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Redis_Get (updated)
Description Gets a Redis cache (resource description).
Reference Link ¶

⚶ Changes

{
  "#id": "Redis_Get",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    },
    {
      "#name": "name",
      "Description": {
        "new": "The name of the RedisResource",
        "old": "The name of the Redis cache."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "properties": [
            {
              "#name": "provisioningState",
              "Enum": {
                "new": [
                  [
                    "Creating",
                    "A create operation is in progress."
                  ],
                  [
                    "Deleting",
                    "A delete operation is in progress."
                  ],
                  [
                    "Disabled",
                    "The cache is disabled and cannot be used."
                  ],
                  [
                    "Failed",
                    "An operation such as create or update failed. If you failed to create the cache it will not be in a usable state, so you should delete and recreate it."
                  ],
                  [
                    "Linking",
                    "Georeplication link is in progress"
                  ],
                  [
                    "Provisioning",
                    "An operation is in progress"
                  ],
                  [
                    "RecoveringScaleFailure",
                    "A scaling operation encountered an error and recovery is in progress."
                  ],
                  [
                    "Scaling",
                    "A scaling operation is in progress"
                  ],
                  [
                    "Succeeded",
                    "The most recent operation successfully completed"
                  ],
                  [
                    "Unlinking",
                    "Georeplication unlink is in progress"
                  ],
                  [
                    "Unprovisioning",
                    "The cache may be being disabled"
                  ],
                  [
                    "Updating",
                    "An update operation is in progress."
                  ],
                  [
                    "ConfiguringAAD",
                    "An AAD configuration update operation is in progress."
                  ]
                ],
                "old": [
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Linking",
                    ""
                  ],
                  [
                    "Provisioning",
                    ""
                  ],
                  [
                    "RecoveringScaleFailure",
                    ""
                  ],
                  [
                    "Scaling",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Unlinking",
                    ""
                  ],
                  [
                    "Unprovisioning",
                    ""
                  ],
                  [
                    "Updating",
                    ""
                  ],
                  [
                    "ConfiguringAAD",
                    ""
                  ]
                ]
              }
            },
            {
              "privateEndpointConnections": {
                "Description": {
                  "new": "The private endpoint connection resource.",
                  "old": "The Private Endpoint Connection resource."
                },
                "$properties": {
                  "properties": [
                    {
                      "@added_bdb2aea6c44742c29f6ec7bc79e44f77": {
                        "#name": "groupIds",
                        "Description": "The group ids for the private endpoint resource.",
                        "Required": false,
                        "Type": "array",
                        "$items": {
                          "Type": "string"
                        }
                      }
                    },
                    {
                      "#name": "privateEndpoint",
                      "Description": {
                        "new": "The private endpoint resource.",
                        "old": "The resource of private end point."
                      },
                      "$properties": [
                        {
                          "#name": "id",
                          "Description": {
                            "new": "The ARM identifier for private endpoint.",
                            "old": "The ARM identifier for Private Endpoint"
                          }
                        }
                      ]
                    }
                  ]
                }
              }
            }
          ]
        },
        {
          "#name": "zones",
          "Description": {
            "new": "The availability zones.",
            "old": "A list of availability zones denoting where the resource needs to come from."
          }
        },
        {
          "#name": "identity",
          "Description": {
            "new": "The managed service identities assigned to this resource.",
            "old": "The identity of the resource."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
name: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
hostName: string ,
port: integer ,
sslPort: integer ,
accessKeys:
{
primaryKey: string ,
secondaryKey: string ,
}
,
linkedServers:
[
{
id: string ,
}
,
]
,
instances:
[
{
sslPort: integer ,
nonSslPort: integer ,
zone: string ,
shardId: integer ,
isMaster: boolean ,
isPrimary: boolean ,
}
,
]
,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
}
,
zones:
[
string ,
]
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Redis_Create (updated)
Description Create or replace (overwrite/recreate, with potential downtime) an existing Redis cache.
Reference Link ¶

⚶ Changes

{
  "#id": "Redis_Create",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    },
    {
      "#name": "name",
      "Description": {
        "new": "The name of the RedisResource",
        "old": "The name of the Redis cache."
      }
    },
    {
      "parameters": {
        "$properties": {
          "properties": [
            {
              "sku": [
                {
                  "#name": "name",
                  "Enum": {
                    "new": [
                      [
                        "Basic",
                        "The well known 'Basic' SKU for Azure Cache for Redis. Basic SKU does not have an availability SLA."
                      ],
                      [
                        "Standard",
                        "The well known 'Standard' SKU for Azure Cache for Redis. Standard SKU has an availability SLA."
                      ],
                      [
                        "Premium",
                        "The well known 'Premium' SKU for Azure Cache for Redis. Premium SKU has an availability SLA, and higher performance tiers and more features compared with Standard SKU."
                      ]
                    ],
                    "old": [
                      [
                        "Basic",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ],
                      [
                        "Premium",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "family",
                  "Enum": {
                    "new": [
                      [
                        "C",
                        "The SKU family to use - must be 'C' for Basic/Standard SKU redis caches."
                      ],
                      [
                        "P",
                        "The SKU family to use - must be 'P' for Premium SKU redis caches."
                      ]
                    ],
                    "old": [
                      [
                        "C",
                        ""
                      ],
                      [
                        "P",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "properties": [
            {
              "#name": "provisioningState",
              "Enum": {
                "new": [
                  [
                    "Creating",
                    "A create operation is in progress."
                  ],
                  [
                    "Deleting",
                    "A delete operation is in progress."
                  ],
                  [
                    "Disabled",
                    "The cache is disabled and cannot be used."
                  ],
                  [
                    "Failed",
                    "An operation such as create or update failed. If you failed to create the cache it will not be in a usable state, so you should delete and recreate it."
                  ],
                  [
                    "Linking",
                    "Georeplication link is in progress"
                  ],
                  [
                    "Provisioning",
                    "An operation is in progress"
                  ],
                  [
                    "RecoveringScaleFailure",
                    "A scaling operation encountered an error and recovery is in progress."
                  ],
                  [
                    "Scaling",
                    "A scaling operation is in progress"
                  ],
                  [
                    "Succeeded",
                    "The most recent operation successfully completed"
                  ],
                  [
                    "Unlinking",
                    "Georeplication unlink is in progress"
                  ],
                  [
                    "Unprovisioning",
                    "The cache may be being disabled"
                  ],
                  [
                    "Updating",
                    "An update operation is in progress."
                  ],
                  [
                    "ConfiguringAAD",
                    "An AAD configuration update operation is in progress."
                  ]
                ],
                "old": [
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Linking",
                    ""
                  ],
                  [
                    "Provisioning",
                    ""
                  ],
                  [
                    "RecoveringScaleFailure",
                    ""
                  ],
                  [
                    "Scaling",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Unlinking",
                    ""
                  ],
                  [
                    "Unprovisioning",
                    ""
                  ],
                  [
                    "Updating",
                    ""
                  ],
                  [
                    "ConfiguringAAD",
                    ""
                  ]
                ]
              }
            },
            {
              "privateEndpointConnections": {
                "Description": {
                  "new": "The private endpoint connection resource.",
                  "old": "The Private Endpoint Connection resource."
                },
                "$properties": {
                  "properties": [
                    {
                      "@added_315e92adf9b743648ac9dd372ec5af00": {
                        "#name": "groupIds",
                        "Description": "The group ids for the private endpoint resource.",
                        "Required": false,
                        "Type": "array",
                        "$items": {
                          "Type": "string"
                        }
                      }
                    },
                    {
                      "#name": "privateEndpoint",
                      "Description": {
                        "new": "The private endpoint resource.",
                        "old": "The resource of private end point."
                      },
                      "$properties": [
                        {
                          "#name": "id",
                          "Description": {
                            "new": "The ARM identifier for private endpoint.",
                            "old": "The ARM identifier for Private Endpoint"
                          }
                        }
                      ]
                    }
                  ]
                }
              }
            }
          ]
        },
        {
          "#name": "zones",
          "Description": {
            "new": "The availability zones.",
            "old": "A list of availability zones denoting where the resource needs to come from."
          }
        },
        {
          "#name": "identity",
          "Description": {
            "new": "The managed service identities assigned to this resource.",
            "old": "The identity of the resource."
          }
        }
      ]
    },
    "201": {
      "$properties": [
        {
          "properties": [
            {
              "#name": "provisioningState",
              "Enum": {
                "new": [
                  [
                    "Creating",
                    "A create operation is in progress."
                  ],
                  [
                    "Deleting",
                    "A delete operation is in progress."
                  ],
                  [
                    "Disabled",
                    "The cache is disabled and cannot be used."
                  ],
                  [
                    "Failed",
                    "An operation such as create or update failed. If you failed to create the cache it will not be in a usable state, so you should delete and recreate it."
                  ],
                  [
                    "Linking",
                    "Georeplication link is in progress"
                  ],
                  [
                    "Provisioning",
                    "An operation is in progress"
                  ],
                  [
                    "RecoveringScaleFailure",
                    "A scaling operation encountered an error and recovery is in progress."
                  ],
                  [
                    "Scaling",
                    "A scaling operation is in progress"
                  ],
                  [
                    "Succeeded",
                    "The most recent operation successfully completed"
                  ],
                  [
                    "Unlinking",
                    "Georeplication unlink is in progress"
                  ],
                  [
                    "Unprovisioning",
                    "The cache may be being disabled"
                  ],
                  [
                    "Updating",
                    "An update operation is in progress."
                  ],
                  [
                    "ConfiguringAAD",
                    "An AAD configuration update operation is in progress."
                  ]
                ],
                "old": [
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Linking",
                    ""
                  ],
                  [
                    "Provisioning",
                    ""
                  ],
                  [
                    "RecoveringScaleFailure",
                    ""
                  ],
                  [
                    "Scaling",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Unlinking",
                    ""
                  ],
                  [
                    "Unprovisioning",
                    ""
                  ],
                  [
                    "Updating",
                    ""
                  ],
                  [
                    "ConfiguringAAD",
                    ""
                  ]
                ]
              }
            },
            {
              "privateEndpointConnections": {
                "Description": {
                  "new": "The private endpoint connection resource.",
                  "old": "The Private Endpoint Connection resource."
                },
                "$properties": {
                  "properties": [
                    {
                      "@added_ba37d4c9aaa742cab8cb004aa35445b1": {
                        "#name": "groupIds",
                        "Description": "The group ids for the private endpoint resource.",
                        "Required": false,
                        "Type": "array",
                        "$items": {
                          "Type": "string"
                        }
                      }
                    },
                    {
                      "#name": "privateEndpoint",
                      "Description": {
                        "new": "The private endpoint resource.",
                        "old": "The resource of private end point."
                      },
                      "$properties": [
                        {
                          "#name": "id",
                          "Description": {
                            "new": "The ARM identifier for private endpoint.",
                            "old": "The ARM identifier for Private Endpoint"
                          }
                        }
                      ]
                    }
                  ]
                }
              }
            }
          ]
        },
        {
          "#name": "zones",
          "Description": {
            "new": "The availability zones.",
            "old": "A list of availability zones denoting where the resource needs to come from."
          }
        },
        {
          "#name": "identity",
          "Description": {
            "new": "The managed service identities assigned to this resource.",
            "old": "The identity of the resource."
          }
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
name: string ,
parameters:
{
properties:
{
sku:
{
name: enum ,
family: enum ,
capacity: integer ,
}
,
subnetId: string ,
staticIP: string ,
}
,
zones:
[
string ,
]
,
location: string ,
tags: object ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
hostName: string ,
port: integer ,
sslPort: integer ,
accessKeys:
{
primaryKey: string ,
secondaryKey: string ,
}
,
linkedServers:
[
{
id: string ,
}
,
]
,
instances:
[
{
sslPort: integer ,
nonSslPort: integer ,
zone: string ,
shardId: integer ,
isMaster: boolean ,
isPrimary: boolean ,
}
,
]
,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
}
,
zones:
[
string ,
]
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
}
,
$schema:
{
properties:
{
provisioningState: enum ,
hostName: string ,
port: integer ,
sslPort: integer ,
accessKeys:
{
primaryKey: string ,
secondaryKey: string ,
}
,
linkedServers:
[
{
id: string ,
}
,
]
,
instances:
[
{
sslPort: integer ,
nonSslPort: integer ,
zone: string ,
shardId: integer ,
isMaster: boolean ,
isPrimary: boolean ,
}
,
]
,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
}
,
zones:
[
string ,
]
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Redis_Update (updated)
Description Update an existing Redis cache.
Reference Link ¶

⚶ Changes

{
  "#id": "Redis_Update",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    },
    {
      "#name": "name",
      "Description": {
        "new": "The name of the RedisResource",
        "old": "The name of the Redis cache."
      }
    },
    {
      "parameters": {
        "$properties": {
          "properties": [
            {
              "sku": [
                {
                  "#name": "name",
                  "Enum": {
                    "new": [
                      [
                        "Basic",
                        "The well known 'Basic' SKU for Azure Cache for Redis. Basic SKU does not have an availability SLA."
                      ],
                      [
                        "Standard",
                        "The well known 'Standard' SKU for Azure Cache for Redis. Standard SKU has an availability SLA."
                      ],
                      [
                        "Premium",
                        "The well known 'Premium' SKU for Azure Cache for Redis. Premium SKU has an availability SLA, and higher performance tiers and more features compared with Standard SKU."
                      ]
                    ],
                    "old": [
                      [
                        "Basic",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ],
                      [
                        "Premium",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "family",
                  "Enum": {
                    "new": [
                      [
                        "C",
                        "The SKU family to use - must be 'C' for Basic/Standard SKU redis caches."
                      ],
                      [
                        "P",
                        "The SKU family to use - must be 'P' for Premium SKU redis caches."
                      ]
                    ],
                    "old": [
                      [
                        "C",
                        ""
                      ],
                      [
                        "P",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "properties": [
            {
              "#name": "provisioningState",
              "Enum": {
                "new": [
                  [
                    "Creating",
                    "A create operation is in progress."
                  ],
                  [
                    "Deleting",
                    "A delete operation is in progress."
                  ],
                  [
                    "Disabled",
                    "The cache is disabled and cannot be used."
                  ],
                  [
                    "Failed",
                    "An operation such as create or update failed. If you failed to create the cache it will not be in a usable state, so you should delete and recreate it."
                  ],
                  [
                    "Linking",
                    "Georeplication link is in progress"
                  ],
                  [
                    "Provisioning",
                    "An operation is in progress"
                  ],
                  [
                    "RecoveringScaleFailure",
                    "A scaling operation encountered an error and recovery is in progress."
                  ],
                  [
                    "Scaling",
                    "A scaling operation is in progress"
                  ],
                  [
                    "Succeeded",
                    "The most recent operation successfully completed"
                  ],
                  [
                    "Unlinking",
                    "Georeplication unlink is in progress"
                  ],
                  [
                    "Unprovisioning",
                    "The cache may be being disabled"
                  ],
                  [
                    "Updating",
                    "An update operation is in progress."
                  ],
                  [
                    "ConfiguringAAD",
                    "An AAD configuration update operation is in progress."
                  ]
                ],
                "old": [
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Linking",
                    ""
                  ],
                  [
                    "Provisioning",
                    ""
                  ],
                  [
                    "RecoveringScaleFailure",
                    ""
                  ],
                  [
                    "Scaling",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Unlinking",
                    ""
                  ],
                  [
                    "Unprovisioning",
                    ""
                  ],
                  [
                    "Updating",
                    ""
                  ],
                  [
                    "ConfiguringAAD",
                    ""
                  ]
                ]
              }
            },
            {
              "privateEndpointConnections": {
                "Description": {
                  "new": "The private endpoint connection resource.",
                  "old": "The Private Endpoint Connection resource."
                },
                "$properties": {
                  "properties": [
                    {
                      "@added_4051a3a74faa46b29c602990c54640a3": {
                        "#name": "groupIds",
                        "Description": "The group ids for the private endpoint resource.",
                        "Required": false,
                        "Type": "array",
                        "$items": {
                          "Type": "string"
                        }
                      }
                    },
                    {
                      "#name": "privateEndpoint",
                      "Description": {
                        "new": "The private endpoint resource.",
                        "old": "The resource of private end point."
                      },
                      "$properties": [
                        {
                          "#name": "id",
                          "Description": {
                            "new": "The ARM identifier for private endpoint.",
                            "old": "The ARM identifier for Private Endpoint"
                          }
                        }
                      ]
                    }
                  ]
                }
              }
            }
          ]
        },
        {
          "#name": "zones",
          "Description": {
            "new": "The availability zones.",
            "old": "A list of availability zones denoting where the resource needs to come from."
          }
        },
        {
          "#name": "identity",
          "Description": {
            "new": "The managed service identities assigned to this resource.",
            "old": "The identity of the resource."
          }
        }
      ]
    },
    "202": {
      "$properties": [
        {
          "properties": [
            {
              "#name": "provisioningState",
              "Enum": {
                "new": [
                  [
                    "Creating",
                    "A create operation is in progress."
                  ],
                  [
                    "Deleting",
                    "A delete operation is in progress."
                  ],
                  [
                    "Disabled",
                    "The cache is disabled and cannot be used."
                  ],
                  [
                    "Failed",
                    "An operation such as create or update failed. If you failed to create the cache it will not be in a usable state, so you should delete and recreate it."
                  ],
                  [
                    "Linking",
                    "Georeplication link is in progress"
                  ],
                  [
                    "Provisioning",
                    "An operation is in progress"
                  ],
                  [
                    "RecoveringScaleFailure",
                    "A scaling operation encountered an error and recovery is in progress."
                  ],
                  [
                    "Scaling",
                    "A scaling operation is in progress"
                  ],
                  [
                    "Succeeded",
                    "The most recent operation successfully completed"
                  ],
                  [
                    "Unlinking",
                    "Georeplication unlink is in progress"
                  ],
                  [
                    "Unprovisioning",
                    "The cache may be being disabled"
                  ],
                  [
                    "Updating",
                    "An update operation is in progress."
                  ],
                  [
                    "ConfiguringAAD",
                    "An AAD configuration update operation is in progress."
                  ]
                ],
                "old": [
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Linking",
                    ""
                  ],
                  [
                    "Provisioning",
                    ""
                  ],
                  [
                    "RecoveringScaleFailure",
                    ""
                  ],
                  [
                    "Scaling",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Unlinking",
                    ""
                  ],
                  [
                    "Unprovisioning",
                    ""
                  ],
                  [
                    "Updating",
                    ""
                  ],
                  [
                    "ConfiguringAAD",
                    ""
                  ]
                ]
              }
            },
            {
              "privateEndpointConnections": {
                "Description": {
                  "new": "The private endpoint connection resource.",
                  "old": "The Private Endpoint Connection resource."
                },
                "$properties": {
                  "properties": [
                    {
                      "@added_23dd65f3ff274867be1093aa6f5799b5": {
                        "#name": "groupIds",
                        "Description": "The group ids for the private endpoint resource.",
                        "Required": false,
                        "Type": "array",
                        "$items": {
                          "Type": "string"
                        }
                      }
                    },
                    {
                      "#name": "privateEndpoint",
                      "Description": {
                        "new": "The private endpoint resource.",
                        "old": "The resource of private end point."
                      },
                      "$properties": [
                        {
                          "#name": "id",
                          "Description": {
                            "new": "The ARM identifier for private endpoint.",
                            "old": "The ARM identifier for Private Endpoint"
                          }
                        }
                      ]
                    }
                  ]
                }
              }
            }
          ]
        },
        {
          "#name": "zones",
          "Description": {
            "new": "The availability zones.",
            "old": "A list of availability zones denoting where the resource needs to come from."
          }
        },
        {
          "#name": "identity",
          "Description": {
            "new": "The managed service identities assigned to this resource.",
            "old": "The identity of the resource."
          }
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
name: string ,
parameters:
{
properties:
{
sku:
{
name: enum ,
family: enum ,
capacity: integer ,
}
,
}
,
tags: object ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
hostName: string ,
port: integer ,
sslPort: integer ,
accessKeys:
{
primaryKey: string ,
secondaryKey: string ,
}
,
linkedServers:
[
{
id: string ,
}
,
]
,
instances:
[
{
sslPort: integer ,
nonSslPort: integer ,
zone: string ,
shardId: integer ,
isMaster: boolean ,
isPrimary: boolean ,
}
,
]
,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
}
,
zones:
[
string ,
]
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
properties:
{
provisioningState: enum ,
hostName: string ,
port: integer ,
sslPort: integer ,
accessKeys:
{
primaryKey: string ,
secondaryKey: string ,
}
,
linkedServers:
[
{
id: string ,
}
,
]
,
instances:
[
{
sslPort: integer ,
nonSslPort: integer ,
zone: string ,
shardId: integer ,
isMaster: boolean ,
isPrimary: boolean ,
}
,
]
,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
}
,
zones:
[
string ,
]
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Redis_Delete (updated)
Description Deletes a Redis cache.
Reference Link ¶

⚶ Changes

{
  "#id": "Redis_Delete",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    },
    {
      "#name": "name",
      "Description": {
        "new": "The name of the RedisResource",
        "old": "The name of the Redis cache."
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
name: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
AccessPolicy_List (updated)
Description Gets the list of access policies associated with this redis cache
Reference Link ¶

⚶ Changes

{
  "#id": "AccessPolicy_List",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The RedisCacheAccessPolicy items on this page",
            "old": "List of access policies (with properties) of a Redis cache."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "provisioningState",
                  "Enum": {
                    "new": [
                      [
                        "Updating",
                        "An operation is in progress."
                      ],
                      [
                        "Succeeded",
                        "The operation succeeded."
                      ],
                      [
                        "Deleting",
                        "A delete operation is in progress."
                      ],
                      [
                        "Deleted",
                        "The access policy is considered deleted, if it still exists."
                      ],
                      [
                        "Canceled",
                        "The operation was canceled. Access policies may be in a partially updated state. Update them again to have a well-defined state."
                      ],
                      [
                        "Failed",
                        "The operation failed. Access policies may be in a partially updated state. Update them again to have a well-defined state."
                      ]
                    ],
                    "old": [
                      [
                        "Updating",
                        ""
                      ],
                      [
                        "Succeeded",
                        ""
                      ],
                      [
                        "Deleting",
                        ""
                      ],
                      [
                        "Deleted",
                        ""
                      ],
                      [
                        "Canceled",
                        ""
                      ],
                      [
                        "Failed",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "type",
                  "Enum": {
                    "new": [
                      [
                        "Custom",
                        "User-configurable access policy, using the redis access policy authoring language"
                      ],
                      [
                        "BuiltIn",
                        "Built-in or well-known access policies, whose policy is not configurable."
                      ]
                    ],
                    "old": [
                      [
                        "Custom",
                        ""
                      ],
                      [
                        "BuiltIn",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link for next set."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicies
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
cacheName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
type: enum ,
permissions: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
AccessPolicy_Get (updated)
Description Gets the detailed information about an access policy of a redis cache
Reference Link ¶

⚶ Changes

{
  "#id": "AccessPolicy_Get",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Updating",
                  "An operation is in progress."
                ],
                [
                  "Succeeded",
                  "The operation succeeded."
                ],
                [
                  "Deleting",
                  "A delete operation is in progress."
                ],
                [
                  "Deleted",
                  "The access policy is considered deleted, if it still exists."
                ],
                [
                  "Canceled",
                  "The operation was canceled. Access policies may be in a partially updated state. Update them again to have a well-defined state."
                ],
                [
                  "Failed",
                  "The operation failed. Access policies may be in a partially updated state. Update them again to have a well-defined state."
                ]
              ],
              "old": [
                [
                  "Updating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Deleted",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "type",
            "Enum": {
              "new": [
                [
                  "Custom",
                  "User-configurable access policy, using the redis access policy authoring language"
                ],
                [
                  "BuiltIn",
                  "Built-in or well-known access policies, whose policy is not configurable."
                ]
              ],
              "old": [
                [
                  "Custom",
                  ""
                ],
                [
                  "BuiltIn",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicies/{accessPolicyName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
cacheName: string ,
accessPolicyName: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
type: enum ,
permissions: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
AccessPolicy_CreateUpdate (updated)
Description Adds an access policy to the redis cache
Reference Link ¶

⚶ Changes

{
  "#id": "AccessPolicy_CreateUpdate",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    },
    {
      "parameters": {
        "$properties": {
          "properties": [
            {
              "#name": "provisioningState",
              "Enum": {
                "new": [
                  [
                    "Updating",
                    "An operation is in progress."
                  ],
                  [
                    "Succeeded",
                    "The operation succeeded."
                  ],
                  [
                    "Deleting",
                    "A delete operation is in progress."
                  ],
                  [
                    "Deleted",
                    "The access policy is considered deleted, if it still exists."
                  ],
                  [
                    "Canceled",
                    "The operation was canceled. Access policies may be in a partially updated state. Update them again to have a well-defined state."
                  ],
                  [
                    "Failed",
                    "The operation failed. Access policies may be in a partially updated state. Update them again to have a well-defined state."
                  ]
                ],
                "old": [
                  [
                    "Updating",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Deleted",
                    ""
                  ],
                  [
                    "Canceled",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "type",
              "Enum": {
                "new": [
                  [
                    "Custom",
                    "User-configurable access policy, using the redis access policy authoring language"
                  ],
                  [
                    "BuiltIn",
                    "Built-in or well-known access policies, whose policy is not configurable."
                  ]
                ],
                "old": [
                  [
                    "Custom",
                    ""
                  ],
                  [
                    "BuiltIn",
                    ""
                  ]
                ]
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Updating",
                  "An operation is in progress."
                ],
                [
                  "Succeeded",
                  "The operation succeeded."
                ],
                [
                  "Deleting",
                  "A delete operation is in progress."
                ],
                [
                  "Deleted",
                  "The access policy is considered deleted, if it still exists."
                ],
                [
                  "Canceled",
                  "The operation was canceled. Access policies may be in a partially updated state. Update them again to have a well-defined state."
                ],
                [
                  "Failed",
                  "The operation failed. Access policies may be in a partially updated state. Update them again to have a well-defined state."
                ]
              ],
              "old": [
                [
                  "Updating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Deleted",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "type",
            "Enum": {
              "new": [
                [
                  "Custom",
                  "User-configurable access policy, using the redis access policy authoring language"
                ],
                [
                  "BuiltIn",
                  "Built-in or well-known access policies, whose policy is not configurable."
                ]
              ],
              "old": [
                [
                  "Custom",
                  ""
                ],
                [
                  "BuiltIn",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Updating",
                  "An operation is in progress."
                ],
                [
                  "Succeeded",
                  "The operation succeeded."
                ],
                [
                  "Deleting",
                  "A delete operation is in progress."
                ],
                [
                  "Deleted",
                  "The access policy is considered deleted, if it still exists."
                ],
                [
                  "Canceled",
                  "The operation was canceled. Access policies may be in a partially updated state. Update them again to have a well-defined state."
                ],
                [
                  "Failed",
                  "The operation failed. Access policies may be in a partially updated state. Update them again to have a well-defined state."
                ]
              ],
              "old": [
                [
                  "Updating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Deleted",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "type",
            "Enum": {
              "new": [
                [
                  "Custom",
                  "User-configurable access policy, using the redis access policy authoring language"
                ],
                [
                  "BuiltIn",
                  "Built-in or well-known access policies, whose policy is not configurable."
                ]
              ],
              "old": [
                [
                  "Custom",
                  ""
                ],
                [
                  "BuiltIn",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicies/{accessPolicyName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
cacheName: string ,
accessPolicyName: string ,
parameters:
{
properties:
{
provisioningState: enum ,
type: enum ,
permissions: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
type: enum ,
permissions: string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
retry-after: integer ,
}
,
$schema:
{
properties:
{
provisioningState: enum ,
type: enum ,
permissions: string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
AccessPolicy_Delete (updated)
Description Deletes the access policy from a redis cache
Reference Link ¶

⚶ Changes

{
  "#id": "AccessPolicy_Delete",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "@added_f0cca87b3ae94315895dc504e54d8c50": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicies/{accessPolicyName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
cacheName: string ,
accessPolicyName: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
AccessPolicyAssignment_List (updated)
Description Gets the list of access policy assignments associated with this redis cache
Reference Link ¶

⚶ Changes

{
  "#id": "AccessPolicyAssignment_List",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The RedisCacheAccessPolicyAssignment items on this page",
            "old": "List of access policies assignments (with properties) of a Redis cache."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "provisioningState",
                  "Enum": {
                    "new": [
                      [
                        "Updating",
                        "The access policy assignments are being updated"
                      ],
                      [
                        "Succeeded",
                        "The access policy assignments were successfully updated"
                      ],
                      [
                        "Deleting",
                        "The access policy assignments are being deleted"
                      ],
                      [
                        "Deleted",
                        "The access policy assignments are considered deleted, meaning no custom access policies are applied."
                      ],
                      [
                        "Canceled",
                        "The operation was canceled. Access policy assignments may be in a partially updated state. Update them again to have a well-defined state."
                      ],
                      [
                        "Failed",
                        "The operation failed. Access policy assignments may be in a partially updated state. Update them again to have a well-defined state."
                      ]
                    ],
                    "old": [
                      [
                        "Updating",
                        ""
                      ],
                      [
                        "Succeeded",
                        ""
                      ],
                      [
                        "Deleting",
                        ""
                      ],
                      [
                        "Deleted",
                        ""
                      ],
                      [
                        "Canceled",
                        ""
                      ],
                      [
                        "Failed",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link for next set."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicyAssignments
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
cacheName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
objectId: string ,
objectIdAlias: string ,
accessPolicyName: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
AccessPolicyAssignment_Get (updated)
Description Gets the list of assignments for an access policy of a redis cache
Reference Link ¶

⚶ Changes

{
  "#id": "AccessPolicyAssignment_Get",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Updating",
                  "The access policy assignments are being updated"
                ],
                [
                  "Succeeded",
                  "The access policy assignments were successfully updated"
                ],
                [
                  "Deleting",
                  "The access policy assignments are being deleted"
                ],
                [
                  "Deleted",
                  "The access policy assignments are considered deleted, meaning no custom access policies are applied."
                ],
                [
                  "Canceled",
                  "The operation was canceled. Access policy assignments may be in a partially updated state. Update them again to have a well-defined state."
                ],
                [
                  "Failed",
                  "The operation failed. Access policy assignments may be in a partially updated state. Update them again to have a well-defined state."
                ]
              ],
              "old": [
                [
                  "Updating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Deleted",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicyAssignments/{accessPolicyAssignmentName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
cacheName: string ,
accessPolicyAssignmentName: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
objectId: string ,
objectIdAlias: string ,
accessPolicyName: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
AccessPolicyAssignment_CreateUpdate (updated)
Description Adds the access policy assignment to the specified users
Reference Link ¶

⚶ Changes

{
  "#id": "AccessPolicyAssignment_CreateUpdate",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    },
    {
      "parameters": {
        "$properties": {
          "properties": [
            {
              "#name": "provisioningState",
              "Enum": {
                "new": [
                  [
                    "Updating",
                    "The access policy assignments are being updated"
                  ],
                  [
                    "Succeeded",
                    "The access policy assignments were successfully updated"
                  ],
                  [
                    "Deleting",
                    "The access policy assignments are being deleted"
                  ],
                  [
                    "Deleted",
                    "The access policy assignments are considered deleted, meaning no custom access policies are applied."
                  ],
                  [
                    "Canceled",
                    "The operation was canceled. Access policy assignments may be in a partially updated state. Update them again to have a well-defined state."
                  ],
                  [
                    "Failed",
                    "The operation failed. Access policy assignments may be in a partially updated state. Update them again to have a well-defined state."
                  ]
                ],
                "old": [
                  [
                    "Updating",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Deleted",
                    ""
                  ],
                  [
                    "Canceled",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ]
                ]
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Updating",
                  "The access policy assignments are being updated"
                ],
                [
                  "Succeeded",
                  "The access policy assignments were successfully updated"
                ],
                [
                  "Deleting",
                  "The access policy assignments are being deleted"
                ],
                [
                  "Deleted",
                  "The access policy assignments are considered deleted, meaning no custom access policies are applied."
                ],
                [
                  "Canceled",
                  "The operation was canceled. Access policy assignments may be in a partially updated state. Update them again to have a well-defined state."
                ],
                [
                  "Failed",
                  "The operation failed. Access policy assignments may be in a partially updated state. Update them again to have a well-defined state."
                ]
              ],
              "old": [
                [
                  "Updating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Deleted",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Updating",
                  "The access policy assignments are being updated"
                ],
                [
                  "Succeeded",
                  "The access policy assignments were successfully updated"
                ],
                [
                  "Deleting",
                  "The access policy assignments are being deleted"
                ],
                [
                  "Deleted",
                  "The access policy assignments are considered deleted, meaning no custom access policies are applied."
                ],
                [
                  "Canceled",
                  "The operation was canceled. Access policy assignments may be in a partially updated state. Update them again to have a well-defined state."
                ],
                [
                  "Failed",
                  "The operation failed. Access policy assignments may be in a partially updated state. Update them again to have a well-defined state."
                ]
              ],
              "old": [
                [
                  "Updating",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Deleted",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicyAssignments/{accessPolicyAssignmentName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
cacheName: string ,
accessPolicyAssignmentName: string ,
parameters:
{
properties:
{
provisioningState: enum ,
objectId: string ,
objectIdAlias: string ,
accessPolicyName: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
objectId: string ,
objectIdAlias: string ,
accessPolicyName: string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
retry-after: integer ,
}
,
$schema:
{
properties:
{
provisioningState: enum ,
objectId: string ,
objectIdAlias: string ,
accessPolicyName: string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
AccessPolicyAssignment_Delete (updated)
Description Deletes the access policy assignment from a redis cache
Reference Link ¶

⚶ Changes

{
  "#id": "AccessPolicyAssignment_Delete",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "@added_a925d439a45544d08431a6bd13ea79b3": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicyAssignments/{accessPolicyAssignmentName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
cacheName: string ,
accessPolicyAssignmentName: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Redis_ExportData (updated)
Description Export data from the redis cache to blobs in a container.
Reference Link ¶

⚶ Changes

{
  "#id": "Redis_ExportData",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    },
    {
      "#name": "name",
      "Description": {
        "new": "The name of the RedisResource",
        "old": "The name of the Redis cache."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/export
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
name: string ,
parameters:
{
format: string ,
prefix: string ,
container: string ,
preferred-data-archive-auth-method: string ,
storage-subscription-id: string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
FirewallRules_List (updated)
Description Gets all firewall rules in the specified redis cache.
Reference Link ¶

⚶ Changes

{
  "#id": "FirewallRules_List",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a RedisFirewallRule list operation.",
        "old": "The response of list firewall rules Redis operation."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The RedisFirewallRule items on this page",
            "old": "Results of the list firewall rules operation."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link for next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
cacheName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
startIP: string ,
endIP: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
FirewallRules_Get (updated)
Description Gets a single firewall rule in a specified redis cache.
Reference Link ¶

⚶ Changes

{
  "#id": "FirewallRules_Get",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules/{ruleName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
cacheName: string ,
ruleName: string ,
}

⚐ Response (200)

{
properties:
{
startIP: string ,
endIP: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
FirewallRules_CreateOrUpdate (updated)
Description Create or update a redis cache firewall rule
Reference Link ¶

⚶ Changes

{
  "#id": "FirewallRules_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    }
  ]
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules/{ruleName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
cacheName: string ,
ruleName: string ,
parameters:
{
properties:
{
startIP: string ,
endIP: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
startIP: string ,
endIP: string ,
}
,
}

⚐ Response (201)

{
properties:
{
startIP: string ,
endIP: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
FirewallRules_Delete (updated)
Description Deletes a single firewall rule in a specified redis cache.
Reference Link ¶

⚶ Changes

{
  "#id": "FirewallRules_Delete",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules/{ruleName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
cacheName: string ,
ruleName: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Redis_FlushCache (updated)
Description Deletes all of the keys in a cache.
Reference Link ¶

⚶ Changes

{
  "#id": "Redis_FlushCache",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    }
  ],
  "$responses": {
    "200": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "URL to query for the status of the operation."
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "URL to query for the status of the operation."
        }
      }
    ],
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "URL to query for the status of the operation."
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "URL to query for the status of the operation."
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/flush
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
cacheName: string ,
}

⚐ Response (200)

{
$headers:
{
azure-asyncoperation: string ,
location: string ,
}
,
$schema:
{
id: string ,
name: string ,
status: string ,
percentComplete: number ,
startTime: string ,
endTime: string ,
operations:
[
{
id: string ,
name: string ,
status: string ,
percentComplete: number ,
startTime: string ,
endTime: string ,
operations:
[
string ,
]
,
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
,
]
,
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Redis_ForceReboot (updated)
Description Reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss.
Reference Link ¶

⚶ Changes

{
  "#id": "Redis_ForceReboot",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    },
    {
      "#name": "name",
      "Description": {
        "new": "The name of the RedisResource",
        "old": "The name of the Redis cache."
      }
    },
    {
      "parameters": {
        "$properties": [
          {
            "#name": "rebootType",
            "Enum": {
              "new": [
                [
                  "PrimaryNode",
                  "Reboot the primary nodes used for redis write operations. (This may trigger role changes.)"
                ],
                [
                  "SecondaryNode",
                  "Reboot only the secondary or replica nodes"
                ],
                [
                  "AllNodes",
                  "Reboot all nodes, not guaranteed to happen simultaneously."
                ]
              ],
              "old": [
                [
                  "PrimaryNode",
                  ""
                ],
                [
                  "SecondaryNode",
                  ""
                ],
                [
                  "AllNodes",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/forceReboot
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
name: string ,
parameters:
{
rebootType: enum ,
shardId: integer ,
ports:
[
integer ,
]
,
}
,
}

⚐ Response (200)

{
message: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Redis_ImportData (updated)
Description Import data into Redis cache.
Reference Link ¶

⚶ Changes

{
  "#id": "Redis_ImportData",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    },
    {
      "#name": "name",
      "Description": {
        "new": "The name of the RedisResource",
        "old": "The name of the Redis cache."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/import
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
name: string ,
parameters:
{
format: string ,
files:
[
string ,
]
,
preferred-data-archive-auth-method: string ,
storage-subscription-id: string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
LinkedServer_List (updated)
Description Gets the list of linked servers associated with this redis cache (requires Premium SKU).
Reference Link ¶

⚶ Changes

{
  "#id": "LinkedServer_List",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The RedisLinkedServerWithProperties items on this page",
            "old": "List of linked servers (with properties) of a Redis cache."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link for next set."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/linkedServers
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
name: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
LinkedServer_Get (updated)
Description Gets the detailed information about a linked server of a redis cache (requires Premium SKU).
Reference Link ¶

⚶ Changes

{
  "#id": "LinkedServer_Get",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    },
    {
      "#name": "linkedServerName",
      "Description": {
        "new": "The name of the RedisLinkedServerWithProperties",
        "old": "The name of the linked server."
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/linkedServers/{linkedServerName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
name: string ,
linkedServerName: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
LinkedServer_Create (updated)
Description Adds a linked server to the Redis cache (requires Premium SKU).
Reference Link ¶

⚶ Changes

{
  "#id": "LinkedServer_Create",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    },
    {
      "#name": "name",
      "Description": {
        "new": "The name of the redis cache.",
        "old": "The name of the Redis cache."
      }
    },
    {
      "#name": "linkedServerName",
      "Description": {
        "new": "The name of the RedisLinkedServerWithProperties",
        "old": "The name of the linked server that is being added to the Redis cache."
      }
    },
    {
      "parameters": {
        "$properties": {
          "properties": [
            {
              "#name": "serverRole",
              "Enum": {
                "new": [
                  [
                    "Primary",
                    "The linked server is in the writable primary role"
                  ],
                  [
                    "Secondary",
                    "The linked server is in the read-only replica role"
                  ]
                ],
                "old": [
                  [
                    "Primary",
                    ""
                  ],
                  [
                    "Secondary",
                    ""
                  ]
                ]
              }
            }
          ]
        }
      }
    }
  ]
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/linkedServers/{linkedServerName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
name: string ,
linkedServerName: string ,
parameters:
{
properties:
{
linkedRedisCacheId: string ,
linkedRedisCacheLocation: string ,
serverRole: enum ,
geoReplicatedPrimaryHostName: string ,
primaryHostName: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
}
,
$schema:
{
properties:
{
provisioningState: string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
LinkedServer_Delete (updated)
Description Deletes the linked server from a redis cache (requires Premium SKU).
Reference Link ¶

⚶ Changes

{
  "#id": "LinkedServer_Delete",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    },
    {
      "#name": "linkedServerName",
      "Description": {
        "new": "The name of the RedisLinkedServerWithProperties",
        "old": "The name of the linked server that is being added to the Redis cache."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "@added_1d7a4f01da2743fe9def9e4b9ae38a78": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/linkedServers/{linkedServerName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
name: string ,
linkedServerName: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Redis_ListKeys (updated)
Description Retrieve a Redis cache's access keys. This operation requires write permission to the cache resource.
Reference Link ¶

⚶ Changes

{
  "#id": "Redis_ListKeys",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    },
    {
      "#name": "name",
      "Description": {
        "new": "The name of the RedisResource",
        "old": "The name of the Redis cache."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/listKeys
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
name: string ,
}

⚐ Response (200)

{
primaryKey: string ,
secondaryKey: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Redis_ListUpgradeNotifications (updated)
Description [Deprecated] Gets any upgrade notifications for a Redis cache.
Reference Link ¶

⚶ Changes

{
  "#id": "Redis_ListUpgradeNotifications",
  "Description": {
    "new": "[Deprecated] Gets any upgrade notifications for a Redis cache.",
    "old": "Gets any upgrade notifications for a Redis cache."
  },
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    },
    {
      "#name": "name",
      "Description": {
        "new": "The name of the RedisResource",
        "old": "The name of the Redis cache."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The UpgradeNotification items on this page",
            "old": "List of all notifications."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link for next set of notifications."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/listUpgradeNotifications
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
name: string ,
history: number ,
}

⚐ Response (200)

{
value:
[
{
name: string ,
timestamp: string ,
upsellNotification: object ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PatchSchedules_ListByRedisResource (updated)
Description Gets all patch schedules in the specified redis cache (there is only one).
Reference Link ¶

⚶ Changes

{
  "#id": "PatchSchedules_ListByRedisResource",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a RedisPatchSchedule list operation.",
        "old": "The response of list patch schedules Redis operation."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The RedisPatchSchedule items on this page",
            "old": "Results of the list patch schedules operation."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "scheduleEntries": {
                    "$properties": [
                      {
                        "#name": "dayOfWeek",
                        "Enum": {
                          "new": [
                            [
                              "Monday",
                              ""
                            ],
                            [
                              "Tuesday",
                              ""
                            ],
                            [
                              "Wednesday",
                              ""
                            ],
                            [
                              "Thursday",
                              ""
                            ],
                            [
                              "Friday",
                              ""
                            ],
                            [
                              "Saturday",
                              ""
                            ],
                            [
                              "Sunday",
                              ""
                            ],
                            [
                              "Everyday",
                              "As a convenience, 'Everyday' is also accepted and means the same as specifying all days of the week."
                            ],
                            [
                              "Weekend",
                              "As a convenience, 'Weekend' is also accepted and means the same as specifying Saturday and Sunday."
                            ]
                          ],
                          "old": [
                            [
                              "Monday",
                              ""
                            ],
                            [
                              "Tuesday",
                              ""
                            ],
                            [
                              "Wednesday",
                              ""
                            ],
                            [
                              "Thursday",
                              ""
                            ],
                            [
                              "Friday",
                              ""
                            ],
                            [
                              "Saturday",
                              ""
                            ],
                            [
                              "Sunday",
                              ""
                            ],
                            [
                              "Everyday",
                              ""
                            ],
                            [
                              "Weekend",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "#name": "maintenanceWindow",
                        "Description": {
                          "new": "ISO8601 timespan specifying how much time cache patching can take.",
                          "old": "ISO8601 timespan specifying how much time cache patching can take. "
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link for next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/patchSchedules
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
cacheName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
scheduleEntries:
[
{
dayOfWeek: enum ,
startHourUtc: integer ,
maintenanceWindow: string ,
}
,
]
,
}
,
location: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PatchSchedules_Get (updated)
Description Gets the patching schedule of a redis cache.
Reference Link ¶

⚶ Changes

{
  "#id": "PatchSchedules_Get",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    },
    {
      "#name": "default",
      "Description": {
        "new": "The name of the RedisPatchSchedule",
        "old": "Default string modeled as parameter for auto generation to work correctly."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "scheduleEntries": {
              "$properties": [
                {
                  "#name": "dayOfWeek",
                  "Enum": {
                    "new": [
                      [
                        "Monday",
                        ""
                      ],
                      [
                        "Tuesday",
                        ""
                      ],
                      [
                        "Wednesday",
                        ""
                      ],
                      [
                        "Thursday",
                        ""
                      ],
                      [
                        "Friday",
                        ""
                      ],
                      [
                        "Saturday",
                        ""
                      ],
                      [
                        "Sunday",
                        ""
                      ],
                      [
                        "Everyday",
                        "As a convenience, 'Everyday' is also accepted and means the same as specifying all days of the week."
                      ],
                      [
                        "Weekend",
                        "As a convenience, 'Weekend' is also accepted and means the same as specifying Saturday and Sunday."
                      ]
                    ],
                    "old": [
                      [
                        "Monday",
                        ""
                      ],
                      [
                        "Tuesday",
                        ""
                      ],
                      [
                        "Wednesday",
                        ""
                      ],
                      [
                        "Thursday",
                        ""
                      ],
                      [
                        "Friday",
                        ""
                      ],
                      [
                        "Saturday",
                        ""
                      ],
                      [
                        "Sunday",
                        ""
                      ],
                      [
                        "Everyday",
                        ""
                      ],
                      [
                        "Weekend",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "maintenanceWindow",
                  "Description": {
                    "new": "ISO8601 timespan specifying how much time cache patching can take.",
                    "old": "ISO8601 timespan specifying how much time cache patching can take. "
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/patchSchedules/{default}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
name: string ,
default: string ,
}

⚐ Response (200)

{
properties:
{
scheduleEntries:
[
{
dayOfWeek: enum ,
startHourUtc: integer ,
maintenanceWindow: string ,
}
,
]
,
}
,
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PatchSchedules_CreateOrUpdate (updated)
Description Create or replace the patching schedule for Redis cache.
Reference Link ¶

⚶ Changes

{
  "#id": "PatchSchedules_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    },
    {
      "#name": "name",
      "Description": {
        "new": "The name of the redis cache.",
        "old": "The name of the Redis cache."
      }
    },
    {
      "#name": "default",
      "Description": {
        "new": "The name of the RedisPatchSchedule",
        "old": "Default string modeled as parameter for auto generation to work correctly."
      }
    },
    {
      "parameters": {
        "$properties": {
          "properties": [
            {
              "scheduleEntries": {
                "$properties": [
                  {
                    "#name": "dayOfWeek",
                    "Enum": {
                      "new": [
                        [
                          "Monday",
                          ""
                        ],
                        [
                          "Tuesday",
                          ""
                        ],
                        [
                          "Wednesday",
                          ""
                        ],
                        [
                          "Thursday",
                          ""
                        ],
                        [
                          "Friday",
                          ""
                        ],
                        [
                          "Saturday",
                          ""
                        ],
                        [
                          "Sunday",
                          ""
                        ],
                        [
                          "Everyday",
                          "As a convenience, 'Everyday' is also accepted and means the same as specifying all days of the week."
                        ],
                        [
                          "Weekend",
                          "As a convenience, 'Weekend' is also accepted and means the same as specifying Saturday and Sunday."
                        ]
                      ],
                      "old": [
                        [
                          "Monday",
                          ""
                        ],
                        [
                          "Tuesday",
                          ""
                        ],
                        [
                          "Wednesday",
                          ""
                        ],
                        [
                          "Thursday",
                          ""
                        ],
                        [
                          "Friday",
                          ""
                        ],
                        [
                          "Saturday",
                          ""
                        ],
                        [
                          "Sunday",
                          ""
                        ],
                        [
                          "Everyday",
                          ""
                        ],
                        [
                          "Weekend",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "maintenanceWindow",
                    "Description": {
                      "new": "ISO8601 timespan specifying how much time cache patching can take.",
                      "old": "ISO8601 timespan specifying how much time cache patching can take. "
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "scheduleEntries": {
              "$properties": [
                {
                  "#name": "dayOfWeek",
                  "Enum": {
                    "new": [
                      [
                        "Monday",
                        ""
                      ],
                      [
                        "Tuesday",
                        ""
                      ],
                      [
                        "Wednesday",
                        ""
                      ],
                      [
                        "Thursday",
                        ""
                      ],
                      [
                        "Friday",
                        ""
                      ],
                      [
                        "Saturday",
                        ""
                      ],
                      [
                        "Sunday",
                        ""
                      ],
                      [
                        "Everyday",
                        "As a convenience, 'Everyday' is also accepted and means the same as specifying all days of the week."
                      ],
                      [
                        "Weekend",
                        "As a convenience, 'Weekend' is also accepted and means the same as specifying Saturday and Sunday."
                      ]
                    ],
                    "old": [
                      [
                        "Monday",
                        ""
                      ],
                      [
                        "Tuesday",
                        ""
                      ],
                      [
                        "Wednesday",
                        ""
                      ],
                      [
                        "Thursday",
                        ""
                      ],
                      [
                        "Friday",
                        ""
                      ],
                      [
                        "Saturday",
                        ""
                      ],
                      [
                        "Sunday",
                        ""
                      ],
                      [
                        "Everyday",
                        ""
                      ],
                      [
                        "Weekend",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "maintenanceWindow",
                  "Description": {
                    "new": "ISO8601 timespan specifying how much time cache patching can take.",
                    "old": "ISO8601 timespan specifying how much time cache patching can take. "
                  }
                }
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "scheduleEntries": {
              "$properties": [
                {
                  "#name": "dayOfWeek",
                  "Enum": {
                    "new": [
                      [
                        "Monday",
                        ""
                      ],
                      [
                        "Tuesday",
                        ""
                      ],
                      [
                        "Wednesday",
                        ""
                      ],
                      [
                        "Thursday",
                        ""
                      ],
                      [
                        "Friday",
                        ""
                      ],
                      [
                        "Saturday",
                        ""
                      ],
                      [
                        "Sunday",
                        ""
                      ],
                      [
                        "Everyday",
                        "As a convenience, 'Everyday' is also accepted and means the same as specifying all days of the week."
                      ],
                      [
                        "Weekend",
                        "As a convenience, 'Weekend' is also accepted and means the same as specifying Saturday and Sunday."
                      ]
                    ],
                    "old": [
                      [
                        "Monday",
                        ""
                      ],
                      [
                        "Tuesday",
                        ""
                      ],
                      [
                        "Wednesday",
                        ""
                      ],
                      [
                        "Thursday",
                        ""
                      ],
                      [
                        "Friday",
                        ""
                      ],
                      [
                        "Saturday",
                        ""
                      ],
                      [
                        "Sunday",
                        ""
                      ],
                      [
                        "Everyday",
                        ""
                      ],
                      [
                        "Weekend",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "maintenanceWindow",
                  "Description": {
                    "new": "ISO8601 timespan specifying how much time cache patching can take.",
                    "old": "ISO8601 timespan specifying how much time cache patching can take. "
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/patchSchedules/{default}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
name: string ,
default: string ,
parameters:
{
properties:
{
scheduleEntries:
[
{
dayOfWeek: enum ,
startHourUtc: integer ,
maintenanceWindow: string ,
}
,
]
,
}
,
location: string ,
}
,
}

⚐ Response (200)

{
properties:
{
scheduleEntries:
[
{
dayOfWeek: enum ,
startHourUtc: integer ,
maintenanceWindow: string ,
}
,
]
,
}
,
location: string ,
}

⚐ Response (201)

{
properties:
{
scheduleEntries:
[
{
dayOfWeek: enum ,
startHourUtc: integer ,
maintenanceWindow: string ,
}
,
]
,
}
,
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PatchSchedules_Delete (updated)
Description Deletes the patching schedule of a redis cache.
Reference Link ¶

⚶ Changes

{
  "#id": "PatchSchedules_Delete",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    },
    {
      "#name": "default",
      "Description": {
        "new": "The name of the RedisPatchSchedule",
        "old": "Default string modeled as parameter for auto generation to work correctly."
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/patchSchedules/{default}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
name: string ,
default: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_List (updated)
Description List all the private endpoint connections associated with the redis cache.
Reference Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_List",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a PrivateEndpointConnection list operation.",
        "old": "List of private endpoint connection associated with the specified storage account"
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PrivateEndpointConnection items on this page",
            "old": "Array of private endpoint connections"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "Description": {
              "new": "The private endpoint connection resource.",
              "old": "The Private Endpoint Connection resource."
            },
            "$properties": {
              "properties": [
                {
                  "@added_bbea478be6bd45848bb57dcdda86e691": {
                    "#name": "groupIds",
                    "Description": "The group ids for the private endpoint resource.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Type": "string"
                    }
                  }
                },
                {
                  "#name": "privateEndpoint",
                  "Description": {
                    "new": "The private endpoint resource.",
                    "old": "The resource of private end point."
                  },
                  "$properties": [
                    {
                      "#name": "id",
                      "Description": {
                        "new": "The ARM identifier for private endpoint.",
                        "old": "The ARM identifier for Private Endpoint"
                      }
                    }
                  ]
                }
              ]
            }
          }
        },
        {
          "@added_9cd56a92c64a486281da18027b1d8313": {
            "#name": "nextLink",
            "Description": "The link to the next page of items",
            "Format": "uri",
            "Required": false,
            "Type": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateEndpointConnections
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
cacheName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (updated)
Description Gets the specified private endpoint connection associated with the redis cache.
Reference Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_Get",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    },
    {
      "#name": "privateEndpointConnectionName",
      "Description": {
        "new": "The name of the private endpoint connection associated with the Azure resource.",
        "old": "The name of the private endpoint connection associated with the Azure resource"
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The private endpoint connection resource.",
        "old": "The Private Endpoint Connection resource."
      },
      "$properties": {
        "properties": [
          {
            "@added_72126ff4535149a4aaf2d5dbb0c8d9e9": {
              "#name": "groupIds",
              "Description": "The group ids for the private endpoint resource.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            }
          },
          {
            "#name": "privateEndpoint",
            "Description": {
              "new": "The private endpoint resource.",
              "old": "The resource of private end point."
            },
            "$properties": [
              {
                "#name": "id",
                "Description": {
                  "new": "The ARM identifier for private endpoint.",
                  "old": "The ARM identifier for Private Endpoint"
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
cacheName: string ,
privateEndpointConnectionName: string ,
}

⚐ Response (200)

{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Put (updated)
Description Update the state of specified private endpoint connection associated with the redis cache.
Reference Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_Put",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    },
    {
      "#name": "privateEndpointConnectionName",
      "Description": {
        "new": "The name of the private endpoint connection associated with the Azure resource.",
        "old": "The name of the private endpoint connection associated with the Azure resource"
      }
    },
    {
      "properties": {
        "Description": {
          "new": "The private endpoint connection resource.",
          "old": "The Private Endpoint Connection resource."
        },
        "$properties": {
          "properties": [
            {
              "@added_abff2ce16f6c44b692d2fc36a2a3e5de": {
                "#name": "groupIds",
                "Description": "The group ids for the private endpoint resource.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "#name": "privateEndpoint",
              "Description": {
                "new": "The private endpoint resource.",
                "old": "The resource of private end point."
              },
              "$properties": [
                {
                  "#name": "id",
                  "Description": {
                    "new": "The ARM identifier for private endpoint.",
                    "old": "The ARM identifier for Private Endpoint"
                  }
                }
              ]
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The private endpoint connection resource.",
        "old": "The Private Endpoint Connection resource."
      },
      "$properties": {
        "properties": [
          {
            "@added_4e3d3ff1e0ad4e4facd195f5203ce5b6": {
              "#name": "groupIds",
              "Description": "The group ids for the private endpoint resource.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            }
          },
          {
            "#name": "privateEndpoint",
            "Description": {
              "new": "The private endpoint resource.",
              "old": "The resource of private end point."
            },
            "$properties": [
              {
                "#name": "id",
                "Description": {
                  "new": "The ARM identifier for private endpoint.",
                  "old": "The ARM identifier for Private Endpoint"
                }
              }
            ]
          }
        ]
      }
    },
    "201": {
      "Description": {
        "new": "The private endpoint connection resource.",
        "old": "The Private Endpoint Connection resource."
      },
      "$properties": {
        "properties": [
          {
            "@added_d2053add19f044179b6167298f13eb9e": {
              "#name": "groupIds",
              "Description": "The group ids for the private endpoint resource.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            }
          },
          {
            "#name": "privateEndpoint",
            "Description": {
              "new": "The private endpoint resource.",
              "old": "The resource of private end point."
            },
            "$properties": [
              {
                "#name": "id",
                "Description": {
                  "new": "The ARM identifier for private endpoint.",
                  "old": "The ARM identifier for Private Endpoint"
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
cacheName: string ,
privateEndpointConnectionName: string ,
properties:
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
retry-after: integer ,
}
,
$schema:
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (updated)
Description Deletes the specified private endpoint connection associated with the redis cache.
Reference Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_Delete",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    },
    {
      "#name": "privateEndpointConnectionName",
      "Description": {
        "new": "The name of the private endpoint connection associated with the Azure resource.",
        "old": "The name of the private endpoint connection associated with the Azure resource"
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
cacheName: string ,
privateEndpointConnectionName: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateLinkResources_ListByRedisCache (updated)
Description Gets the private link resources that need to be created for a redis cache.
Reference Link ¶

⚶ Changes

{
  "#id": "PrivateLinkResources_ListByRedisCache",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a PrivateLinkResource list operation.",
        "old": "A list of private link resources"
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PrivateLinkResource items on this page",
            "old": "Array of private link resources"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "Description": {
              "new": "A private link resource.",
              "old": "A private link resource"
            },
            "$properties": {
              "properties": [
                {
                  "#name": "requiredZoneNames",
                  "Description": {
                    "new": "The private link resource private link DNS zone name.",
                    "old": "The private link resource Private link DNS zone name."
                  }
                }
              ]
            }
          }
        },
        {
          "@added_811d84343b3d4f42a93b5aebf4670f1f": {
            "#name": "nextLink",
            "Description": "The link to the next page of items",
            "Format": "uri",
            "Required": false,
            "Type": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateLinkResources
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
cacheName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
groupId: string ,
requiredMembers:
[
string ,
]
,
requiredZoneNames:
[
string ,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Redis_RegenerateKey (updated)
Description Regenerate Redis cache's access keys. This operation requires write permission to the cache resource.
Reference Link ¶

⚶ Changes

{
  "#id": "Redis_RegenerateKey",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The ID of the target subscription."
      }
    },
    {
      "#name": "name",
      "Description": {
        "new": "The name of the RedisResource",
        "old": "The name of the Redis cache."
      }
    },
    {
      "parameters": {
        "$properties": [
          {
            "#name": "keyType",
            "Enum": {
              "new": [
                [
                  "Primary",
                  "The primary access key"
                ],
                [
                  "Secondary",
                  "The secondary access key"
                ]
              ],
              "old": [
                [
                  "Primary",
                  ""
                ],
                [
                  "Secondary",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/regenerateKey
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
name: string ,
parameters:
{
keyType: enum ,
}
,
}

⚐ Response (200)

{
primaryKey: string ,
secondaryKey: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}