{ "swagger": "2.0", "info": { "title": "RedisManagementClient", "description": "REST API for Azure Redis Cache Service.", "version": "2018-03-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", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Success. The response describes the list of operations.", "schema": { "$ref": "#/definitions/OperationListResult" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Cache/CheckNameAvailability": { "post": { "tags": [ "Redis" ], "operationId": "Redis_CheckNameAvailability", "x-ms-examples": { "RedisCacheList": { "$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" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/listUpgradeNotifications": { "get": { "tags": [ "Redis" ], "operationId": "Redis_ListUpgradeNotifications", "x-ms-examples": { "RedisCacheGet": { "$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" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}": { "put": { "tags": [ "Redis" ], "operationId": "Redis_Create", "x-ms-examples": { "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" } } } }, "patch": { "tags": [ "Redis" ], "operationId": "Redis_Update", "x-ms-examples": { "RedisCacheUpdate": { "$ref": "./examples/RedisCacheUpdate.json" } }, "description": "Update an existing 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/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" } } } }, "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." } } }, "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" } } } } }, "/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" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Cache/Redis": { "get": { "tags": [ "Redis" ], "operationId": "Redis_List", "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" } } }, "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" } } } } }, "/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" } } } } }, "/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" } } } } }, "/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." } } } }, "/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." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules": { "get": { "tags": [ "Redis", "FirewallRules" ], "operationId": "FirewallRules_ListByRedisResource", "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" } } }, "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/RedisFirewallRuleCreateParameters" }, "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" } } } }, "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" } } } }, "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" } } } }, "/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" } } }, "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" } } } }, "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." } } }, "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" } } } } }, "/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" } } } }, "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).", "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." } } }, "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" } } } } }, "/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" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "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, 5)." } }, "required": [ "name", "family", "capacity" ], "description": "SKU parameters supplied to the create Redis operation." }, "RedisCommonProperties": { "properties": { "redisConfiguration": { "type": "object", "additionalProperties": { "type": "string" }, "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." }, "enableNonSslPort": { "type": "boolean", "description": "Specifies whether the non-ssl Redis server port (6379) is enabled." }, "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 } } }, "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. Required when deploying a Redis cache inside an existing Azure Virtual Network." } }, "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": { "redisVersion": { "readOnly": true, "type": "string", "description": "Redis version." }, "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" } }, "allOf": [ { "$ref": "#/definitions/RedisCreateProperties" } ], "description": "Properties of the redis cache.", "x-ms-external": true }, "Resource": { "description": "The Resource definition.", "properties": { "id": { "readOnly": true, "type": "string", "description": "Resource ID." }, "name": { "readOnly": true, "type": "string", "description": "Resource name." }, "type": { "readOnly": true, "type": "string", "description": "Resource type." } }, "x-ms-azure-resource": true }, "ProxyResource": { "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", "allOf": [ { "$ref": "#/definitions/Resource" } ] }, "TrackedResource": { "description": "The resource model definition for a ARM tracked top level resource", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" }, "x-ms-mutability": [ "read", "create", "update" ], "description": "Resource tags." }, "location": { "type": "string", "x-ms-mutability": [ "read", "create" ], "description": "The geo-location where the resource lives" } }, "required": [ "location" ], "allOf": [ { "$ref": "#/definitions/Resource" } ] }, "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." } }, "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." } }, "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": "#/definitions/ProxyResource" } ] }, "RedisFirewallRuleCreateParameters": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/RedisFirewallRuleProperties", "description": "Properties required to create a firewall rule ." } }, "required": [ "properties" ], "description": "Parameters required for creating a firewall rule on redis cache." }, "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." } }, "required": [ "properties" ], "allOf": [ { "$ref": "#/definitions/TrackedResource" } ], "description": "A single Redis item in List or Get Operation." }, "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." } }, "required": [ "rebootType" ], "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." } }, "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" } } }, "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 Redis Cache." }, "ScheduleEntries": { "properties": { "scheduleEntries": { "x-ms-client-name": "ScheduleEntries", "type": "array", "items": { "$ref": "#/definitions/ScheduleEntry" }, "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." } }, "required": [ "properties" ], "allOf": [ { "$ref": "#/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": "#/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." }, "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" }, "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" }, "description": "List of all notifications." }, "nextLink": { "type": "string", "readOnly": true, "description": "Link for next set of notifications." } }, "description": "The response of listUpgradeNotifications." } }, "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." } } }