Microsoft Azure

Azure Cache for Redis

REST API for Azure Redis Cache Service.

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

REST API for Azure Redis Cache Service.

Endpoints 41

Operations

  • GETOperations_List/providers/Microsoft.Cache/operationsList the operations for the provider

RedisResources

  • GETRedis_ListBySubscription/subscriptions/:subscriptionId/providers/Microsoft.Cache/redisGets all Redis caches in the specified subscription.
  • GETRedis_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redisLists all Redis caches in a resource group.
  • GETRedis_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:nameGets a Redis cache (resource description).
  • PUTRedis_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:nameCreate or replace (overwrite/recreate, with potential downtime) an existing Redis cache.
  • DELETERedis_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:nameDeletes a Redis cache.
  • PATCHRedis_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:nameUpdate an existing Redis cache.
  • POSTRedis_ExportData/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:name/exportExport data from the redis cache to blobs in a container.
  • POSTRedis_FlushCache/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:cacheName/flushDeletes all of the keys in a cache.
  • POSTRedis_ForceReboot/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:name/forceRebootReboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss.
  • POSTRedis_ImportData/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:name/importImport data into Redis cache.
  • POSTRedis_ListKeys/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:name/listKeysRetrieve a Redis cache's access keys. This operation requires write permission to the cache resource.
  • GETRedis_ListUpgradeNotifications/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:name/listUpgradeNotifications?history=0.0[Deprecated] Gets any upgrade notifications for a Redis cache.
  • GETPrivateLinkResources_ListByRedisCache/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:cacheName/privateLinkResourcesGets the private link resources that need to be created for a redis cache.
  • POSTRedis_RegenerateKey/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:name/regenerateKeyRegenerate Redis cache's access keys. This operation requires write permission to the cache resource.

RedisFirewallRules

  • GETFirewallRules_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:cacheName/firewallRulesGets all firewall rules in the specified redis cache.
  • GETFirewallRules_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:cacheName/firewallRules/:ruleNameGets a single firewall rule in a specified redis cache.
  • PUTFirewallRules_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:cacheName/firewallRules/:ruleNameCreate or update a redis cache firewall rule
  • DELETEFirewallRules_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:cacheName/firewallRules/:ruleNameDeletes a single firewall rule in a specified redis cache.

RedisPatchSchedules

  • GETPatchSchedules_ListByRedisResource/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:cacheName/patchSchedulesGets all patch schedules in the specified redis cache (there is only one).
  • GETPatchSchedules_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:name/patchSchedules/:defaultGets the patching schedule of a redis cache.
  • PUTPatchSchedules_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:name/patchSchedules/:defaultCreate or replace the patching schedule for Redis cache.
  • DELETEPatchSchedules_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:name/patchSchedules/:defaultDeletes the patching schedule of a redis cache.

LinkedServer

  • GETLinkedServer_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:name/linkedServersGets the list of linked servers associated with this redis cache (requires Premium SKU).
  • GETLinkedServer_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:name/linkedServers/:linkedServerNameGets the detailed information about a linked server of a redis cache (requires Premium SKU).
  • PUTLinkedServer_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:name/linkedServers/:linkedServerNameAdds a linked server to the Redis cache (requires Premium SKU).
  • DELETELinkedServer_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:name/linkedServers/:linkedServerNameDeletes the linked server from a redis cache (requires Premium SKU).

PrivateEndpointConnections

  • GETPrivateEndpointConnections_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:cacheName/privateEndpointConnectionsList all the private endpoint connections associated with the redis cache.
  • GETPrivateEndpointConnections_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:cacheName/privateEndpointConnections/:privateEndpointConnectionNameGets the specified private endpoint connection associated with the redis cache.
  • PUTPrivateEndpointConnections_Put/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:cacheName/privateEndpointConnections/:privateEndpointConnectionNameUpdate the state of specified private endpoint connection associated with the redis cache.
  • DELETEPrivateEndpointConnections_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:cacheName/privateEndpointConnections/:privateEndpointConnectionNameDeletes the specified private endpoint connection associated with the redis cache.

RedisCacheAccessPolicies

  • GETAccessPolicy_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:cacheName/accessPoliciesGets the list of access policies associated with this redis cache
  • GETAccessPolicy_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:cacheName/accessPolicies/:accessPolicyNameGets the detailed information about an access policy of a redis cache
  • PUTAccessPolicy_CreateUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:cacheName/accessPolicies/:accessPolicyNameAdds an access policy to the redis cache
  • DELETEAccessPolicy_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:cacheName/accessPolicies/:accessPolicyNameDeletes the access policy from a redis cache

RedisCacheAccessPolicyAssignments

  • GETAccessPolicyAssignment_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:cacheName/accessPolicyAssignmentsGets the list of access policy assignments associated with this redis cache
  • GETAccessPolicyAssignment_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:cacheName/accessPolicyAssignments/:accessPolicyAssignmentNameGets the list of assignments for an access policy of a redis cache
  • PUTAccessPolicyAssignment_CreateUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:cacheName/accessPolicyAssignments/:accessPolicyAssignmentNameAdds the access policy assignment to the specified users
  • DELETEAccessPolicyAssignment_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Cache/redis/:cacheName/accessPolicyAssignments/:accessPolicyAssignmentNameDeletes the access policy assignment from a redis cache
  • POSTRedis_CheckNameAvailability/subscriptions/:subscriptionId/providers/Microsoft.Cache/checkNameAvailabilityChecks that the redis cache name is valid and is not already in use.
  • GETAsyncOperationStatus_Get/subscriptions/:subscriptionId/providers/Microsoft.Cache/locations/:location/asyncOperations/:operationIdFor checking the ongoing status of an operation

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
41 operations on 26 pathsGET 19PUT 7POST 7DELETE 7PATCH 1
Main resources
RedisResources 14LinkedServer 4PrivateEndpointConnections 4RedisCacheAccessPolicies 4RedisCacheAccessPolicyAssignments 4RedisFirewallRules 4RedisPatchSchedules 4Operations 1
Response formats
application/json
Description format
Swagger 2.0, API version 2024-11-01

How to test the Azure Cache for Redis in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Cache for Redis collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Operations_List” (GET /providers/Microsoft.Cache/operations), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Cache for Redis?

REST API for Azure Redis Cache Service. It is listed under Developer tools and has 41 endpoints.

Who publishes the Azure Cache for Redis?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Cache for Redis?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Cache for Redis?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Cache for Redis have?

41 operations on 26 paths (19 GET, 7 PUT, 7 POST, 7 DELETE, 1 PATCH). The largest groups are RedisResources, LinkedServer, PrivateEndpointConnections, RedisCacheAccessPolicies.

Is forking the Azure Cache for Redis free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.