How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Caches API

The Caches API from Microsoft Azure — 13 operation(s) for caches.

Microsoft Azure Caches API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Caches. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 16 operations across 13 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

16 operations 13 paths 26 schemas 1 DELETE3 GET1 PATCH10 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 16

Across 13 paths, the API surfaces 16 operations — 1 DELETE, 3 GET, 1 PATCH, 10 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Caches 16
GET
/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/caches
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Storagecache Caches
microsoftAzureCachesList 2 params → 200default
GET
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches
microsoftAzureCachesListbyresourcegroup 3 params → 200default
DELETE
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename
microsoftAzureCachesDelete 4 params → 200202204default
GET
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename
microsoftAzureCachesGet 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename
microsoftAzureCachesCreateorupdate 4 params body → 200201202default
PATCH
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename
microsoftAzureCachesUpdate 4 params body → 200202default
POST
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/debugInfo
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Debuginfo
microsoftAzureCachesDebuginfo 4 params → 200202204default
POST
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/flush
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Flush
microsoftAzureCachesFlush 4 params → 200202204default
POST
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/start
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Start
microsoftAzureCachesStart 4 params → 200202204default
POST
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/stop
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Stop
microsoftAzureCachesStop 4 params → 200202204default
POST
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/startPrimingJob
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Startprimingjob
microsoftAzureCachesStartprimingjob 4 params body → 202default
POST
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/stopPrimingJob
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Stopprimingjob
microsoftAzureCachesStopprimingjob 4 params body → 202204default
POST
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/pausePrimingJob
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Pauseprimingjob
microsoftAzureCachesPauseprimingjob 4 params body → 202204default
POST
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/resumePrimingJob
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Resumeprimingjob
microsoftAzureCachesResumeprimingjob 4 params body → 202204default
POST
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/upgrade
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Upgrade
microsoftAzureCachesUpgradefirmware 4 params → 201202204default
POST
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/spaceAllocation
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Spaceallocation
microsoftAzureCachesSpaceallocation 4 params body → 202default

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are CacheUsernameDownloadSettings (12 properties), Cache (9 properties), NfsAccessRule (8 properties), CacheActiveDirectorySettings (7 properties). Each schema is shown below with its type and property counts.

CacheNetworkSettings
object
Cache network settings.
5 properties
CacheHealth
object
An indication of cache health. Gives more information about health than just that related to provisioning.
3 properties
NfsAccessRule
object
Rule to place restrictions on portions of the cache namespace being presented to clients.
8 properties 2 required
CachesListResult
object
Result of the request to list caches. It contains a list of caches and a URL link to get the next set of results.
2 properties
StorageTargetSpaceAllocation
object
Storage Target space allocation properties.
2 properties
PrimingJobList
array
The list of priming jobs defined for the cache.
KeyVaultKeyReference
object
Describes a reference to key vault key.
2 properties 2 required
CacheUpgradeStatus
object
Properties describing the software upgrade state of the cache.
5 properties
ResourceName
string
Schema for the name of resources served by this provider. Note that objects will contain an odata @id annotation as appropriate. This will contain the complete…
CacheActiveDirectorySettings
object
Active Directory settings used to join a cache to a domain.
7 properties 4 required
CacheDirectorySettings
object
Cache Directory Services settings.
2 properties
SpaceAllocationList
array
List of storage target space allocations.
URLString
string
A fully qualified URL.
PrimingJob
object
A priming job instance.
7 properties 2 required
CacheUsernameDownloadSettings
object
Settings for Extended Groups username and group download.
12 properties
CloudErrorBody
object
An error response.
4 properties
SpaceAllocationParameter
array
List of storage target space allocations.
Condition
object
Outstanding conditions that will need to be resolved.
2 properties
CloudError
object
An error response.
1 property
CacheEncryptionSettings
object
Cache encryption settings.
2 properties
NfsAccessPolicy
object
A set of rules describing access policies applied to NFSv3 clients of the cache.
2 properties 2 required
Cache
object
A cache instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md
9 properties
CacheUpgradeSettings
object
Cache Upgrade Settings.
2 properties
CacheSecuritySettings
object
Cache security settings.
1 property
PrimingJobIdParameter
object
Object containing the priming job ID.
1 property 1 required
CacheIdentity
object
Cache identity properties.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-caches-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Caches API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.