Microsoft Azure Cache For Redis · Schema
RedisResource
A single Redis item in List or Get Operation.
Microsoft AzureCacheCloud InfrastructureDatastoreIn-Memory DatabaseManaged ServiceMicrosoftRedis
Properties
| Name | Type | Description |
|---|---|---|
| properties | object | Redis cache properties. |
| zones | array | The availability zones. |
| identity | object | The managed service identities assigned to this resource. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/microsoft-azure-cache-for-redis/json-schema/microsoft-azure-cache-for-redis-redis-resource-schema.json",
"title": "RedisResource",
"description": "A single Redis item in List or Get Operation.",
"x-generated": "2026-11-05",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/_superseded/microsoft-azure-cache-for-redis-redisresources-api-openapi.yml#/components/schemas/RedisResource",
"type": "object",
"properties": {
"properties": {
"$ref": "#/$defs/RedisProperties",
"description": "Redis cache properties.",
"x-ms-client-flatten": true
},
"zones": {
"type": "array",
"description": "The availability zones.",
"items": {
"type": "string"
}
},
"identity": {
"$ref": "../../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity",
"description": "The managed service identities assigned to this resource."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v4/types.json#/definitions/TrackedResource"
}
],
"$defs": {
"ProvisioningState": {
"type": "string",
"description": "Redis instance provisioning status.",
"enum": [
"Creating",
"Deleting",
"Disabled",
"Failed",
"Linking",
"Provisioning",
"RecoveringScaleFailure",
"Scaling",
"Succeeded",
"Unlinking",
"Unprovisioning",
"Updating",
"ConfiguringAAD"
],
"x-ms-enum": {
"name": "ProvisioningState",
"modelAsString": true,
"values": [
{
"name": "Creating",
"value": "Creating",
"description": "A create operation is in progress."
},
{
"name": "Deleting",
"value": "Deleting",
"description": "A delete operation is in progress."
},
{
"name": "Disabled",
"value": "Disabled",
"description": "The cache is disabled and cannot be used."
},
{
"name": "Failed",
"value": "Failed",
"description": "An operation such as create or update failed. If you failed to create the cache it will not be in a usable state, so you should delete and recreate it."
},
{
"name": "Linking",
"value": "Linking",
"description": "Georeplication link is in progress"
},
{
"name": "Provisioning",
"value": "Provisioning",
"description": "An operation is in progress"
},
{
"name": "RecoveringScaleFailure",
"value": "RecoveringScaleFailure",
"description": "A scaling operation encountered an error and recovery is in progress."
},
{
"name": "Scaling",
"value": "Scaling",
"description": "A scaling operation is in progress"
},
{
"name": "Succeeded",
"value": "Succeeded",
"description": "The most recent operation successfully completed"
},
{
"name": "Unlinking",
"value": "Unlinking",
"description": "Georeplication unlink is in progress"
},
{
"name": "Unprovisioning",
"value": "Unprovisioning",
"description": "The cache may be being disabled"
},
{
"name": "Updating",
"value": "Updating",
"description": "An update operation is in progress."
},
{
"name": "ConfiguringAAD",
"value": "ConfiguringAAD",
"description": "An AAD configuration update operation is in progress."
}
]
}
},
"PublicNetworkAccess": {
"type": "string",
"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"
],
"x-ms-enum": {
"name": "PublicNetworkAccess",
"modelAsString": true,
"values": [
{
"name": "Enabled",
"value": "Enabled",
"description": "Public internet access to the cache, via its public IP address, is enabled. Connections may use any network path."
},
{
"name": "Disabled",
"value": "Disabled",
"description": "Public internet access to the cache, via its public IP address, is disabled. Connections must use be made via private endpoints."
}
]
}
},
"RedisAccessKeys": {
"type": "object",
"description": "Redis cache access keys.",
"properties": {
"primaryKey": {
"type": "string",
"description": "The current primary key that clients can use to authenticate with Redis cache.",
"readOnly": true
},
"secondaryKey": {
"type": "string",
"description": "The current secondary key that clients can use to authenticate with Redis cache.",
"readOnly": true
}
}
},
"RedisCommonProperties": {
"type": "object",
"description": "Create/Update/Get common properties of the redis cache.",
"properties": {
"redisConfiguration": {
"$ref": "#/$defs/RedisCommonPropertiesRedisConfiguration",
"description": "All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta, maxmemory-policy,notify-keyspace-events, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 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",
"description": "Specifies whether the non-ssl Redis server port (6379) is enabled.",
"default": false
},
"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",
"description": "A dictionary of tenant settings",
"additionalProperties": {
"type": "string"
}
},
"shardCount": {
"type": "integer",
"format": "int32",
"description": "The number of shards to be created on a Premium Cluster Cache."
},
"minimumTlsVersion": {
"$ref": "#/$defs/TlsVersion",
"description": "Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')"
},
"publicNetworkAccess": {
"$ref": "#/$defs/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."
},
"updateChannel": {
"$ref": "#/$defs/UpdateChannel",
"description": "Optional: Specifies the update channel for the monthly Redis updates your Redis Cache will receive. Caches using 'Preview' update channel get latest Redis updates at least 4 weeks ahead of 'Stable' channel caches. Default value is 'Stable'."
},
"disableAccessKeyAuthentication": {
"type": "boolean",
"description": "Authentication to Redis through access keys is disabled when set as true. Default value is false.",
"default": false
},
"zonalAllocationPolicy": {
"$ref": "#/$defs/ZonalAllocationPolicy",
"description": "Optional: Specifies how availability zones are allocated to the Redis cache. 'Automatic' enables zone redundancy and Azure will automatically select zones based on regional availability and capacity. 'UserDefined' will select availability zones passed in by you using the 'zones' parameter. 'NoZones' will produce a non-zonal cache. If 'zonalAllocationPolicy' is not passed, it will be set to 'UserDefined' when zones are passed in, otherwise, it will be set to 'Automatic' in regions where zones are supported and 'NoZones' in regions where zones are not supported."
}
},
"x-ms-external": true
},
"RedisCommonPropertiesRedisConfiguration": {
"type": "object",
"description": "All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta, maxmemory-policy,notify-keyspace-events, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 etc.",
"properties": {
"rdb-backup-enabled": {
"type": "string",
"description": "Specifies whether the RDB backup is enabled",
"x-ms-client-name": "rdbBackupEnabled"
},
"rdb-backup-frequency": {
"type": "string",
"description": "Specifies the frequency for creating rdb backup in minutes. Valid values: (15, 30, 60, 360, 720, 1440)",
"x-ms-client-name": "rdbBackupFrequency"
},
"rdb-backup-max-snapshot-count": {
"type": "string",
"description": "Specifies the maximum number of snapshots for rdb backup",
"x-ms-client-name": "rdbBackupMaxSnapshotCount"
},
"rdb-storage-connection-string": {
"type": "string",
"description": "The storage account connection string for storing rdb file",
"x-ms-client-name": "rdbStorageConnectionString"
},
"aof-backup-enabled": {
"type": "string",
"description": "Specifies whether the aof backup is enabled",
"x-ms-client-name": "aofBackupEnabled"
},
"aof-storage-connection-string-0": {
"type": "string",
"description": "First storage account connection string",
"x-ms-client-name": "aofStorageConnectionString0"
},
"aof-storage-connection-string-1": {
"type": "string",
"description": "Second storage account connection string",
"x-ms-client-name": "aofStorageConnectionString1"
},
"maxfragmentationmemory-reserved": {
"type": "string",
"description": "Value in megabytes reserved for fragmentation per shard",
"x-ms-client-name": "maxfragmentationmemoryReserved"
},
"maxmemory-policy": {
"type": "string",
"description": "The eviction strategy used when your data won't fit within its memory limit.",
"x-ms-client-name": "maxmemoryPolicy"
},
"maxmemory-reserved": {
"type": "string",
"description": "Value in megabytes reserved for non-cache usage per shard e.g. failover.",
"x-ms-client-name": "maxmemoryReserved"
},
"maxmemory-delta": {
"type": "string",
"description": "Value in megabytes reserved for non-cache usage per shard e.g. failover.",
"x-ms-client-name": "maxmemoryDelta"
},
"maxclients": {
"type": "string",
"description": "The max clients config",
"readOnly": true
},
"notify-keyspace-events": {
"type": "string",
"description": "The keyspace events which should be monitored.",
"x-ms-client-name": "notifyKeyspaceEvents"
},
"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,
"x-ms-client-name": "preferredDataArchiveAuthMethod"
},
"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",
"x-ms-client-name": "preferredDataPersistenceAuthMethod"
},
"zonal-configuration": {
"type": "string",
"description": "Zonal Configuration",
"readOnly": true,
"x-ms-client-name": "zonalConfiguration"
},
"authnotrequired": {
"type": "string",
"description": "Specifies whether the authentication is disabled. Setting this property is highly discouraged from security point of view; you should never disable authentication using this property!"
},
"storage-subscription-id": {
"type": "string",
"description": "SubscriptionId of the storage account for persistence (aof/rdb) using ManagedIdentity.",
"x-ms-client-name": "storageSubscriptionId"
},
"aad-enabled": {
"type": "string",
"description": "Specifies whether AAD based authentication has been enabled or disabled for the cache",
"x-ms-client-name": "aadEnabled"
}
},
"additionalProperties": {}
},
"RedisCreateProperties": {
"type": "object",
"description": "Properties supplied to Create Redis operation.",
"properties": {
"sku": {
"$ref": "#/$defs/Sku",
"description": "The SKU of the Redis cache to deploy."
},
"subnetId": {
"type": "string",
"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",
"pattern": "^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$"
},
"staticIP": {
"type": "string",
"description": "Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default.",
"pattern": "^\\d+\\.\\d+\\.\\d+\\.\\d+$",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"sku"
],
"allOf": [
{
"$ref": "#/$defs/RedisCommonProperties"
}
],
"x-ms-external": true
},
"RedisInstanceDetails": {
"type": "object",
"description": "Details of single instance of redis.",
"properties": {
"sslPort": {
"type": "integer",
"format": "int32",
"description": "Redis instance SSL port.",
"readOnly": true
},
"nonSslPort": {
"type": "integer",
"format": "int32",
"description": "If enableNonSslPort is true, provides Redis instance Non-SSL port.",
"readOnly": true
},
"zone": {
"type": "string",
"description": "If the Cache uses availability zones, specifies availability zone where this instance is located.",
"readOnly": true
},
"shardId": {
"type": "integer",
"format": "int32",
"description": "If clustering is enabled, the Shard ID of Redis Instance",
"readOnly": true
},
"isMaster": {
"type": "boolean",
"description": "Specifies whether the instance is a primary node.",
"readOnly": true
},
"isPrimary": {
"type": "boolean",
"description": "Specifies whether the instance is a primary node.",
"readOnly": true
}
}
},
"RedisLinkedServer": {
"type": "object",
"description": "Linked server Id",
"properties": {
"id": {
"type": "string",
"description": "Linked server Id.",
"readOnly": true
}
}
},
"RedisProperties": {
"type": "object",
"description": "Properties of the redis cache.",
"properties": {
"provisioningState": {
"$ref": "#/$defs/ProvisioningState",
"description": "Redis instance provisioning status.",
"readOnly": true
},
"hostName": {
"type": "string",
"description": "Redis host name.",
"readOnly": true
},
"port": {
"type": "integer",
"format": "int32",
"description": "Redis non-SSL port.",
"readOnly": true
},
"sslPort": {
"type": "integer",
"format": "int32",
"description": "Redis SSL port.",
"readOnly": true
},
"accessKeys": {
"$ref": "#/$defs/RedisAccessKeys",
"description": "The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache",
"readOnly": true
},
"linkedServers": {
"type": "array",
"description": "List of the linked servers associated with the cache",
"items": {
"$ref": "#/$defs/RedisLinkedServer"
},
"readOnly": true
},
"instances": {
"type": "array",
"description": "List of the Redis instances associated with the cache",
"items": {
"$ref": "#/$defs/RedisInstanceDetails"
},
"readOnly": true,
"x-ms-identifiers": [
"shardId"
]
},
"privateEndpointConnections": {
"type": "array",
"description": "List of private endpoint connection associated with the specified redis cache",
"items": {
"$ref": "../../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpointConnection"
},
"readOnly": true
}
},
"allOf": [
{
"$ref": "#/$defs/RedisCreateProperties"
}
],
"x-ms-external": true
},
"Sku": {
"type": "object",
"description": "SKU parameters supplied to the create Redis operation.",
"properties": {
"name": {
"$ref": "#/$defs/SkuName",
"description": "The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)"
},
"family": {
"$ref": "#/$defs/SkuFamily",
"description": "The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium)."
},
"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"
]
},
"SkuFamily": {
"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,
"values": [
{
"name": "C",
"value": "C",
"description": "The SKU family to use - must be 'C' for Basic/Standard SKU redis caches."
},
{
"name": "P",
"value": "P",
"description": "The SKU family to use - must be 'P' for Premium SKU redis caches."
}
]
}
},
"SkuName": {
"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,
"values": [
{
"name": "Basic",
"value": "Basic",
"description": "The well known 'Basic' SKU for Azure Cache for Redis. Basic SKU does not have an availability SLA."
},
{
"name": "Standard",
"value": "Standard",
"description": "The well known 'Standard' SKU for Azure Cache for Redis. Standard SKU has an availability SLA."
},
{
"name": "Premium",
"value": "Premium",
"description": "The well known 'Premium' SKU for Azure Cache for Redis. Premium SKU has an availability SLA, and higher performance tiers and more features compared with Standard SKU."
}
]
}
},
"TlsVersion": {
"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,
"values": [
{
"name": "1.0",
"value": "1.0",
"description": "TLS protocol version 1.0 -- deprecated for security reasons. Do not use this value for new caches."
},
{
"name": "1.1",
"value": "1.1",
"description": "TLS protocol version 1.1 -- deprecated for security reasons. Do not use this value for new caches."
},
{
"name": "1.2",
"value": "1.2",
"description": "TLS protocol version 1.2 -- use this value, or higher, for new caches. Or do not specify, so that your cache uses the recommended default value"
}
]
}
},
"UpdateChannel": {
"type": "string",
"description": "Optional: Specifies the update channel for the monthly Redis updates your Redis Cache will receive. Caches using 'Preview' update channel get latest Redis updates at least 4 weeks ahead of 'Stable' channel caches. Default value is 'Stable'.",
"enum": [
"Stable",
"Preview"
],
"x-ms-enum": {
"name": "UpdateChannel",
"modelAsString": true,
"values": [
{
"name": "Stable",
"value": "Stable",
"description": "Stable channel receives updates, which may include important security and stability updates, later than Preview channel."
},
{
"name": "Preview",
"value": "Preview",
"description": "Preview channel normally receives updates before Stable channel, and is the recommended channel for non-production workloads."
}
]
}
},
"ZonalAllocationPolicy": {
"type": "string",
"description": "Optional: Specifies how availability zones are allocated to the Redis cache. 'Automatic' enables zone redundancy and Azure will automatically select zones based on regional availability and capacity. 'UserDefined' will select availability zones passed in by you using the 'zones' parameter. 'NoZones' will produce a non-zonal cache. If 'zonalAllocationPolicy' is not passed, it will be set to 'UserDefined' when zones are passed in, otherwise, it will be set to 'Automatic' in regions where zones are supported and 'NoZones' in regions where zones are not supported.",
"enum": [
"Automatic",
"UserDefined",
"NoZones"
],
"x-ms-enum": {
"name": "ZonalAllocationPolicy",
"modelAsString": true,
"values": [
{
"name": "Automatic",
"value": "Automatic",
"description": "The zones for the cache will be selected automatically based on availability and capacity."
},
{
"name": "UserDefined",
"value": "UserDefined",
"description": "UserDefined means the zones for the cache are manually configured using the 'zones' property, and can not be automatically selected."
},
{
"name": "NoZones",
"value": "NoZones",
"description": "The cache will not use multiple availability zones."
}
]
}
}
}
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/microsoft-azure-cache-for-redis-redis-resource"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.