RedisCacheAccessPolicy

{
  "$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-cache-access-policy-schema.json",
  "title": "RedisCacheAccessPolicy",
  "description": "Response to get/put access policy.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/microsoft-azure-cache-for-redis-rediscacheaccesspolicies-api-openapi.yml#/components/schemas/RedisCacheAccessPolicy",
  "type": "object",
  "properties": {
    "properties": {
      "$ref": "#/$defs/RedisCacheAccessPolicyProperties",
      "description": "Properties of an access policy.",
      "x-ms-client-flatten": true
    }
  },
  "allOf": [
    {
      "$ref": "../../../../../../common-types/resource-management/v4/types.json#/definitions/ProxyResource"
    }
  ],
  "$defs": {
    "AccessPolicyProvisioningState": {
      "type": "string",
      "description": "Provisioning state of access policy",
      "enum": [
        "Updating",
        "Succeeded",
        "Deleting",
        "Deleted",
        "Canceled",
        "Failed"
      ],
      "x-ms-enum": {
        "name": "AccessPolicyProvisioningState",
        "modelAsString": true,
        "values": [
          {
            "name": "Updating",
            "value": "Updating",
            "description": "An operation is in progress."
          },
          {
            "name": "Succeeded",
            "value": "Succeeded",
            "description": "The operation succeeded."
          },
          {
            "name": "Deleting",
            "value": "Deleting",
            "description": "A delete operation is in progress."
          },
          {
            "name": "Deleted",
            "value": "Deleted",
            "description": "The access policy is considered deleted, if it still exists."
          },
          {
            "name": "Canceled",
            "value": "Canceled",
            "description": "The operation was canceled. Access policies may be in a partially updated state. Update them again to have a well-defined state."
          },
          {
            "name": "Failed",
            "value": "Failed",
            "description": "The operation failed. Access policies may be in a partially updated state. Update them again to have a well-defined state."
          }
        ]
      }
    },
    "AccessPolicyType": {
      "type": "string",
      "description": "Built-In or Custom access policy",
      "enum": [
        "Custom",
        "BuiltIn"
      ],
      "x-ms-enum": {
        "name": "AccessPolicyType",
        "modelAsString": true,
        "values": [
          {
            "name": "Custom",
            "value": "Custom",
            "description": "User-configurable access policy, using the redis access policy authoring language"
          },
          {
            "name": "BuiltIn",
            "value": "BuiltIn",
            "description": "Built-in or well-known access policies, whose policy is not configurable."
          }
        ]
      }
    },
    "RedisCacheAccessPolicyProperties": {
      "type": "object",
      "description": "All properties of an access policy.",
      "properties": {
        "provisioningState": {
          "$ref": "#/$defs/AccessPolicyProvisioningState",
          "description": "Provisioning state of access policy",
          "readOnly": true
        },
        "type": {
          "$ref": "#/$defs/AccessPolicyType",
          "description": "Built-In or Custom access policy",
          "readOnly": true
        },
        "permissions": {
          "type": "string",
          "description": "Permissions for the access policy. Learn how to configure permissions at https://aka.ms/redis/AADPreRequisites"
        }
      },
      "required": [
        "permissions"
      ]
    }
  }
}