diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheOperations.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheOperations.json new file mode 100644 index 000000000000..30a4c3b00f7c --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCacheOperations.json @@ -0,0 +1,643 @@ +{ + "parameters": { + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Cache/checknameavailability/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Check Cache Name Availability", + "description": "Checks if a name is available for use with a new Redis Cache" + } + }, + { + "name": "Microsoft.Cache/register/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Register Resource Provider Microsoft.Cache", + "description": "Registers the 'Microsoft.Cache' resource provider with a subscription" + } + }, + { + "name": "Microsoft.Cache/unregister/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Unregister Resource Provider Microsoft.Cache", + "description": "Unregisters the 'Microsoft.Cache' resource provider with a subscription" + } + }, + { + "name": "Microsoft.Cache/operations/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "List Provider Operations", + "description": "Lists the operations that 'Microsoft.Cache' provider supports." + } + }, + { + "name": "Microsoft.Cache/locations/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Read operation results", + "description": "Gets the result of a long running operation for which the 'Location' header was previously returned to the client" + } + }, + { + "name": "Microsoft.Cache/locations/operationsStatus/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Read the status of a long running operation", + "description": "View the status of a long running operation for which the 'AzureAsync' header was previously returned to the client" + } + }, + { + "name": "Microsoft.Cache/locations/asyncOperations/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Read asynchronous operation status", + "description": "Read an Async Operation's Status" + } + }, + { + "name": "Microsoft.Cache/locations/checknameavailability/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Check Cache Name Availability in location", + "description": "Checks if a name is available for use with a new Redis Enterprise cache" + } + }, + { + "name": "Microsoft.Cache/redis/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Manage Redis Cache (read-write)", + "description": "Modify the Redis Cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Manage Redis Cache (read-only)", + "description": "View the Redis Cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Delete Redis Cache", + "description": "Delete the entire Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/listKeys/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "View Redis Cache Access Keys", + "description": "View the value of Redis Cache access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/regenerateKey/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Regenerate Redis Cache Access Keys", + "description": "Change the value of Redis Cache access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/import/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Import data into Redis from storage", + "description": "Import data of a specified format from multiple blobs into Redis" + } + }, + { + "name": "Microsoft.Cache/redis/export/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Export Redis data to storage", + "description": "Export Redis data to prefixed storage blobs in specified format" + } + }, + { + "name": "Microsoft.Cache/redis/forceReboot/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Force reboot a cache instance, potentially with data loss.", + "description": "Force reboot a cache instance, potentially with data loss." + } + }, + { + "name": "Microsoft.Cache/redis/stop/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Stop an Azure Cache for Redis, potentially with data loss.", + "description": "Stop an Azure Cache for Redis, potentially with data loss." + } + }, + { + "name": "Microsoft.Cache/redis/start/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Start an Azure Cache for Redis", + "description": "Start an Azure Cache for Redis" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache", + "operation": "Delete Redis Enterprise cache", + "description": "Delete the entire Redis Enterprise cache" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache", + "operation": "Manage Redis Enterprise cache (read)", + "description": "View the Redis Enterprise cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache", + "operation": "Manage Redis Enterprise cache (write)", + "description": "Modify the Redis Enterprise cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Delete Redis Enterprise database", + "description": "Deletes a Redis Enterprise database and its contents" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Manage Redis Enterprise cache database (read)", + "description": "View the Redis Enterprise cache database's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Manage Redis Enterprise cache database (write)", + "description": "Modify the Redis Enterprise cache database's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/export/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Export Redis Enterprise database", + "description": "Export data to storage blobs from a Redis Enterprise database " + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/forceUnlink/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Force unlink Redis Enterprise database georeplica", + "description": "Forcibly unlink a georeplica Redis Enterprise database from its peers" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/import/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Import Redis Enterprise database", + "description": "Import data from storage blobs to a Redis Enterprise database" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/listKeys/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "View Redis Enterprise database access keys", + "description": "View the value of Redis Enterprise database access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/regenerateKey/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Regenerate Redis Enterprise database access keys", + "description": "Change the value of Redis Enterprise database access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise database operation results", + "operation": "View Redis Enterprise database operation results", + "description": "View the result of Redis Enterprise database operations in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise operation results", + "operation": "View Redis Enterprise operation results", + "description": "View the result of Redis Enterprise operations in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/metricDefinitions/read", + "display": { + "provider": "Microsoft Cache", + "resource": "The available metrics for a Redis Cache", + "operation": "Read Redis Cache Metric Definitions", + "description": "Gets the available metrics for a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Cache", + "resource": "The available metrics for a Redis Enterprise Cache", + "operation": "Read Redis Enterprise Metric Definitions", + "description": "Gets the available metrics for a Redis Enterprise Cache" + } + }, + { + "name": "Microsoft.Cache/redis/patchSchedules/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Patching schedule of a Redis Cache", + "operation": "Get Redis Cache Patch Schedule", + "description": "Gets the patching schedule of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/patchSchedules/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Patching schedule of a Redis Cache", + "operation": "Change Redis Patching Schedule", + "description": "Modify the patching schedule of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/patchSchedules/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Patching schedule of a Redis Cache", + "operation": "Delete Redis Cache Patch Schedule", + "description": "Delete the patch schedule of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/firewallRules/read", + "display": { + "provider": "Microsoft Cache", + "resource": "IP firewall rule of a Redis Cache", + "operation": "Get Redis Cache Firewall Rule", + "description": "Get the IP firewall rules of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/firewallRules/write", + "display": { + "provider": "Microsoft Cache", + "resource": "IP firewall rule of a Redis Cache", + "operation": "Update Redis Cache Firewall Rule", + "description": "Edit the IP firewall rules of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/firewallRules/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "IP firewall rule of a Redis Cache", + "operation": "Delete Redis Cache Firewall Rule", + "description": "Delete IP firewall rules of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/linkedServers/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Linked Servers of a Redis Cache", + "operation": "Get Redis Cache Linked Servers", + "description": "Get Linked Servers associated with a redis cache." + } + }, + { + "name": "Microsoft.Cache/redis/linkedServers/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Linked Servers of a Redis Cache", + "operation": "Add Redis Cache Linked Server", + "description": "Add Linked Server to a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/linkedServers/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Linked Servers of a Redis Cache", + "operation": "Delete Redis Cache Linked Server", + "description": "Delete Linked Server from a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/eventGridFilters/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache Event Grid Filter", + "operation": "Get Redis Cache Event Grid Filter", + "description": "Get Redis Cache Event Grid Filter" + } + }, + { + "name": "Microsoft.Cache/redis/eventGridFilters/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache Event Grid Filter", + "operation": "Update Redis Cache Event Grid Filters", + "description": "Update Redis Cache Event Grid Filters" + } + }, + { + "name": "Microsoft.Cache/redis/eventGridFilters/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache Event Grid Filter", + "operation": "Delete Redis Cache Event Grid Filters", + "description": "Delete Redis Cache Event Grid Filters" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/validate/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Validate private endpoint connection proxy", + "description": "Validate the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Get private endpoint connection proxy", + "description": "Get the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Create private endpoint connection proxy", + "description": "Create the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Delete private endpoint connection proxy", + "description": "Delete the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/validate/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Validate private endpoint connection proxy", + "description": "Validate the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Get private endpoint connection proxy", + "description": "Get the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Create private endpoint connection proxy", + "description": "Create the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Delete private endpoint connection proxy", + "description": "Delete the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Redis Enterprise cache private endpoint operation results (read)", + "description": "View the result of private endpoint connection operations in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnections/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connections", + "operation": "Read private endpoint connection", + "description": "Read a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnections/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connections", + "operation": "Write private endpoint connection", + "description": "Write a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnections/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connections", + "operation": "Delete private endpoint connection", + "description": "Delete a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnections/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private endpoint connections", + "operation": "Read private endpoint connection", + "description": "Read a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnections/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private endpoint connections", + "operation": "Write private endpoint connection", + "description": "Write a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnections/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private endpoint connections", + "operation": "Delete private endpoint connection", + "description": "Delete a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redis/privateLinkResources/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private linkable resources", + "operation": "Read Private Linkable Resources", + "description": "Read 'groupId' of redis subresource that a private link can be connected to" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateLinkResources/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private link resources", + "operation": "Read Private Linkable Resources", + "description": "Read 'groupId' of redis subresource that a private link can be connected to" + } + }, + { + "name": "Microsoft.Cache/redis/roles/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Roles", + "operation": "Read Redis Roles", + "description": "Read roles on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roles/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Roles", + "operation": "Update Redis Roles", + "description": "Create or update role on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roles/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Roles", + "operation": "Delete Redis Roles", + "description": "Delete role on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roleAssignments/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Role Description", + "operation": "Read Redis Role Assignments", + "description": "Read role assignments on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roleAssignments/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Role Description", + "operation": "Update Redis Role Assignments", + "description": "Create or update role assignments on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roleAssignments/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Role Description", + "operation": "Delete Redis Role Assignment", + "description": "Delete All Redis Role Assignments" + } + }, + { + "name": "Microsoft.Cache/redis/PrivateEndpointConnectionsApproval/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private linkable resources", + "operation": "Approve Private Endpoint Connections", + "description": "Approve Private Endpoint Connections" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/PrivateEndpointConnectionsApproval/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private link resources", + "operation": "Approve Private Endpoint Connections", + "description": "Approve Private Endpoint Connections" + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/redis.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/redis.json index 416633acc491..593254ca1d55 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/redis.json +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/redis.json @@ -41,6 +41,11 @@ ], "description": "Lists all of the available REST API operations of the Microsoft.Cache provider.", "operationId": "Operations_List", + "x-ms-examples": { + "RedisCacheOperations": { + "$ref": "./examples/RedisCacheOperations.json" + } + }, "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1380,7 +1385,7 @@ ], "responses": { "200": { - "description": "The redis cache was successfully deleted." + "description": "Linked server was successfully deleted." }, "204": { "description": "Linked server was successfully deleted." diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-12-01/examples/RedisCacheOperations.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-12-01/examples/RedisCacheOperations.json new file mode 100644 index 000000000000..ffe24b70796a --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-12-01/examples/RedisCacheOperations.json @@ -0,0 +1,643 @@ +{ + "parameters": { + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Cache/checknameavailability/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Check Cache Name Availability", + "description": "Checks if a name is available for use with a new Redis Cache" + } + }, + { + "name": "Microsoft.Cache/register/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Register Resource Provider Microsoft.Cache", + "description": "Registers the 'Microsoft.Cache' resource provider with a subscription" + } + }, + { + "name": "Microsoft.Cache/unregister/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Unregister Resource Provider Microsoft.Cache", + "description": "Unregisters the 'Microsoft.Cache' resource provider with a subscription" + } + }, + { + "name": "Microsoft.Cache/operations/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "List Provider Operations", + "description": "Lists the operations that 'Microsoft.Cache' provider supports." + } + }, + { + "name": "Microsoft.Cache/locations/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Read operation results", + "description": "Gets the result of a long running operation for which the 'Location' header was previously returned to the client" + } + }, + { + "name": "Microsoft.Cache/locations/operationsStatus/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Read the status of a long running operation", + "description": "View the status of a long running operation for which the 'AzureAsync' header was previously returned to the client" + } + }, + { + "name": "Microsoft.Cache/locations/asyncOperations/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Read asynchronous operation status", + "description": "Read an Async Operation's Status" + } + }, + { + "name": "Microsoft.Cache/locations/checknameavailability/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Check Cache Name Availability in location", + "description": "Checks if a name is available for use with a new Redis Enterprise cache" + } + }, + { + "name": "Microsoft.Cache/redis/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Manage Redis Cache (read-write)", + "description": "Modify the Redis Cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Manage Redis Cache (read-only)", + "description": "View the Redis Cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Delete Redis Cache", + "description": "Delete the entire Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/listKeys/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "View Redis Cache Access Keys", + "description": "View the value of Redis Cache access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/regenerateKey/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Regenerate Redis Cache Access Keys", + "description": "Change the value of Redis Cache access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/import/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Import data into Redis from storage", + "description": "Import data of a specified format from multiple blobs into Redis" + } + }, + { + "name": "Microsoft.Cache/redis/export/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Export Redis data to storage", + "description": "Export Redis data to prefixed storage blobs in specified format" + } + }, + { + "name": "Microsoft.Cache/redis/forceReboot/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Force reboot a cache instance, potentially with data loss.", + "description": "Force reboot a cache instance, potentially with data loss." + } + }, + { + "name": "Microsoft.Cache/redis/stop/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Stop an Azure Cache for Redis, potentially with data loss.", + "description": "Stop an Azure Cache for Redis, potentially with data loss." + } + }, + { + "name": "Microsoft.Cache/redis/start/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Start an Azure Cache for Redis", + "description": "Start an Azure Cache for Redis" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache", + "operation": "Delete Redis Enterprise cache", + "description": "Delete the entire Redis Enterprise cache" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache", + "operation": "Manage Redis Enterprise cache (read)", + "description": "View the Redis Enterprise cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache", + "operation": "Manage Redis Enterprise cache (write)", + "description": "Modify the Redis Enterprise cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Delete Redis Enterprise database", + "description": "Deletes a Redis Enterprise database and its contents" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Manage Redis Enterprise cache database (read)", + "description": "View the Redis Enterprise cache database's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Manage Redis Enterprise cache database (write)", + "description": "Modify the Redis Enterprise cache database's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/export/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Export Redis Enterprise database", + "description": "Export data to storage blobs from a Redis Enterprise database " + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/forceUnlink/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Force unlink Redis Enterprise database georeplica", + "description": "Forcibly unlink a georeplica Redis Enterprise database from its peers" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/import/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Import Redis Enterprise database", + "description": "Import data from storage blobs to a Redis Enterprise database" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/listKeys/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "View Redis Enterprise database access keys", + "description": "View the value of Redis Enterprise database access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/regenerateKey/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Regenerate Redis Enterprise database access keys", + "description": "Change the value of Redis Enterprise database access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise database operation results", + "operation": "View Redis Enterprise database operation results", + "description": "View the result of Redis Enterprise database operations in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise operation results", + "operation": "View Redis Enterprise operation results", + "description": "View the result of Redis Enterprise operations in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/metricDefinitions/read", + "display": { + "provider": "Microsoft Cache", + "resource": "The available metrics for a Redis Cache", + "operation": "Read Redis Cache Metric Definitions", + "description": "Gets the available metrics for a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Cache", + "resource": "The available metrics for a Redis Enterprise Cache", + "operation": "Read Redis Enterprise Metric Definitions", + "description": "Gets the available metrics for a Redis Enterprise Cache" + } + }, + { + "name": "Microsoft.Cache/redis/patchSchedules/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Patching schedule of a Redis Cache", + "operation": "Get Redis Cache Patch Schedule", + "description": "Gets the patching schedule of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/patchSchedules/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Patching schedule of a Redis Cache", + "operation": "Change Redis Patching Schedule", + "description": "Modify the patching schedule of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/patchSchedules/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Patching schedule of a Redis Cache", + "operation": "Delete Redis Cache Patch Schedule", + "description": "Delete the patch schedule of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/firewallRules/read", + "display": { + "provider": "Microsoft Cache", + "resource": "IP firewall rule of a Redis Cache", + "operation": "Get Redis Cache Firewall Rule", + "description": "Get the IP firewall rules of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/firewallRules/write", + "display": { + "provider": "Microsoft Cache", + "resource": "IP firewall rule of a Redis Cache", + "operation": "Update Redis Cache Firewall Rule", + "description": "Edit the IP firewall rules of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/firewallRules/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "IP firewall rule of a Redis Cache", + "operation": "Delete Redis Cache Firewall Rule", + "description": "Delete IP firewall rules of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/linkedServers/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Linked Servers of a Redis Cache", + "operation": "Get Redis Cache Linked Servers", + "description": "Get Linked Servers associated with a redis cache." + } + }, + { + "name": "Microsoft.Cache/redis/linkedServers/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Linked Servers of a Redis Cache", + "operation": "Add Redis Cache Linked Server", + "description": "Add Linked Server to a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/linkedServers/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Linked Servers of a Redis Cache", + "operation": "Delete Redis Cache Linked Server", + "description": "Delete Linked Server from a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/eventGridFilters/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache Event Grid Filter", + "operation": "Get Redis Cache Event Grid Filter", + "description": "Get Redis Cache Event Grid Filter" + } + }, + { + "name": "Microsoft.Cache/redis/eventGridFilters/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache Event Grid Filter", + "operation": "Update Redis Cache Event Grid Filters", + "description": "Update Redis Cache Event Grid Filters" + } + }, + { + "name": "Microsoft.Cache/redis/eventGridFilters/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache Event Grid Filter", + "operation": "Delete Redis Cache Event Grid Filters", + "description": "Delete Redis Cache Event Grid Filters" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/validate/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Validate private endpoint connection proxy", + "description": "Validate the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Get private endpoint connection proxy", + "description": "Get the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Create private endpoint connection proxy", + "description": "Create the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Delete private endpoint connection proxy", + "description": "Delete the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/validate/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Validate private endpoint connection proxy", + "description": "Validate the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Get private endpoint connection proxy", + "description": "Get the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Create private endpoint connection proxy", + "description": "Create the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Delete private endpoint connection proxy", + "description": "Delete the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Redis Enterprise cache private endpoint operation results (read)", + "description": "View the result of private endpoint connection operations in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnections/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connections", + "operation": "Read private endpoint connection", + "description": "Read a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnections/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connections", + "operation": "Write private endpoint connection", + "description": "Write a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnections/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connections", + "operation": "Delete private endpoint connection", + "description": "Delete a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnections/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private endpoint connections", + "operation": "Read private endpoint connection", + "description": "Read a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnections/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private endpoint connections", + "operation": "Write private endpoint connection", + "description": "Write a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnections/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private endpoint connections", + "operation": "Delete private endpoint connection", + "description": "Delete a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redis/privateLinkResources/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private linkable resources", + "operation": "Read Private Linkable Resources", + "description": "Read 'groupId' of redis subresource that a private link can be connected to" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateLinkResources/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private link resources", + "operation": "Read Private Linkable Resources", + "description": "Read 'groupId' of redis subresource that a private link can be connected to" + } + }, + { + "name": "Microsoft.Cache/redis/roles/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Roles", + "operation": "Read Redis Roles", + "description": "Read roles on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roles/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Roles", + "operation": "Update Redis Roles", + "description": "Create or update role on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roles/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Roles", + "operation": "Delete Redis Roles", + "description": "Delete role on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roleAssignments/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Role Description", + "operation": "Read Redis Role Assignments", + "description": "Read role assignments on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roleAssignments/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Role Description", + "operation": "Update Redis Role Assignments", + "description": "Create or update role assignments on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roleAssignments/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Role Description", + "operation": "Delete Redis Role Assignment", + "description": "Delete All Redis Role Assignments" + } + }, + { + "name": "Microsoft.Cache/redis/PrivateEndpointConnectionsApproval/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private linkable resources", + "operation": "Approve Private Endpoint Connections", + "description": "Approve Private Endpoint Connections" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/PrivateEndpointConnectionsApproval/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private link resources", + "operation": "Approve Private Endpoint Connections", + "description": "Approve Private Endpoint Connections" + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-12-01/examples/RedisOperations_List.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-12-01/examples/RedisOperations_List.json deleted file mode 100644 index 4ea510400d82..000000000000 --- a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-12-01/examples/RedisOperations_List.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "api-version": "2020-12-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "operationName", - "display": { - "provider": "providerName", - "resource": "resourceName", - "operation": "operationName", - "description": "operation description" - } - } - ] - } - } - } -} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-12-01/redis.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-12-01/redis.json index f1550168dbb9..c5ba986b1cc3 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-12-01/redis.json +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-12-01/redis.json @@ -42,8 +42,8 @@ "description": "Lists all of the available REST API operations of the Microsoft.Cache provider.", "operationId": "Operations_List", "x-ms-examples": { - "RedisOperationsList": { - "$ref": "./examples/RedisOperations_List.json" + "RedisCacheOperations": { + "$ref": "./examples/RedisCacheOperations.json" } }, "parameters": [ @@ -1388,7 +1388,7 @@ ], "responses": { "200": { - "description": "The redis cache was successfully deleted." + "description": "Linked server was successfully deleted." }, "204": { "description": "Linked server was successfully deleted." @@ -1897,7 +1897,7 @@ }, "redisVersion": { "type": "string", - "description": "Redis version. Only major version will be used in PUT/PATCH request with current valid values: (4, 6)" + "description": "Redis version. This should be in the form 'major[.minor[.build]]' (only 'major' is required) or the value 'latest' which refers to the latest stable Redis version that is available. Only the major and minor version are used in a PUT/PATCH request. Supported versions: 4.0, 6.0." }, "enableNonSslPort": { "type": "boolean", diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2021-06-01/examples/RedisCacheOperations.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2021-06-01/examples/RedisCacheOperations.json new file mode 100644 index 000000000000..d2676235cce7 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2021-06-01/examples/RedisCacheOperations.json @@ -0,0 +1,643 @@ +{ + "parameters": { + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Cache/checknameavailability/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Check Cache Name Availability", + "description": "Checks if a name is available for use with a new Redis Cache" + } + }, + { + "name": "Microsoft.Cache/register/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Register Resource Provider Microsoft.Cache", + "description": "Registers the 'Microsoft.Cache' resource provider with a subscription" + } + }, + { + "name": "Microsoft.Cache/unregister/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Unregister Resource Provider Microsoft.Cache", + "description": "Unregisters the 'Microsoft.Cache' resource provider with a subscription" + } + }, + { + "name": "Microsoft.Cache/operations/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "List Provider Operations", + "description": "Lists the operations that 'Microsoft.Cache' provider supports." + } + }, + { + "name": "Microsoft.Cache/locations/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Read operation results", + "description": "Gets the result of a long running operation for which the 'Location' header was previously returned to the client" + } + }, + { + "name": "Microsoft.Cache/locations/operationsStatus/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Read the status of a long running operation", + "description": "View the status of a long running operation for which the 'AzureAsync' header was previously returned to the client" + } + }, + { + "name": "Microsoft.Cache/locations/asyncOperations/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Read asynchronous operation status", + "description": "Read an Async Operation's Status" + } + }, + { + "name": "Microsoft.Cache/locations/checknameavailability/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Check Cache Name Availability in location", + "description": "Checks if a name is available for use with a new Redis Enterprise cache" + } + }, + { + "name": "Microsoft.Cache/redis/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Manage Redis Cache (read-write)", + "description": "Modify the Redis Cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Manage Redis Cache (read-only)", + "description": "View the Redis Cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Delete Redis Cache", + "description": "Delete the entire Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/listKeys/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "View Redis Cache Access Keys", + "description": "View the value of Redis Cache access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/regenerateKey/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Regenerate Redis Cache Access Keys", + "description": "Change the value of Redis Cache access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/import/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Import data into Redis from storage", + "description": "Import data of a specified format from multiple blobs into Redis" + } + }, + { + "name": "Microsoft.Cache/redis/export/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Export Redis data to storage", + "description": "Export Redis data to prefixed storage blobs in specified format" + } + }, + { + "name": "Microsoft.Cache/redis/forceReboot/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Force reboot a cache instance, potentially with data loss.", + "description": "Force reboot a cache instance, potentially with data loss." + } + }, + { + "name": "Microsoft.Cache/redis/stop/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Stop an Azure Cache for Redis, potentially with data loss.", + "description": "Stop an Azure Cache for Redis, potentially with data loss." + } + }, + { + "name": "Microsoft.Cache/redis/start/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Start an Azure Cache for Redis", + "description": "Start an Azure Cache for Redis" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache", + "operation": "Delete Redis Enterprise cache", + "description": "Delete the entire Redis Enterprise cache" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache", + "operation": "Manage Redis Enterprise cache (read)", + "description": "View the Redis Enterprise cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache", + "operation": "Manage Redis Enterprise cache (write)", + "description": "Modify the Redis Enterprise cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Delete Redis Enterprise database", + "description": "Deletes a Redis Enterprise database and its contents" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Manage Redis Enterprise cache database (read)", + "description": "View the Redis Enterprise cache database's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Manage Redis Enterprise cache database (write)", + "description": "Modify the Redis Enterprise cache database's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/export/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Export Redis Enterprise database", + "description": "Export data to storage blobs from a Redis Enterprise database " + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/forceUnlink/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Force unlink Redis Enterprise database georeplica", + "description": "Forcibly unlink a georeplica Redis Enterprise database from its peers" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/import/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Import Redis Enterprise database", + "description": "Import data from storage blobs to a Redis Enterprise database" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/listKeys/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "View Redis Enterprise database access keys", + "description": "View the value of Redis Enterprise database access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/regenerateKey/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Regenerate Redis Enterprise database access keys", + "description": "Change the value of Redis Enterprise database access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise database operation results", + "operation": "View Redis Enterprise database operation results", + "description": "View the result of Redis Enterprise database operations in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise operation results", + "operation": "View Redis Enterprise operation results", + "description": "View the result of Redis Enterprise operations in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/metricDefinitions/read", + "display": { + "provider": "Microsoft Cache", + "resource": "The available metrics for a Redis Cache", + "operation": "Read Redis Cache Metric Definitions", + "description": "Gets the available metrics for a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Cache", + "resource": "The available metrics for a Redis Enterprise Cache", + "operation": "Read Redis Enterprise Metric Definitions", + "description": "Gets the available metrics for a Redis Enterprise Cache" + } + }, + { + "name": "Microsoft.Cache/redis/patchSchedules/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Patching schedule of a Redis Cache", + "operation": "Get Redis Cache Patch Schedule", + "description": "Gets the patching schedule of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/patchSchedules/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Patching schedule of a Redis Cache", + "operation": "Change Redis Patching Schedule", + "description": "Modify the patching schedule of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/patchSchedules/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Patching schedule of a Redis Cache", + "operation": "Delete Redis Cache Patch Schedule", + "description": "Delete the patch schedule of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/firewallRules/read", + "display": { + "provider": "Microsoft Cache", + "resource": "IP firewall rule of a Redis Cache", + "operation": "Get Redis Cache Firewall Rule", + "description": "Get the IP firewall rules of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/firewallRules/write", + "display": { + "provider": "Microsoft Cache", + "resource": "IP firewall rule of a Redis Cache", + "operation": "Update Redis Cache Firewall Rule", + "description": "Edit the IP firewall rules of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/firewallRules/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "IP firewall rule of a Redis Cache", + "operation": "Delete Redis Cache Firewall Rule", + "description": "Delete IP firewall rules of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/linkedServers/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Linked Servers of a Redis Cache", + "operation": "Get Redis Cache Linked Servers", + "description": "Get Linked Servers associated with a redis cache." + } + }, + { + "name": "Microsoft.Cache/redis/linkedServers/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Linked Servers of a Redis Cache", + "operation": "Add Redis Cache Linked Server", + "description": "Add Linked Server to a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/linkedServers/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Linked Servers of a Redis Cache", + "operation": "Delete Redis Cache Linked Server", + "description": "Delete Linked Server from a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/eventGridFilters/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache Event Grid Filter", + "operation": "Get Redis Cache Event Grid Filter", + "description": "Get Redis Cache Event Grid Filter" + } + }, + { + "name": "Microsoft.Cache/redis/eventGridFilters/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache Event Grid Filter", + "operation": "Update Redis Cache Event Grid Filters", + "description": "Update Redis Cache Event Grid Filters" + } + }, + { + "name": "Microsoft.Cache/redis/eventGridFilters/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache Event Grid Filter", + "operation": "Delete Redis Cache Event Grid Filters", + "description": "Delete Redis Cache Event Grid Filters" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/validate/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Validate private endpoint connection proxy", + "description": "Validate the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Get private endpoint connection proxy", + "description": "Get the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Create private endpoint connection proxy", + "description": "Create the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Delete private endpoint connection proxy", + "description": "Delete the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/validate/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Validate private endpoint connection proxy", + "description": "Validate the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Get private endpoint connection proxy", + "description": "Get the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Create private endpoint connection proxy", + "description": "Create the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Delete private endpoint connection proxy", + "description": "Delete the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Redis Enterprise cache private endpoint operation results (read)", + "description": "View the result of private endpoint connection operations in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnections/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connections", + "operation": "Read private endpoint connection", + "description": "Read a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnections/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connections", + "operation": "Write private endpoint connection", + "description": "Write a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnections/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connections", + "operation": "Delete private endpoint connection", + "description": "Delete a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnections/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private endpoint connections", + "operation": "Read private endpoint connection", + "description": "Read a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnections/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private endpoint connections", + "operation": "Write private endpoint connection", + "description": "Write a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnections/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private endpoint connections", + "operation": "Delete private endpoint connection", + "description": "Delete a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redis/privateLinkResources/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private linkable resources", + "operation": "Read Private Linkable Resources", + "description": "Read 'groupId' of redis subresource that a private link can be connected to" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateLinkResources/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private link resources", + "operation": "Read Private Linkable Resources", + "description": "Read 'groupId' of redis subresource that a private link can be connected to" + } + }, + { + "name": "Microsoft.Cache/redis/roles/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Roles", + "operation": "Read Redis Roles", + "description": "Read roles on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roles/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Roles", + "operation": "Update Redis Roles", + "description": "Create or update role on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roles/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Roles", + "operation": "Delete Redis Roles", + "description": "Delete role on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roleAssignments/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Role Description", + "operation": "Read Redis Role Assignments", + "description": "Read role assignments on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roleAssignments/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Role Description", + "operation": "Update Redis Role Assignments", + "description": "Create or update role assignments on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roleAssignments/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Role Description", + "operation": "Delete Redis Role Assignment", + "description": "Delete All Redis Role Assignments" + } + }, + { + "name": "Microsoft.Cache/redis/PrivateEndpointConnectionsApproval/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private linkable resources", + "operation": "Approve Private Endpoint Connections", + "description": "Approve Private Endpoint Connections" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/PrivateEndpointConnectionsApproval/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private link resources", + "operation": "Approve Private Endpoint Connections", + "description": "Approve Private Endpoint Connections" + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2021-06-01/examples/RedisOperations_List.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2021-06-01/examples/RedisOperations_List.json deleted file mode 100644 index cdb08480dd2d..000000000000 --- a/specification/redis/resource-manager/Microsoft.Cache/stable/2021-06-01/examples/RedisOperations_List.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "api-version": "2021-06-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "operationName", - "display": { - "provider": "providerName", - "resource": "resourceName", - "operation": "operationName", - "description": "operation description" - } - } - ] - } - } - } -} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2021-06-01/redis.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2021-06-01/redis.json index ff5f6ee2b685..c837ed5e377e 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/stable/2021-06-01/redis.json +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2021-06-01/redis.json @@ -42,8 +42,8 @@ "description": "Lists all of the available REST API operations of the Microsoft.Cache provider.", "operationId": "Operations_List", "x-ms-examples": { - "RedisOperationsList": { - "$ref": "./examples/RedisOperations_List.json" + "RedisCacheOperations": { + "$ref": "./examples/RedisCacheOperations.json" } }, "parameters": [ @@ -1388,7 +1388,7 @@ ], "responses": { "200": { - "description": "The redis cache was successfully deleted." + "description": "Linked server was successfully deleted." }, "204": { "description": "Linked server was successfully deleted." @@ -1952,7 +1952,7 @@ }, "redisVersion": { "type": "string", - "description": "Redis version. Only major version will be used in PUT/PATCH request with current valid values: (4, 6)" + "description": "Redis version. This should be in the form 'major[.minor[.build]]' (only 'major' is required) or the value 'latest' which refers to the latest stable Redis version that is available. Only the major and minor version are used in a PUT/PATCH request. Supported versions: 4.0, 6.0." }, "enableNonSslPort": { "type": "boolean", diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheAsyncOperationStatus.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheAsyncOperationStatus.json new file mode 100644 index 000000000000..21b27a40ea9a --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheAsyncOperationStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "location": "East US", + "api-version": "2022-05-01", + "subscriptionId": "subid", + "operationId": "c7ba2bf5-5939-4d79-b037-2964ccf097da" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.Cache/locations/East US/asyncOperations/c7ba2bf5-5939-4d79-b037-2964ccf097da", + "name": "c7ba2bf5-5939-4d79-b037-2964ccf097da", + "status": "Succeeded", + "startTime": null, + "endTime": null, + "percentComplete": null, + "properties": null, + "error": null + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheCheckNameAvailability.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheCheckNameAvailability.json new file mode 100644 index 000000000000..0fd9ab33c426 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheCheckNameAvailability.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2022-05-01", + "subscriptionId": "subid", + "parameters": { + "type": "Microsoft.Cache/Redis", + "name": "cacheName" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheCreate.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheCreate.json new file mode 100644 index 000000000000..33bc9e477b81 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheCreate.json @@ -0,0 +1,205 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2022-05-01", + "subscriptionId": "subid", + "parameters": { + "location": "West US", + "zones": [ + "1" + ], + "properties": { + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "redisVersion": "4", + "enableNonSslPort": true, + "shardCount": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxmemory-policy": "allkeys-lru" + }, + "subnetId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/network1/subnets/subnet1", + "staticIP": "192.168.0.5", + "minimumTlsVersion": "1.2" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "zones": [ + "1" + ], + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "4.0.14", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": false, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxmemory-policy": "allkeys-lru" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "minimumTlsVersion": "1.2", + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "zone": "1", + "shardId": 0, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15003, + "nonSslPort": 13003, + "zone": "1", + "shardId": 1, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15004, + "nonSslPort": 13004, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15005, + "nonSslPort": 13005, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "zones": [ + "1" + ], + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "4.0.14", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": false, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxclients": "1000", + "maxmemory-reserved": "50", + "maxmemory-delta": "50" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "minimumTlsVersion": "1.2", + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "zone": "1", + "shardId": 0, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15003, + "nonSslPort": 13003, + "zone": "1", + "shardId": 1, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15004, + "nonSslPort": 13004, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15005, + "nonSslPort": 13005, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + } + ] + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheCreateDefaultVersion.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheCreateDefaultVersion.json new file mode 100644 index 000000000000..f09d39aa533d --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheCreateDefaultVersion.json @@ -0,0 +1,204 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2022-05-01", + "subscriptionId": "subid", + "parameters": { + "location": "West US", + "zones": [ + "1" + ], + "properties": { + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": true, + "shardCount": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxmemory-policy": "allkeys-lru" + }, + "subnetId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/network1/subnets/subnet1", + "staticIP": "192.168.0.5", + "minimumTlsVersion": "1.2" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "zones": [ + "1" + ], + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "6.0.14", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": false, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxmemory-policy": "allkeys-lru" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "minimumTlsVersion": "1.2", + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "zone": "1", + "shardId": 0, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15003, + "nonSslPort": 13003, + "zone": "1", + "shardId": 1, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15004, + "nonSslPort": 13004, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15005, + "nonSslPort": 13005, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "zones": [ + "1" + ], + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "6.0.14", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": false, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxclients": "1000", + "maxmemory-reserved": "50", + "maxmemory-delta": "50" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "minimumTlsVersion": "1.2", + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "zone": "1", + "shardId": 0, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15003, + "nonSslPort": 13003, + "zone": "1", + "shardId": 1, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15004, + "nonSslPort": 13004, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15005, + "nonSslPort": 13005, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + } + ] + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheCreateLatestVersion.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheCreateLatestVersion.json new file mode 100644 index 000000000000..7597a7ce7535 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheCreateLatestVersion.json @@ -0,0 +1,205 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2022-05-01", + "subscriptionId": "subid", + "parameters": { + "location": "West US", + "zones": [ + "1" + ], + "properties": { + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "redisVersion": "Latest", + "enableNonSslPort": true, + "shardCount": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxmemory-policy": "allkeys-lru" + }, + "subnetId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/network1/subnets/subnet1", + "staticIP": "192.168.0.5", + "minimumTlsVersion": "1.2" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "zones": [ + "1" + ], + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "6.0.14", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": false, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxmemory-policy": "allkeys-lru" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "minimumTlsVersion": "1.2", + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "zone": "1", + "shardId": 0, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15003, + "nonSslPort": 13003, + "zone": "1", + "shardId": 1, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15004, + "nonSslPort": 13004, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15005, + "nonSslPort": 13005, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "zones": [ + "1" + ], + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "6.0.14", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": false, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxclients": "1000", + "maxmemory-reserved": "50", + "maxmemory-delta": "50" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "minimumTlsVersion": "1.2", + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "zone": "1", + "shardId": 0, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15003, + "nonSslPort": 13003, + "zone": "1", + "shardId": 1, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15004, + "nonSslPort": 13004, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15005, + "nonSslPort": 13005, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + } + ] + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheDelete.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheDelete.json new file mode 100644 index 000000000000..1aa223cc70c9 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2022-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheDeletePrivateEndpointConnection.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..440032e390ad --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheDeletePrivateEndpointConnection.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "rgtest01", + "cacheName": "cachetest01", + "privateEndpointConnectionName": "pectest01", + "api-version": "2022-05-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheExport.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheExport.json new file mode 100644 index 000000000000..256aad342892 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheExport.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2022-05-01", + "subscriptionId": "subid", + "parameters": { + "format": "RDB", + "prefix": "datadump1", + "container": "https://contosostorage.blob.core.window.net/urltoBlobContainer?sasKeyParameters" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheFirewallRuleCreate.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheFirewallRuleCreate.json new file mode 100644 index 000000000000..4773029e371f --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheFirewallRuleCreate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "ruleName": "rule1", + "cacheName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2022-05-01", + "subscriptionId": "subid", + "parameters": { + "properties": { + "startIP": "192.168.1.1", + "endIP": "192.168.1.4" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/firewallRules/rule1", + "name": "cache1/rule1", + "type": "Microsoft.Cache/Redis/firewallRules", + "properties": { + "startIP": "192.168.1.1", + "endIP": "192.168.1.4" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/firewallRules/rule1", + "name": "cache1/rule1", + "type": "Microsoft.Cache/Redis/firewallRules", + "properties": { + "startIP": "192.168.1.1", + "endIP": "192.168.1.4" + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheFirewallRuleDelete.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheFirewallRuleDelete.json new file mode 100644 index 000000000000..59b025d070b2 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheFirewallRuleDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "ruleName": "rule1", + "cacheName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2022-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheFirewallRuleGet.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheFirewallRuleGet.json new file mode 100644 index 000000000000..e8b99f947a0d --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheFirewallRuleGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "ruleName": "rule1", + "cacheName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2022-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/firewallRules/rule1", + "name": "cache1/rule1", + "type": "Microsoft.Cache/Redis/firewallRules", + "properties": { + "startIP": "192.168.1.1", + "endIP": "192.168.1.4" + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheFirewallRulesList.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheFirewallRulesList.json new file mode 100644 index 000000000000..60e1b1158d6e --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheFirewallRulesList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "cacheName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2022-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.Cache/Redis/firewallRules", + "properties": { + "startIP": "192.168.1.1", + "endIP": "192.168.1.4" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/firewallRules/rule2", + "name": "rule2", + "type": "Microsoft.Cache/Redis/firewallRules", + "properties": { + "startIP": "192.169.1.0", + "endIP": "192.169.1.255" + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheForceReboot.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheForceReboot.json new file mode 100644 index 000000000000..7091907feb8f --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheForceReboot.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2022-05-01", + "subscriptionId": "subid", + "parameters": { + "shardId": 0, + "rebootType": "AllNodes", + "ports": [ + 13000, + 15001 + ] + } + }, + "responses": { + "200": { + "body": { + "message": "reboot operation enqueued" + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheGet.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheGet.json new file mode 100644 index 000000000000..cc57a365791c --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheGet.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2022-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "redisVersion": "3.2", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 3 + }, + "enableNonSslPort": true, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": {}, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "linkedServers": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache2" + } + ], + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "isMaster": false, + "isPrimary": false + } + ], + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/privateEndpointConnections/cachePec", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/cachePe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Please approve my connection", + "actionsRequired": "None" + } + } + } + ] + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheGetPrivateEndpointConnection.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..06753d5e247a --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheGetPrivateEndpointConnection.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "rgtest01", + "cacheName": "cachetest01", + "privateEndpointConnectionName": "pectest01", + "api-version": "2022-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cachetest01/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/Redis/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheImport.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheImport.json new file mode 100644 index 000000000000..392947252a7e --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheImport.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2022-05-01", + "subscriptionId": "subid", + "parameters": { + "format": "RDB", + "files": [ + "http://fileuris.contoso.com/pathtofile1" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheLinkedServer_Create.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheLinkedServer_Create.json new file mode 100644 index 000000000000..e38db347d557 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheLinkedServer_Create.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "linkedServerName": "cache2", + "api-version": "2022-05-01", + "subscriptionId": "subid", + "parameters": { + "properties": { + "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache2", + "linkedRedisCacheLocation": "West US", + "serverRole": "Secondary" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache2", + "name": "cache2", + "type": "Microsoft.Cache/Redis/linkedServers", + "properties": { + "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache2", + "linkedRedisCacheLocation": "West US", + "provisioningState": "Creating", + "serverRole": "Secondary" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache2", + "name": "cache2", + "type": "Microsoft.Cache/Redis/linkedServers", + "properties": { + "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache2", + "linkedRedisCacheLocation": "West US", + "provisioningState": "Creating", + "serverRole": "Secondary" + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheLinkedServer_Delete.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheLinkedServer_Delete.json new file mode 100644 index 000000000000..82ae04b140e3 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheLinkedServer_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "linkedServerName": "cache2", + "api-version": "2022-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheLinkedServer_Get.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheLinkedServer_Get.json new file mode 100644 index 000000000000..142564a647ba --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheLinkedServer_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2022-05-01", + "subscriptionId": "subid", + "linkedServerName": "cache2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache2", + "name": "cache2", + "type": "Microsoft.Cache/Redis/linkedServers", + "properties": { + "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache2", + "linkedRedisCacheLocation": "West US", + "provisioningState": "Succeeded", + "serverRole": "Secondary" + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheLinkedServer_List.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheLinkedServer_List.json new file mode 100644 index 000000000000..548f1046d57e --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheLinkedServer_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2022-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache2", + "name": "cache2", + "type": "Microsoft.Cache/Redis/linkedServers", + "properties": { + "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache2", + "linkedRedisCacheLocation": "West US", + "provisioningState": "Succeeded", + "serverRole": "Secondary" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache3", + "name": "cache3", + "type": "Microsoft.Cache/Redis/linkedServers", + "properties": { + "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache3", + "linkedRedisCacheLocation": "West US", + "provisioningState": "Succeeded", + "serverRole": "Secondary" + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheList.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheList.json new file mode 100644 index 000000000000..bb26f10174d5 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheList.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2022-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "redisVersion": "3.2", + "sku": { + "name": "Standard", + "family": "C", + "capacity": 6 + }, + "enableNonSslPort": true, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": {}, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "isMaster": false, + "isPrimary": false + } + ] + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheListByResourceGroup.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheListByResourceGroup.json new file mode 100644 index 000000000000..1f7bb004d4d7 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheListByResourceGroup.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2022-05-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "redisVersion": "3.2", + "sku": { + "name": "Standard", + "family": "C", + "capacity": 6 + }, + "enableNonSslPort": true, + "redisConfiguration": {}, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380 + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheListKeys.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheListKeys.json new file mode 100644 index 000000000000..da3d2d538165 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheListKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2022-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "secondaryKey": "" + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheListPrivateEndpointConnections.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheListPrivateEndpointConnections.json new file mode 100644 index 000000000000..173fe6d9032f --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheListPrivateEndpointConnections.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "rgtest01", + "cacheName": "cachetest01", + "privateEndpointConnectionName": "pectest01", + "api-version": "2022-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cachetest01/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/Redis/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cachetest01/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/Redis/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheListPrivateLinkResources.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheListPrivateLinkResources.json new file mode 100644 index 000000000000..006b83f7eaf3 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheListPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "rgtest01", + "cacheName": "cacheTest01", + "api-version": "2022-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cacheTest01/privateLinkResources/redisCache", + "name": "redisCache", + "type": "Microsoft.Cache/Redis/privateLinkResources", + "properties": { + "groupId": "redisCache", + "requiredMembers": [ + "redisCache" + ], + "requiredZoneNames": [ + "privatelink.redis.cache.windows.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheListUpgradeNotifications.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheListUpgradeNotifications.json new file mode 100644 index 000000000000..6bf877f81bb4 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheListUpgradeNotifications.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2022-05-01", + "subscriptionId": "subid", + "history": "5000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "notification1", + "timestamp": "2017-02-16T23:20:50.52Z", + "upsellNotification": {} + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheOperations.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheOperations.json new file mode 100644 index 000000000000..1316f5fe2a6b --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheOperations.json @@ -0,0 +1,643 @@ +{ + "parameters": { + "api-version": "2022-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Cache/checknameavailability/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Check Cache Name Availability", + "description": "Checks if a name is available for use with a new Redis Cache" + } + }, + { + "name": "Microsoft.Cache/register/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Register Resource Provider Microsoft.Cache", + "description": "Registers the 'Microsoft.Cache' resource provider with a subscription" + } + }, + { + "name": "Microsoft.Cache/unregister/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Unregister Resource Provider Microsoft.Cache", + "description": "Unregisters the 'Microsoft.Cache' resource provider with a subscription" + } + }, + { + "name": "Microsoft.Cache/operations/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "List Provider Operations", + "description": "Lists the operations that 'Microsoft.Cache' provider supports." + } + }, + { + "name": "Microsoft.Cache/locations/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Read operation results", + "description": "Gets the result of a long running operation for which the 'Location' header was previously returned to the client" + } + }, + { + "name": "Microsoft.Cache/locations/operationsStatus/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Read the status of a long running operation", + "description": "View the status of a long running operation for which the 'AzureAsync' header was previously returned to the client" + } + }, + { + "name": "Microsoft.Cache/locations/asyncOperations/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Read asynchronous operation status", + "description": "Read an Async Operation's Status" + } + }, + { + "name": "Microsoft.Cache/locations/checknameavailability/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Check Cache Name Availability in location", + "description": "Checks if a name is available for use with a new Redis Enterprise cache" + } + }, + { + "name": "Microsoft.Cache/redis/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Manage Redis Cache (read-write)", + "description": "Modify the Redis Cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Manage Redis Cache (read-only)", + "description": "View the Redis Cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Delete Redis Cache", + "description": "Delete the entire Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/listKeys/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "View Redis Cache Access Keys", + "description": "View the value of Redis Cache access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/regenerateKey/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Regenerate Redis Cache Access Keys", + "description": "Change the value of Redis Cache access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/import/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Import data into Redis from storage", + "description": "Import data of a specified format from multiple blobs into Redis" + } + }, + { + "name": "Microsoft.Cache/redis/export/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Export Redis data to storage", + "description": "Export Redis data to prefixed storage blobs in specified format" + } + }, + { + "name": "Microsoft.Cache/redis/forceReboot/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Force reboot a cache instance, potentially with data loss.", + "description": "Force reboot a cache instance, potentially with data loss." + } + }, + { + "name": "Microsoft.Cache/redis/stop/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Stop an Azure Cache for Redis, potentially with data loss.", + "description": "Stop an Azure Cache for Redis, potentially with data loss." + } + }, + { + "name": "Microsoft.Cache/redis/start/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Start an Azure Cache for Redis", + "description": "Start an Azure Cache for Redis" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache", + "operation": "Delete Redis Enterprise cache", + "description": "Delete the entire Redis Enterprise cache" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache", + "operation": "Manage Redis Enterprise cache (read)", + "description": "View the Redis Enterprise cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache", + "operation": "Manage Redis Enterprise cache (write)", + "description": "Modify the Redis Enterprise cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Delete Redis Enterprise database", + "description": "Deletes a Redis Enterprise database and its contents" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Manage Redis Enterprise cache database (read)", + "description": "View the Redis Enterprise cache database's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Manage Redis Enterprise cache database (write)", + "description": "Modify the Redis Enterprise cache database's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/export/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Export Redis Enterprise database", + "description": "Export data to storage blobs from a Redis Enterprise database " + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/forceUnlink/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Force unlink Redis Enterprise database georeplica", + "description": "Forcibly unlink a georeplica Redis Enterprise database from its peers" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/import/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Import Redis Enterprise database", + "description": "Import data from storage blobs to a Redis Enterprise database" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/listKeys/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "View Redis Enterprise database access keys", + "description": "View the value of Redis Enterprise database access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/regenerateKey/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Regenerate Redis Enterprise database access keys", + "description": "Change the value of Redis Enterprise database access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise database operation results", + "operation": "View Redis Enterprise database operation results", + "description": "View the result of Redis Enterprise database operations in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise operation results", + "operation": "View Redis Enterprise operation results", + "description": "View the result of Redis Enterprise operations in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/metricDefinitions/read", + "display": { + "provider": "Microsoft Cache", + "resource": "The available metrics for a Redis Cache", + "operation": "Read Redis Cache Metric Definitions", + "description": "Gets the available metrics for a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Cache", + "resource": "The available metrics for a Redis Enterprise Cache", + "operation": "Read Redis Enterprise Metric Definitions", + "description": "Gets the available metrics for a Redis Enterprise Cache" + } + }, + { + "name": "Microsoft.Cache/redis/patchSchedules/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Patching schedule of a Redis Cache", + "operation": "Get Redis Cache Patch Schedule", + "description": "Gets the patching schedule of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/patchSchedules/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Patching schedule of a Redis Cache", + "operation": "Change Redis Patching Schedule", + "description": "Modify the patching schedule of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/patchSchedules/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Patching schedule of a Redis Cache", + "operation": "Delete Redis Cache Patch Schedule", + "description": "Delete the patch schedule of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/firewallRules/read", + "display": { + "provider": "Microsoft Cache", + "resource": "IP firewall rule of a Redis Cache", + "operation": "Get Redis Cache Firewall Rule", + "description": "Get the IP firewall rules of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/firewallRules/write", + "display": { + "provider": "Microsoft Cache", + "resource": "IP firewall rule of a Redis Cache", + "operation": "Update Redis Cache Firewall Rule", + "description": "Edit the IP firewall rules of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/firewallRules/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "IP firewall rule of a Redis Cache", + "operation": "Delete Redis Cache Firewall Rule", + "description": "Delete IP firewall rules of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/linkedServers/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Linked Servers of a Redis Cache", + "operation": "Get Redis Cache Linked Servers", + "description": "Get Linked Servers associated with a redis cache." + } + }, + { + "name": "Microsoft.Cache/redis/linkedServers/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Linked Servers of a Redis Cache", + "operation": "Add Redis Cache Linked Server", + "description": "Add Linked Server to a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/linkedServers/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Linked Servers of a Redis Cache", + "operation": "Delete Redis Cache Linked Server", + "description": "Delete Linked Server from a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/eventGridFilters/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache Event Grid Filter", + "operation": "Get Redis Cache Event Grid Filter", + "description": "Get Redis Cache Event Grid Filter" + } + }, + { + "name": "Microsoft.Cache/redis/eventGridFilters/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache Event Grid Filter", + "operation": "Update Redis Cache Event Grid Filters", + "description": "Update Redis Cache Event Grid Filters" + } + }, + { + "name": "Microsoft.Cache/redis/eventGridFilters/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache Event Grid Filter", + "operation": "Delete Redis Cache Event Grid Filters", + "description": "Delete Redis Cache Event Grid Filters" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/validate/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Validate private endpoint connection proxy", + "description": "Validate the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Get private endpoint connection proxy", + "description": "Get the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Create private endpoint connection proxy", + "description": "Create the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Delete private endpoint connection proxy", + "description": "Delete the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/validate/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Validate private endpoint connection proxy", + "description": "Validate the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Get private endpoint connection proxy", + "description": "Get the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Create private endpoint connection proxy", + "description": "Create the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Delete private endpoint connection proxy", + "description": "Delete the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Redis Enterprise cache private endpoint operation results (read)", + "description": "View the result of private endpoint connection operations in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnections/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connections", + "operation": "Read private endpoint connection", + "description": "Read a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnections/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connections", + "operation": "Write private endpoint connection", + "description": "Write a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnections/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connections", + "operation": "Delete private endpoint connection", + "description": "Delete a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnections/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private endpoint connections", + "operation": "Read private endpoint connection", + "description": "Read a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnections/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private endpoint connections", + "operation": "Write private endpoint connection", + "description": "Write a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnections/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private endpoint connections", + "operation": "Delete private endpoint connection", + "description": "Delete a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redis/privateLinkResources/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private linkable resources", + "operation": "Read Private Linkable Resources", + "description": "Read 'groupId' of redis subresource that a private link can be connected to" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateLinkResources/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private link resources", + "operation": "Read Private Linkable Resources", + "description": "Read 'groupId' of redis subresource that a private link can be connected to" + } + }, + { + "name": "Microsoft.Cache/redis/roles/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Roles", + "operation": "Read Redis Roles", + "description": "Read roles on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roles/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Roles", + "operation": "Update Redis Roles", + "description": "Create or update role on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roles/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Roles", + "operation": "Delete Redis Roles", + "description": "Delete role on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roleAssignments/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Role Description", + "operation": "Read Redis Role Assignments", + "description": "Read role assignments on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roleAssignments/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Role Description", + "operation": "Update Redis Role Assignments", + "description": "Create or update role assignments on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roleAssignments/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Role Description", + "operation": "Delete Redis Role Assignment", + "description": "Delete All Redis Role Assignments" + } + }, + { + "name": "Microsoft.Cache/redis/PrivateEndpointConnectionsApproval/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private linkable resources", + "operation": "Approve Private Endpoint Connections", + "description": "Approve Private Endpoint Connections" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/PrivateEndpointConnectionsApproval/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private link resources", + "operation": "Approve Private Endpoint Connections", + "description": "Approve Private Endpoint Connections" + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json new file mode 100644 index 000000000000..1cc98330011b --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "default": "default", + "api-version": "2022-05-01", + "subscriptionId": "subid", + "parameters": { + "properties": { + "scheduleEntries": [ + { + "dayOfWeek": "Monday", + "startHourUtc": 12, + "maintenanceWindow": "PT5H" + }, + { + "dayOfWeek": "Tuesday", + "startHourUtc": 12 + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/patchSchedules/default", + "location": "East US", + "name": "cachename1/default", + "type": "Microsoft.Cache/Redis/PatchSchedules", + "properties": { + "scheduleEntries": [ + { + "dayOfWeek": "Monday", + "startHourUtc": 12, + "maintenanceWindow": "PT5H" + }, + { + "dayOfWeek": "Tuesday", + "startHourUtc": 12 + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/patchSchedules/default", + "location": "East US", + "name": "cachename1/default", + "type": "Microsoft.Cache/Redis/PatchSchedules", + "properties": { + "scheduleEntries": [ + { + "dayOfWeek": "Monday", + "startHourUtc": 12, + "maintenanceWindow": "PT5H" + }, + { + "dayOfWeek": "Tuesday", + "startHourUtc": 12 + } + ] + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCachePatchSchedulesDelete.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCachePatchSchedulesDelete.json new file mode 100644 index 000000000000..93045330912a --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCachePatchSchedulesDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "default": "default", + "api-version": "2022-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCachePatchSchedulesGet.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCachePatchSchedulesGet.json new file mode 100644 index 000000000000..a945517f3bb9 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCachePatchSchedulesGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "default": "default", + "api-version": "2022-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/patchSchedules/default", + "location": "East US", + "name": "cache1/default", + "type": "Microsoft.Cache/Redis/PatchSchedules", + "properties": { + "scheduleEntries": [ + { + "dayOfWeek": "Monday", + "startHourUtc": 12, + "maintenanceWindow": "PT5H" + }, + { + "dayOfWeek": "Tuesday", + "startHourUtc": 12 + } + ] + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCachePatchSchedulesList.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCachePatchSchedulesList.json new file mode 100644 index 000000000000..188f0e92c22f --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCachePatchSchedulesList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "cacheName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2022-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/patchSchedules/default", + "location": "East US", + "name": "cache1/default", + "type": "Microsoft.Cache/Redis/PatchSchedules", + "properties": { + "scheduleEntries": [ + { + "dayOfWeek": "Monday", + "startHourUtc": 12, + "maintenanceWindow": "PT5H" + }, + { + "dayOfWeek": "Tuesday", + "startHourUtc": 12 + } + ] + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCachePutPrivateEndpointConnection.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCachePutPrivateEndpointConnection.json new file mode 100644 index 000000000000..3f411ee53317 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCachePutPrivateEndpointConnection.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "rgtest01", + "cacheName": "cachetest01", + "privateEndpointConnectionName": "pectest01", + "api-version": "2022-05-01", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cachetest01/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/Redis/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheRegenerateKey.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheRegenerateKey.json new file mode 100644 index 000000000000..617e5c5b408f --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheRegenerateKey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2022-05-01", + "subscriptionId": "subid", + "parameters": { + "keyType": "Primary" + } + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "secondaryKey": "" + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheUpdate.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheUpdate.json new file mode 100644 index 000000000000..49a2c3f2d14e --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/examples/RedisCacheUpdate.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2022-05-01", + "subscriptionId": "subid", + "parameters": { + "properties": { + "enableNonSslPort": true, + "replicasPerPrimary": 2 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "3.0", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": true, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxclients": "1000", + "maxmemory-reserved": "50", + "maxmemory-delta": "50" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "isMaster": false, + "isPrimary": false + } + ] + } + } + }, + "202": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "3.0", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": true, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxclients": "1000", + "maxmemory-reserved": "50", + "maxmemory-delta": "50" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "isMaster": false, + "isPrimary": false + } + ] + } + }, + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/redis.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/redis.json new file mode 100644 index 000000000000..642bceb34615 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2022-05-01/redis.json @@ -0,0 +1,2831 @@ +{ + "swagger": "2.0", + "info": { + "title": "RedisManagementClient", + "description": "REST API for Azure Redis Cache Service.", + "version": "2022-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Cache/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available REST API operations of the Microsoft.Cache provider.", + "operationId": "Operations_List", + "x-ms-examples": { + "RedisCacheOperations": { + "$ref": "./examples/RedisCacheOperations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cache/CheckNameAvailability": { + "post": { + "tags": [ + "Redis" + ], + "operationId": "Redis_CheckNameAvailability", + "x-ms-examples": { + "RedisCacheCheckNameAvailability": { + "$ref": "./examples/RedisCacheCheckNameAvailability.json" + } + }, + "description": "Checks that the redis cache name is valid and is not already in use.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameters" + }, + "description": "Parameters supplied to the CheckNameAvailability Redis operation. The only supported resource type is 'Microsoft.Cache/redis'" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Name is available" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/listUpgradeNotifications": { + "get": { + "tags": [ + "Redis" + ], + "operationId": "Redis_ListUpgradeNotifications", + "x-ms-examples": { + "RedisCacheListUpgradeNotifications": { + "$ref": "./examples/RedisCacheListUpgradeNotifications.json" + } + }, + "description": "Gets any upgrade notifications for a Redis cache.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "history", + "in": "query", + "required": true, + "type": "number", + "format": "double", + "description": "how many minutes in past to look for upgrade notifications" + } + ], + "responses": { + "200": { + "description": "All upgrade notifications in given time range", + "schema": { + "$ref": "#/definitions/NotificationListResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}": { + "put": { + "tags": [ + "Redis" + ], + "operationId": "Redis_Create", + "x-ms-examples": { + "RedisCacheCreateDefaultVersion": { + "$ref": "./examples/RedisCacheCreateDefaultVersion.json" + }, + "RedisCacheCreateLatestVersion": { + "$ref": "./examples/RedisCacheCreateLatestVersion.json" + }, + "RedisCacheCreate": { + "$ref": "./examples/RedisCacheCreate.json" + } + }, + "description": "Create or replace (overwrite/recreate, with potential downtime) an existing Redis cache.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisCreateParameters" + }, + "description": "Parameters supplied to the Create Redis operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The new redis cache was successfully created. Check provisioningState to see detailed status.", + "schema": { + "$ref": "#/definitions/RedisResource" + } + }, + "200": { + "description": "The existing redis cache was successfully updated. Check provisioningState to see detailed status.", + "schema": { + "$ref": "#/definitions/RedisResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Redis" + ], + "operationId": "Redis_Update", + "x-ms-examples": { + "RedisCacheUpdate": { + "$ref": "./examples/RedisCacheUpdate.json" + } + }, + "description": "Update an existing Redis cache.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisUpdateParameters" + }, + "description": "Parameters supplied to the Update Redis operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The existing redis cache was successfully updated. Check provisioningState to see detailed status.", + "schema": { + "$ref": "#/definitions/RedisResource" + } + }, + "202": { + "description": "The existing redis cache was successfully updated. Check Azure-AsyncOperation headers to poll detailed status.", + "schema": { + "$ref": "#/definitions/RedisResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Redis" + ], + "operationId": "Redis_Delete", + "x-ms-examples": { + "RedisCacheDelete": { + "$ref": "./examples/RedisCacheDelete.json" + } + }, + "description": "Deletes a Redis cache.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The redis cache was successfully deleted." + }, + "202": { + "description": "The redis cache 'delete' operation was successfully enqueued; follow the Location header to poll for final outcome." + }, + "204": { + "description": "The redis cache was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Redis" + ], + "operationId": "Redis_Get", + "x-ms-examples": { + "RedisCacheGet": { + "$ref": "./examples/RedisCacheGet.json" + } + }, + "description": "Gets a Redis cache (resource description).", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The redis cache was successfully found.", + "schema": { + "$ref": "#/definitions/RedisResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis": { + "get": { + "tags": [ + "Redis" + ], + "operationId": "Redis_ListByResourceGroup", + "x-ms-examples": { + "RedisCacheListByResourceGroup": { + "$ref": "./examples/RedisCacheListByResourceGroup.json" + } + }, + "description": "Lists all Redis caches in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/RedisListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cache/redis": { + "get": { + "tags": [ + "Redis" + ], + "operationId": "Redis_ListBySubscription", + "x-ms-examples": { + "RedisCacheList": { + "$ref": "./examples/RedisCacheList.json" + } + }, + "description": "Gets all Redis caches in the specified subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/RedisListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/listKeys": { + "post": { + "tags": [ + "Redis" + ], + "operationId": "Redis_ListKeys", + "x-ms-examples": { + "RedisCacheListKeys": { + "$ref": "./examples/RedisCacheListKeys.json" + } + }, + "description": "Retrieve a Redis cache's access keys. This operation requires write permission to the cache resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists the keys for the specified Redis cache.", + "schema": { + "$ref": "#/definitions/RedisAccessKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/regenerateKey": { + "post": { + "tags": [ + "Redis" + ], + "operationId": "Redis_RegenerateKey", + "x-ms-examples": { + "RedisCacheRegenerateKey": { + "$ref": "./examples/RedisCacheRegenerateKey.json" + } + }, + "description": "Regenerate Redis cache's access keys. This operation requires write permission to the cache resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisRegenerateKeyParameters" + }, + "description": "Specifies which key to regenerate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists the regenerated keys for Redis Cache", + "schema": { + "$ref": "#/definitions/RedisAccessKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/forceReboot": { + "post": { + "tags": [ + "Redis" + ], + "operationId": "Redis_ForceReboot", + "x-ms-examples": { + "RedisCacheForceReboot": { + "$ref": "./examples/RedisCacheForceReboot.json" + } + }, + "description": "Reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisRebootParameters" + }, + "description": "Specifies which Redis node(s) to reboot." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Reboot operation successfully enqueued", + "schema": { + "$ref": "#/definitions/RedisForceRebootResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/import": { + "post": { + "tags": [ + "Redis" + ], + "operationId": "Redis_ImportData", + "x-ms-examples": { + "RedisCacheImport": { + "$ref": "./examples/RedisCacheImport.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Import data into Redis cache.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImportRDBParameters" + }, + "description": "Parameters for Redis import operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Import operation successfully enqueued; follow the Location header to poll for final outcome." + }, + "200": { + "description": "Import operation succeeded." + }, + "204": { + "description": "Import operation succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/export": { + "post": { + "tags": [ + "Redis" + ], + "operationId": "Redis_ExportData", + "x-ms-examples": { + "RedisCacheExport": { + "$ref": "./examples/RedisCacheExport.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Export data from the redis cache to blobs in a container.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExportRDBParameters" + }, + "description": "Parameters for Redis export operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Export operation successfully enqueued; follow the Location header to poll for final outcome." + }, + "200": { + "description": "Export operation succeeded." + }, + "204": { + "description": "Export operation succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules": { + "get": { + "tags": [ + "Redis", + "FirewallRules" + ], + "operationId": "FirewallRules_List", + "description": "Gets all firewall rules in the specified redis cache.", + "x-ms-examples": { + "RedisCacheFirewallRulesList": { + "$ref": "./examples/RedisCacheFirewallRulesList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + } + ], + "responses": { + "200": { + "description": "Successfully got the current rules", + "schema": { + "$ref": "#/definitions/RedisFirewallRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules/{ruleName}": { + "put": { + "tags": [ + "Redis", + "FirewallRules" + ], + "operationId": "FirewallRules_CreateOrUpdate", + "description": "Create or update a redis cache firewall rule", + "x-ms-examples": { + "RedisCacheFirewallRuleCreate": { + "$ref": "./examples/RedisCacheFirewallRuleCreate.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the firewall rule." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisFirewallRule" + }, + "description": "Parameters supplied to the create or update redis firewall rule operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Resource was successfully updated", + "schema": { + "$ref": "#/definitions/RedisFirewallRule" + } + }, + "201": { + "description": "Resource was successfully created", + "schema": { + "$ref": "#/definitions/RedisFirewallRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Redis", + "FirewallRules" + ], + "operationId": "FirewallRules_Get", + "description": "Gets a single firewall rule in a specified redis cache.", + "x-ms-examples": { + "RedisCacheFirewallRuleGet": { + "$ref": "./examples/RedisCacheFirewallRuleGet.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the firewall rule." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully found the rule", + "schema": { + "$ref": "#/definitions/RedisFirewallRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Redis", + "FirewallRules" + ], + "operationId": "FirewallRules_Delete", + "description": "Deletes a single firewall rule in a specified redis cache.", + "x-ms-examples": { + "RedisCacheFirewallRuleDelete": { + "$ref": "./examples/RedisCacheFirewallRuleDelete.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the firewall rule." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the rule" + }, + "204": { + "description": "Successfully deleted the rule" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/patchSchedules": { + "get": { + "tags": [ + "Redis", + "PatchSchedules" + ], + "operationId": "PatchSchedules_ListByRedisResource", + "description": "Gets all patch schedules in the specified redis cache (there is only one).", + "x-ms-examples": { + "RedisCachePatchSchedulesList": { + "$ref": "./examples/RedisCachePatchSchedulesList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + } + ], + "responses": { + "200": { + "description": "Successfully got the current patch schedules", + "schema": { + "$ref": "#/definitions/RedisPatchScheduleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/patchSchedules/{default}": { + "put": { + "tags": [ + "Redis", + "PatchSchedules" + ], + "operationId": "PatchSchedules_CreateOrUpdate", + "x-ms-examples": { + "RedisCachePatchSchedulesCreateOrUpdate": { + "$ref": "./examples/RedisCachePatchSchedulesCreateOrUpdate.json" + } + }, + "description": "Create or replace the patching schedule for Redis cache.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "default", + "in": "path", + "required": true, + "type": "string", + "description": "Default string modeled as parameter for auto generation to work correctly.", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "defaultName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisPatchSchedule" + }, + "description": "Parameters to set the patching schedule for Redis cache." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The patch schedule was successfully updated.", + "schema": { + "$ref": "#/definitions/RedisPatchSchedule" + } + }, + "201": { + "description": "The patch schedule was successfully created.", + "schema": { + "$ref": "#/definitions/RedisPatchSchedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Redis", + "PatchSchedules" + ], + "operationId": "PatchSchedules_Delete", + "x-ms-examples": { + "RedisCachePatchSchedulesDelete": { + "$ref": "./examples/RedisCachePatchSchedulesDelete.json" + } + }, + "description": "Deletes the patching schedule of a redis cache.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the redis cache." + }, + { + "name": "default", + "in": "path", + "required": true, + "type": "string", + "description": "Default string modeled as parameter for auto generation to work correctly.", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "defaultName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "204": { + "description": "Success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Redis", + "PatchSchedules" + ], + "operationId": "PatchSchedules_Get", + "x-ms-examples": { + "RedisCachePatchSchedulesGet": { + "$ref": "./examples/RedisCachePatchSchedulesGet.json" + } + }, + "description": "Gets the patching schedule of a redis cache.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the redis cache." + }, + { + "name": "default", + "in": "path", + "required": true, + "type": "string", + "description": "Default string modeled as parameter for auto generation to work correctly.", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "defaultName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Response of get patch schedules.", + "schema": { + "$ref": "#/definitions/RedisPatchSchedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/linkedServers/{linkedServerName}": { + "put": { + "tags": [ + "Redis" + ], + "operationId": "LinkedServer_Create", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "LinkedServer_Create": { + "$ref": "./examples/RedisCacheLinkedServer_Create.json" + } + }, + "description": "Adds a linked server to the Redis cache (requires Premium SKU).", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "linkedServerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the linked server that is being added to the Redis cache." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisLinkedServerCreateParameters" + }, + "description": "Parameters supplied to the Create Linked server operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The linked server was successfully added.", + "schema": { + "$ref": "#/definitions/RedisLinkedServerWithProperties" + } + }, + "201": { + "description": "The linked server was successfully added.", + "schema": { + "$ref": "#/definitions/RedisLinkedServerWithProperties" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Redis" + ], + "operationId": "LinkedServer_Delete", + "x-ms-examples": { + "LinkedServerDelete": { + "$ref": "./examples/RedisCacheLinkedServer_Delete.json" + } + }, + "description": "Deletes the linked server from a redis cache (requires Premium SKU).", + "x-ms-long-running-operation": true, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the redis cache." + }, + { + "name": "linkedServerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the linked server that is being added to the Redis cache." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Linked server was successfully deleted." + }, + "202": { + "description": "The linked server 'delete' operation was successfully enqueued; follow the Location header to poll for final outcome." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Redis" + ], + "operationId": "LinkedServer_Get", + "x-ms-examples": { + "LinkedServer_Get": { + "$ref": "./examples/RedisCacheLinkedServer_Get.json" + } + }, + "description": "Gets the detailed information about a linked server of a redis cache (requires Premium SKU).", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the redis cache." + }, + { + "name": "linkedServerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the linked server." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Response of get linked server.", + "schema": { + "$ref": "#/definitions/RedisLinkedServerWithProperties" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/linkedServers": { + "get": { + "tags": [ + "Redis" + ], + "operationId": "LinkedServer_List", + "x-ms-examples": { + "LinkedServer_List": { + "$ref": "./examples/RedisCacheLinkedServer_List.json" + } + }, + "description": "Gets the list of linked servers associated with this redis cache (requires Premium SKU).", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the redis cache." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Response of get linked servers.", + "schema": { + "$ref": "#/definitions/RedisLinkedServerWithPropertiesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "description": "List all the private endpoint connections associated with the redis cache.", + "x-ms-examples": { + "RedisCacheListPrivateEndpointConnection": { + "$ref": "./examples/RedisCacheListPrivateEndpointConnections.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Successfully retrieved private endpoint connections.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the redis cache.", + "x-ms-examples": { + "RedisCacheGetPrivateEndpointConnection": { + "$ref": "./examples/RedisCacheGetPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the private endpoint connection properties successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Put", + "description": "Update the state of specified private endpoint connection associated with the redis cache.", + "x-ms-examples": { + "RedisCachePutPrivateEndpointConnection": { + "$ref": "./examples/RedisCachePutPrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "The private endpoint connection properties." + } + ], + "responses": { + "201": { + "description": "OK -- Update the private endpoint connection properties successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "description": "Deletes the specified private endpoint connection associated with the redis cache.", + "x-ms-examples": { + "RedisCacheDeletePrivateEndpointConnection": { + "$ref": "./examples/RedisCacheDeletePrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the private endpoint connection successfully." + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_ListByRedisCache", + "description": "Gets the private link resources that need to be created for a redis cache.", + "x-ms-examples": { + "StorageAccountListPrivateLinkResources": { + "$ref": "./examples/RedisCacheListPrivateLinkResources.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cache/locations/{location}/asyncOperations/{operationId}": { + "get": { + "tags": [ + "AsyncOperationStatus" + ], + "operationId": "AsyncOperationStatus_Get", + "description": "For checking the ongoing status of an operation", + "x-ms-examples": { + "RedisCacheAsyncOperationStatus": { + "$ref": "./examples/RedisCacheAsyncOperationStatus.json" + } + }, + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location at which operation was triggered" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of asynchronous operation" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Asynchronous operation status response", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)", + "enum": [ + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "family": { + "type": "string", + "description": "The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).", + "enum": [ + "C", + "P" + ], + "x-ms-enum": { + "name": "SkuFamily", + "modelAsString": true + } + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4)." + } + }, + "required": [ + "name", + "family", + "capacity" + ], + "description": "SKU parameters supplied to the create Redis operation." + }, + "RedisCommonProperties": { + "properties": { + "redisConfiguration": { + "type": "object", + "properties": { + "rdb-backup-enabled": { + "type": "string", + "description": "Specifies whether the rdb backup is enabled" + }, + "rdb-backup-frequency": { + "type": "string", + "description": "Specifies the frequency for creating rdb backup" + }, + "rdb-backup-max-snapshot-count": { + "type": "string", + "description": "Specifies the maximum number of snapshots for rdb backup" + }, + "rdb-storage-connection-string": { + "type": "string", + "description": "The storage account connection string for storing rdb file" + }, + "aof-backup-enabled": { + "type": "string", + "description": "Specifies whether the aof backup is enabled" + }, + "aof-storage-connection-string-0": { + "type": "string", + "description": "First storage account connection string" + }, + "aof-storage-connection-string-1": { + "type": "string", + "description": "Second storage account connection string" + }, + "maxfragmentationmemory-reserved": { + "type": "string", + "description": "Value in megabytes reserved for fragmentation per shard" + }, + "maxmemory-policy": { + "type": "string", + "description": "The eviction strategy used when your data won't fit within its memory limit." + }, + "maxmemory-reserved": { + "type": "string", + "description": "Value in megabytes reserved for non-cache usage per shard e.g. failover." + }, + "maxmemory-delta": { + "type": "string", + "description": "Value in megabytes reserved for non-cache usage per shard e.g. failover." + }, + "maxclients": { + "type": "string", + "description": "The max clients config", + "readOnly": true + }, + "preferred-data-archive-auth-method": { + "type": "string", + "description": "Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS", + "readOnly": true + }, + "preferred-data-persistence-auth-method": { + "type": "string", + "description": "Preferred auth method to communicate to storage account used for data persistence, specify SAS or ManagedIdentity, default value is SAS" + }, + "zonal-configuration": { + "type": "string", + "description": "Zonal Configuration", + "readOnly": true + }, + "authnotrequired": { + "type": "string", + "description": "Specifies whether the authentication is disabled. Setting this property is highly discouraged from security point of view." + } + }, + "additionalProperties": {}, + "description": "All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc." + }, + "redisVersion": { + "type": "string", + "description": "Redis version. This should be in the form 'major[.minor]' (only 'major' is required) or the value 'latest' which refers to the latest stable Redis version that is available. Supported versions: 4.0, 6.0 (latest). Default value is 'latest'." + }, + "enableNonSslPort": { + "type": "boolean", + "default": false, + "description": "Specifies whether the non-ssl Redis server port (6379) is enabled." + }, + "replicasPerMaster": { + "type": "integer", + "format": "int32", + "description": "The number of replicas to be created per primary." + }, + "replicasPerPrimary": { + "type": "integer", + "format": "int32", + "description": "The number of replicas to be created per primary." + }, + "tenantSettings": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "A dictionary of tenant settings" + }, + "shardCount": { + "type": "integer", + "format": "int32", + "description": "The number of shards to be created on a Premium Cluster Cache." + }, + "minimumTlsVersion": { + "type": "string", + "description": "Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')", + "enum": [ + "1.0", + "1.1", + "1.2" + ], + "x-ms-enum": { + "name": "TlsVersion", + "modelAsString": true + } + }, + "publicNetworkAccess": { + "description": "Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Enabled", + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + } + }, + "description": "Create/Update/Get common properties of the redis cache.", + "x-ms-external": true + }, + "RedisCreateProperties": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU of the Redis cache to deploy." + }, + "subnetId": { + "type": "string", + "pattern": "^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$", + "description": "The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1" + }, + "staticIP": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+\\.\\d+$", + "description": "Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "sku" + ], + "allOf": [ + { + "$ref": "#/definitions/RedisCommonProperties" + } + ], + "description": "Properties supplied to Create Redis operation.", + "x-ms-external": true + }, + "RedisUpdateProperties": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU of the Redis cache to deploy." + } + }, + "allOf": [ + { + "$ref": "#/definitions/RedisCommonProperties" + } + ], + "description": "Patchable properties of the redis cache.", + "x-ms-external": true + }, + "RedisProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Redis instance provisioning status.", + "enum": [ + "Creating", + "Deleting", + "Disabled", + "Failed", + "Linking", + "Provisioning", + "RecoveringScaleFailure", + "Scaling", + "Succeeded", + "Unlinking", + "Unprovisioning", + "Updating" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "hostName": { + "readOnly": true, + "type": "string", + "description": "Redis host name." + }, + "port": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Redis non-SSL port." + }, + "sslPort": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Redis SSL port." + }, + "accessKeys": { + "readOnly": true, + "$ref": "#/definitions/RedisAccessKeys", + "description": "The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache" + }, + "linkedServers": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RedisLinkedServer" + }, + "description": "List of the linked servers associated with the cache" + }, + "instances": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RedisInstanceDetails" + }, + "x-ms-identifiers": [ + "shardId" + ], + "description": "List of the Redis instances associated with the cache" + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "List of private endpoint connection associated with the specified redis cache" + } + }, + "allOf": [ + { + "$ref": "#/definitions/RedisCreateProperties" + } + ], + "description": "Properties of the redis cache.", + "x-ms-external": true + }, + "RedisCreateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RedisCreateProperties", + "description": "Redis cache properties." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + } + }, + "required": [ + "properties", + "location" + ], + "description": "Parameters supplied to the Create Redis operation." + }, + "RedisUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RedisUpdateProperties", + "description": "Redis cache properties." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + } + }, + "description": "Parameters supplied to the Update Redis operation." + }, + "RedisAccessKeys": { + "properties": { + "primaryKey": { + "readOnly": true, + "type": "string", + "description": "The current primary key that clients can use to authenticate with Redis cache." + }, + "secondaryKey": { + "readOnly": true, + "type": "string", + "description": "The current secondary key that clients can use to authenticate with Redis cache." + } + }, + "description": "Redis cache access keys." + }, + "RedisFirewallRule": { + "description": "A firewall rule on a redis cache has a name, and describes a contiguous range of IP addresses permitted to connect", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RedisFirewallRuleProperties", + "description": "redis cache firewall rule properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "RedisFirewallRuleCreateParameters": { + "allOf": [ + { + "$ref": "#/definitions/RedisFirewallRule" + } + ], + "description": "Parameters required for creating a firewall rule on redis cache. (Note, you can just use the FirewallRule type instead now.)" + }, + "RedisFirewallRuleProperties": { + "description": "Specifies a range of IP addresses permitted to connect to the cache", + "properties": { + "startIP": { + "type": "string", + "description": "lowest IP address included in the range" + }, + "endIP": { + "type": "string", + "description": "highest IP address included in the range" + } + }, + "required": [ + "startIP", + "endIP" + ] + }, + "RedisFirewallRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RedisFirewallRule" + }, + "description": "Results of the list firewall rules operation." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link for next page of results." + } + }, + "description": "The response of list firewall rules Redis operation." + }, + "RedisResource": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RedisProperties", + "description": "Redis cache properties." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "description": "A single Redis item in List or Get Operation." + }, + "RedisInstanceDetails": { + "properties": { + "sslPort": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Redis instance SSL port." + }, + "nonSslPort": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "If enableNonSslPort is true, provides Redis instance Non-SSL port." + }, + "zone": { + "readOnly": true, + "type": "string", + "description": "If the Cache uses availability zones, specifies availability zone where this instance is located." + }, + "shardId": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "If clustering is enabled, the Shard ID of Redis Instance" + }, + "isMaster": { + "readOnly": true, + "type": "boolean", + "description": "Specifies whether the instance is a primary node." + }, + "isPrimary": { + "readOnly": true, + "type": "boolean", + "description": "Specifies whether the instance is a primary node." + } + }, + "description": "Details of single instance of redis." + }, + "RedisListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RedisResource" + }, + "description": "List of Redis cache instances." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link for next page of results." + } + }, + "description": "The response of list Redis operation." + }, + "RedisRegenerateKeyParameters": { + "properties": { + "keyType": { + "type": "string", + "description": "The Redis access key to regenerate.", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "RedisKeyType", + "modelAsString": false + } + } + }, + "required": [ + "keyType" + ], + "description": "Specifies which Redis access keys to reset." + }, + "RedisRebootParameters": { + "properties": { + "rebootType": { + "type": "string", + "description": "Which Redis node(s) to reboot. Depending on this value data loss is possible.", + "enum": [ + "PrimaryNode", + "SecondaryNode", + "AllNodes" + ], + "x-ms-enum": { + "name": "RebootType", + "modelAsString": true + } + }, + "shardId": { + "type": "integer", + "format": "int32", + "description": "If clustering is enabled, the ID of the shard to be rebooted." + }, + "ports": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "A list of redis instances to reboot, specified by per-instance SSL ports or non-SSL ports." + } + }, + "description": "Specifies which Redis node(s) to reboot." + }, + "ExportRDBParameters": { + "properties": { + "format": { + "type": "string", + "description": "File format." + }, + "prefix": { + "type": "string", + "description": "Prefix to use for exported files." + }, + "container": { + "type": "string", + "description": "Container name to export to." + }, + "preferred-data-archive-auth-method": { + "type": "string", + "description": "Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS" + } + }, + "required": [ + "container", + "prefix" + ], + "description": "Parameters for Redis export operation." + }, + "ImportRDBParameters": { + "properties": { + "format": { + "type": "string", + "description": "File format." + }, + "files": { + "type": "array", + "description": "files to import.", + "items": { + "type": "string" + } + }, + "preferred-data-archive-auth-method": { + "type": "string", + "description": "Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS" + } + }, + "required": [ + "files" + ], + "description": "Parameters for Redis import operation." + }, + "ScheduleEntry": { + "properties": { + "dayOfWeek": { + "type": "string", + "description": "Day of the week when a cache can be patched.", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday", + "Everyday", + "Weekend" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + }, + "startHourUtc": { + "type": "integer", + "format": "int32", + "description": "Start hour after which cache patching can start." + }, + "maintenanceWindow": { + "type": "string", + "format": "duration", + "description": "ISO8601 timespan specifying how much time cache patching can take. " + } + }, + "required": [ + "dayOfWeek", + "startHourUtc" + ], + "description": "Patch schedule entry for a Premium Redis Cache." + }, + "ScheduleEntries": { + "properties": { + "scheduleEntries": { + "x-ms-client-name": "ScheduleEntries", + "type": "array", + "items": { + "$ref": "#/definitions/ScheduleEntry" + }, + "x-ms-identifiers": [], + "description": "List of patch schedules for a Redis cache." + } + }, + "required": [ + "scheduleEntries" + ], + "description": "List of patch schedules for a Redis cache." + }, + "RedisPatchSchedule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScheduleEntries", + "description": "List of patch schedules for a Redis cache." + }, + "location": { + "type": "string", + "description": "The geo-location where the resource lives", + "readOnly": true + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Response to put/get patch schedules for Redis cache." + }, + "RedisPatchScheduleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RedisPatchSchedule" + }, + "description": "Results of the list patch schedules operation." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link for next page of results." + } + }, + "description": "The response of list patch schedules Redis operation." + }, + "RedisForceRebootResponse": { + "properties": { + "message": { + "readOnly": true, + "type": "string", + "description": "Status message" + } + }, + "description": "Response to force reboot for Redis cache." + }, + "RedisLinkedServer": { + "description": "Linked server Id", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Linked server Id." + } + } + }, + "RedisLinkedServerWithProperties": { + "description": "Response to put/get linked server (with properties) for Redis cache.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RedisLinkedServerProperties", + "description": "Properties of the linked server." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "RedisLinkedServerProperties": { + "description": "Properties of a linked server to be returned in get/put response", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Terminal state of the link between primary and secondary redis cache." + } + }, + "allOf": [ + { + "$ref": "#/definitions/RedisLinkedServerCreateProperties" + } + ] + }, + "RedisLinkedServerWithPropertiesList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RedisLinkedServerWithProperties" + }, + "description": "List of linked servers (with properties) of a Redis cache." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link for next set." + } + }, + "description": "List of linked servers (with properties) of a Redis cache." + }, + "RedisLinkedServerCreateProperties": { + "description": "Create properties for a linked server", + "properties": { + "linkedRedisCacheId": { + "type": "string", + "description": "Fully qualified resourceId of the linked redis cache." + }, + "linkedRedisCacheLocation": { + "type": "string", + "description": "Location of the linked redis cache.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "serverRole": { + "type": "string", + "description": "Role of the linked server.", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "ReplicationRole", + "modelAsString": false + } + } + }, + "required": [ + "linkedRedisCacheId", + "linkedRedisCacheLocation", + "serverRole" + ] + }, + "RedisLinkedServerCreateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RedisLinkedServerCreateProperties", + "description": "Properties required to create a linked server." + } + }, + "required": [ + "properties" + ], + "description": "Parameter required for creating a linked server to redis cache." + }, + "Operation": { + "description": "REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that describes the operation.", + "properties": { + "provider": { + "description": "Friendly name of the resource provider", + "type": "string" + }, + "operation": { + "description": "Operation type: read, write, delete, listKeys/action, etc.", + "type": "string" + }, + "resource": { + "description": "Resource type on which the operation is performed.", + "type": "string" + }, + "description": { + "description": "Friendly name of the operation", + "type": "string" + } + } + } + } + }, + "OperationListResult": { + "description": "Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of operations supported by the resource provider." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "CheckNameAvailabilityParameters": { + "description": "Parameters body to pass for resource name availability check.", + "properties": { + "name": { + "type": "string", + "description": "Resource name." + }, + "type": { + "type": "string", + "description": "Resource type. The only legal value of this property for checking redis cache name availability is 'Microsoft.Cache/redis'." + } + }, + "required": [ + "name", + "type" + ] + }, + "UpgradeNotification": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of upgrade notification." + }, + "timestamp": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Timestamp when upgrade notification occurred." + }, + "upsellNotification": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Details about this upgrade notification" + } + }, + "description": "Properties of upgrade notification." + }, + "NotificationListResponse": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/UpgradeNotification" + }, + "x-ms-identifiers": [ + "name", + "timestamp" + ], + "description": "List of all notifications." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link for next set of notifications." + } + }, + "description": "The response of listUpgradeNotifications." + }, + "OperationStatus": { + "type": "object", + "description": "Asynchronous operation status", + "properties": { + "properties": { + "description": "Additional properties from RP, only when operation is successful", + "type": "object", + "additionalProperties": {} + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationStatusResult" + } + ], + "x-ms-external": true + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/specification/redis/resource-manager/readme.md b/specification/redis/resource-manager/readme.md index 064f9e8ee99f..dd41d11d6764 100644 --- a/specification/redis/resource-manager/readme.md +++ b/specification/redis/resource-manager/readme.md @@ -26,18 +26,27 @@ These are the global settings for the Redis API. ``` yaml openapi-type: arm -tag: package-2021-06 +tag: package-2022-05 ``` +### Tag: package-2022-05 + +These settings apply only when `--tag=package-2022-05` is specified on the command line. + +```yaml $(tag) == 'package-2022-05' +input-file: + - Microsoft.Cache/stable/2022-05-01/redis.json +``` ### Tag: package-2021-06 These settings apply only when `--tag=package-2021-06` is specified on the command line. -```yaml $(tag) == 'package-2021-06' +``` yaml $(tag) == 'package-2021-06' input-file: - Microsoft.Cache/stable/2021-06-01/redis.json ``` + ### Tag: package-2020-12 These settings apply only when `--tag=package-2020-12` is specified on the command line.