Microsoft Azure Cache For Redis Access Policy Assignments API

openapi: 3.2.0
info:
  title: RedisEnterpriseManagementClient Access Policy Assignments…
  version: '2026-09-01'
  description: REST API for managing Redis Enterprise resources in Azure.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: AccessPolicyAssignments
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/accessPolicyAssignments
  : get:
      operationId: AccessPolicyAssignment_List
      tags:
      - AccessPolicyAssignments
      description: Gets all access policy assignments..
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: clusterName
        in: path
        description: The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
        required: true
        schema:
          type: string
          pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
      - name: databaseName
        in: path
        description: The name of the Redis Enterprise database.
        required: true
        schema:
          type: string
          pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessPolicyAssignmentList'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Access policy assignment list
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/accessPolicyAssignments/{accessPolicyAssignmentName}
  : get:
      operationId: AccessPolicyAssignment_Get
      tags:
      - AccessPolicyAssignments
      description: Gets information about access policy assignment for database.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: clusterName
        in: path
        description: The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
        required: true
        schema:
          type: string
          pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
      - name: databaseName
        in: path
        description: The name of the Redis Enterprise database.
        required: true
        schema:
          type: string
          pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
      - name: accessPolicyAssignmentName
        in: path
        description: The name of the Redis Enterprise database access policy assignment.
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9]{1,60}$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessPolicyAssignment'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Access policy assignment get
      x-summary-source: derived
    put:
      operationId: AccessPolicyAssignment_CreateUpdate
      tags:
      - AccessPolicyAssignments
      description: Creates/Updates a particular access policy assignment for a database
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: clusterName
        in: path
        description: The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
        required: true
        schema:
          type: string
          pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
      - name: databaseName
        in: path
        description: The name of the Redis Enterprise database.
        required: true
        schema:
          type: string
          pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
      - name: accessPolicyAssignmentName
        in: path
        description: The name of the Redis Enterprise database access policy assignment.
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9]{1,60}$
      responses:
        '200':
          description: Resource 'AccessPolicyAssignment' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessPolicyAssignment'
        '201':
          description: Resource 'AccessPolicyAssignment' create operation succeeded
          headers:
            Azure-AsyncOperation:
              description: A link to the status monitor
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessPolicyAssignment'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: original-uri
        final-state-schema: '#/definitions/AccessPolicyAssignment'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccessPolicyAssignment'
        description: Parameters supplied to the create access policy assignment for database.
        required: true
      summary: Access policy assignment create update
      x-summary-source: derived
    delete:
      operationId: AccessPolicyAssignment_Delete
      tags:
      - AccessPolicyAssignments
      description: Deletes a single access policy assignment.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: clusterName
        in: path
        description: The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
        required: true
        schema:
          type: string
          pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
      - name: databaseName
        in: path
        description: The name of the Redis Enterprise database.
        required: true
        schema:
          type: string
          pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
      - name: accessPolicyAssignmentName
        in: path
        description: The name of the Redis Enterprise database access policy assignment.
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9]{1,60}$
      responses:
        '202':
          description: Resource deletion accepted.
          headers:
            Azure-AsyncOperation:
              description: A link to the status monitor
              schema:
                type: string
                format: uri
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      summary: Access policy assignment delete
      x-summary-source: derived
components:
  schemas:
    AccessPolicyAssignmentList:
      type: object
      description: The response of a list-all operation.
      properties:
        value:
          type: array
          description: The AccessPolicyAssignment items on this page
          items:
            $ref: '#/components/schemas/AccessPolicyAssignment'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    AccessPolicyAssignment:
      type: object
      description: Describes the access policy assignment of Redis Enterprise database
      properties:
        properties:
          $ref: '#/components/schemas/AccessPolicyAssignmentProperties'
          description: Properties of the access policy assignment.
          x-ms-client-flatten: true
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
    AccessPolicyAssignmentPropertiesUser:
      type: object
      description: The user associated with the access policy.
      properties:
        objectId:
          type: string
          description: The object ID of the user.
    ProxyResource:
      type: object
      title: Proxy Resource
      description: The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
      allOf:
      - $ref: '#/components/schemas/Resource'
    ErrorResponse:
      type: object
      title: Error response
      description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: The error object.
    Resource:
      type: object
      title: Resource
      description: Common fields that are returned in the response for all Azure Resource Manager resources
      properties:
        id:
          type: string
          format: arm-id
          description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
          readOnly: true
        name:
          type: string
          description: The name of the resource
          readOnly: true
        type:
          type: string
          description: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
          readOnly: true
        systemData:
          $ref: '#/components/schemas/systemData'
          description: Azure Resource Manager metadata containing createdBy and modifiedBy information.
          readOnly: true
      x-ms-azure-resource: true
    AccessPolicyAssignmentProperties:
      type: object
      description: Properties of Redis Enterprise database access policy assignment.
      properties:
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          description: Current provisioning status of the access policy assignment.
          readOnly: true
        accessPolicyName:
          type: string
          description: Name of access policy under specific access policy assignment. Only "default" policy is supported for now.
          pattern: ^([a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]|[a-zA-Z0-9])$
        user:
          $ref: '#/components/schemas/AccessPolicyAssignmentPropertiesUser'
          description: The user associated with the access policy.
      required:
      - accessPolicyName
      - user
    ProvisioningState:
      type: string
      description: Current provisioning status
      enum:
      - Succeeded
      - Failed
      - Canceled
      - Creating
      - Updating
      - Deleting
      x-ms-enum:
        name: ProvisioningState
        modelAsString: true
        values:
        - name: Succeeded
          value: Succeeded
          description: Succeeded
        - name: Failed
          value: Failed
          description: Failed
        - name: Canceled
          value: Canceled
          description: Canceled
        - name: Creating
          value: Creating
          description: Creating
        - name: Updating
          value: Updating
          description: Updating
        - name: Deleting
          value: Deleting
          description: Deleting
  parameters:
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group. The name is case insensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription. The value must be an UUID.
      required: true
      schema:
        type: string
        format: uuid
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.