{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-redis","description":"RedisManagementClient","version":"2018-03-01","base_url":"https://management.azure.com","endpoints":26,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api RedisManagementClient\n@base https://management.azure.com\n@version 2018-03-01\n@auth OAuth2\n@common_fields {api-version: any # Client Api Version., subscriptionId: any # Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.}\n@endpoints 26\n@hint download_for_search\n@toc providers(1), subscriptions(25)\n\n@group providers\n@endpoint GET /providers/Microsoft.Cache/operations\n@desc Lists all of the available REST API operations of the Microsoft.Cache provider.\n@returns(200) Success. The response describes the list of operations.\n\n@endgroup\n\n@group subscriptions\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.Cache/CheckNameAvailability\n@desc Checks that the redis cache name is valid and is not already in use.\n@required {parameters: any # Parameters supplied to the CheckNameAvailability Redis operation. The only supported resource type is 'Microsoft.Cache/redis'}\n@returns(200) Name is available\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/listUpgradeNotifications\n@desc Gets any upgrade notifications for a Redis cache.\n@required {resourceGroupName: any # The name of the resource group., name: any # The name of the Redis cache., history: any # how many minutes in past to look for upgrade notifications}\n@returns(200) All upgrade notifications in given time range\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}\n@desc Create or replace (overwrite/recreate, with potential downtime) an existing Redis cache.\n@required {resourceGroupName: any # The name of the resource group., name: any # The name of the Redis cache., parameters: any # Parameters supplied to the Create Redis operation.}\n@returns(200) The existing redis cache was successfully updated. Check provisioningState to see detailed status.\n@returns(201) The new redis cache was successfully created. Check provisioningState to see detailed status.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}\n@desc Update an existing Redis cache.\n@required {resourceGroupName: any # The name of the resource group., name: any # The name of the Redis cache., parameters: any # Parameters supplied to the Update Redis operation.}\n@returns(200) The existing redis cache was successfully updated. Check provisioningState to see detailed status.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}\n@desc Deletes a Redis cache.\n@required {resourceGroupName: any # The name of the resource group., name: any # The name of the Redis cache.}\n@returns(200) The redis cache was successfully deleted.\n@returns(202) The redis cache 'delete' operation was successfully enqueued; follow the Location header to poll for final outcome.\n@returns(204) The redis cache was successfully deleted.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}\n@desc Gets a Redis cache (resource description).\n@required {resourceGroupName: any # The name of the resource group., name: any # The name of the Redis cache.}\n@returns(200) The redis cache was successfully found.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis\n@desc Lists all Redis caches in a resource group.\n@required {resourceGroupName: any # The name of the resource group.}\n@returns(200)\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Cache/Redis\n@desc Gets all Redis caches in the specified subscription.\n@returns(200)\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/listKeys\n@desc Retrieve a Redis cache's access keys. This operation requires write permission to the cache resource.\n@required {resourceGroupName: any # The name of the resource group., name: any # The name of the Redis cache.}\n@returns(200) Lists the keys for the specified Redis cache.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/regenerateKey\n@desc Regenerate Redis cache's access keys. This operation requires write permission to the cache resource.\n@required {resourceGroupName: any # The name of the resource group., name: any # The name of the Redis cache., parameters: any # Specifies which key to regenerate.}\n@returns(200) Lists the regenerated keys for Redis Cache\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/forceReboot\n@desc Reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss.\n@required {resourceGroupName: any # The name of the resource group., name: any # The name of the Redis cache., parameters: any # Specifies which Redis node(s) to reboot.}\n@returns(200) Reboot operation successfully enqueued\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/import\n@desc Import data into Redis cache.\n@required {resourceGroupName: any # The name of the resource group., name: any # The name of the Redis cache., parameters: any # Parameters for Redis import operation.}\n@returns(200) Import operation succeeded.\n@returns(202) Import operation successfully enqueued; follow the Location header to poll for final outcome.\n@returns(204) Import operation succeeded.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/export\n@desc Export data from the redis cache to blobs in a container.\n@required {resourceGroupName: any # The name of the resource group., name: any # The name of the Redis cache., parameters: any # Parameters for Redis export operation.}\n@returns(200) Export operation succeeded.\n@returns(202) Export operation successfully enqueued; follow the Location header to poll for final outcome.\n@returns(204) Export operation succeeded.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules\n@desc Gets all firewall rules in the specified redis cache.\n@required {resourceGroupName: any # The name of the resource group., cacheName: any # The name of the Redis cache.}\n@returns(200) Successfully got the current rules\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules/{ruleName}\n@desc Create or update a redis cache firewall rule\n@required {resourceGroupName: any # The name of the resource group., cacheName: any # The name of the Redis cache., ruleName: any # The name of the firewall rule., parameters: any # Parameters supplied to the create or update redis firewall rule operation.}\n@returns(200) Resource was successfully updated\n@returns(201) Resource was successfully created\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules/{ruleName}\n@desc Gets a single firewall rule in a specified redis cache.\n@required {resourceGroupName: any # The name of the resource group., cacheName: any # The name of the Redis cache., ruleName: any # The name of the firewall rule.}\n@returns(200) Successfully found the rule\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules/{ruleName}\n@desc Deletes a single firewall rule in a specified redis cache.\n@required {resourceGroupName: any # The name of the resource group., cacheName: any # The name of the Redis cache., ruleName: any # The name of the firewall rule.}\n@returns(200) Successfully deleted the rule\n@returns(204) Successfully deleted the rule\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/patchSchedules\n@desc Gets all patch schedules in the specified redis cache (there is only one).\n@required {resourceGroupName: any # The name of the resource group., cacheName: any # The name of the Redis cache.}\n@returns(200) Successfully got the current patch schedules\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/{default}\n@desc Create or replace the patching schedule for Redis cache.\n@required {resourceGroupName: any # The name of the resource group., name: any # The name of the Redis cache., default: any # Default string modeled as parameter for auto generation to work correctly., parameters: any # Parameters to set the patching schedule for Redis cache.}\n@returns(200) The patch schedule was successfully updated.\n@returns(201) The patch schedule was successfully created.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/{default}\n@desc Deletes the patching schedule of a redis cache.\n@required {resourceGroupName: any # The name of the resource group., name: any # The name of the redis cache., default: any # Default string modeled as parameter for auto generation to work correctly.}\n@returns(200) Success.\n@returns(204) Success.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/{default}\n@desc Gets the patching schedule of a redis cache.\n@required {resourceGroupName: any # The name of the resource group., name: any # The name of the redis cache., default: any # Default string modeled as parameter for auto generation to work correctly.}\n@returns(200) Response of get patch schedules.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/linkedServers/{linkedServerName}\n@desc Adds a linked server to the Redis cache (requires Premium SKU).\n@required {resourceGroupName: any # The name of the resource group., name: any # The name of the Redis cache., linkedServerName: any # The name of the linked server that is being added to the Redis cache., parameters: any # Parameters supplied to the Create Linked server operation.}\n@returns(200) The linked server was successfully added.\n@returns(201) The linked server was successfully added.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/linkedServers/{linkedServerName}\n@desc Deletes the linked server from a redis cache (requires Premium SKU).\n@required {resourceGroupName: any # The name of the resource group., name: any # The name of the redis cache., linkedServerName: any # The name of the linked server that is being added to the Redis cache.}\n@returns(200) Linked server was successfully deleted.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/linkedServers/{linkedServerName}\n@desc Gets the detailed information about a linked server of a redis cache (requires Premium SKU).\n@required {resourceGroupName: any # The name of the resource group., name: any # The name of the redis cache., linkedServerName: any # The name of the linked server.}\n@returns(200) Response of get linked server.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/linkedServers\n@desc Gets the list of linked servers associated with this redis cache (requires Premium SKU).\n@required {resourceGroupName: any # The name of the resource group., name: any # The name of the redis cache.}\n@returns(200) Response of get linked servers.\n\n@endgroup\n\n@end\n"}