Microsoft Azure Cache For Redis

Microsoft Azure Cache For Redis Migrations API

The Migrations API from Microsoft Azure Cache For Redis — 5 operation(s) for migrations.

GitHub OpenAPI

Operations 6

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/migrations Migrations list #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/migrations/default Migrations get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/migrations/default Migrations start #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/migrations/default/cancel Migrations undo #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/migrations/default/unlinkMigratedEndpoint Migrations unlink migrated endpoint #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/migrations/default/validate Migrations validate #

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/rest/api/redis/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/microsoft-azure-cache-for-redis/openapi/microsoft-azure-cache-for-redis-migrations-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-cache-for-redis/json-schema/microsoft-azure-cache-for-redis-migration-validation-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-cache-for-redis/json-schema/microsoft-azure-cache-for-redis-migration-validation-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-cache-for-redis/json-schema/microsoft-azure-cache-for-redis-migration-undo-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-cache-for-redis/json-schema/microsoft-azure-cache-for-redis-migration-list-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-cache-for-redis/json-schema/microsoft-azure-cache-for-redis-migration-schema.json

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/microsoft-azure-cache-for-redis:microsoft-azure-cache-for-redis-migrations-api"
All apis 
curl "https://apis.io/api/v1/apis?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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-azure-cache-for-redis-migrations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: RedisEnterpriseManagementClient Migrations API
  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: Migrations
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/migrations
  : get:
      operationId: Migrations_List
      tags:
      - Migrations
      description: Gets information about all migrations attempts in a Redis Enterprise cluster.
      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]+)*$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MigrationList'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Migrations list
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/migrations/default
  : get:
      operationId: Migrations_Get
      tags:
      - Migrations
      description: Gets information about a migration in a Redis Enterprise cluster.
      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]+)*$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Migration'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Migrations get
      x-summary-source: derived
    put:
      operationId: Migrations_Start
      tags:
      - Migrations
      description: Starts a new migration
      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]+)*$
      responses:
        '200':
          description: The request has succeeded.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Migration'
        '201':
          description: The request has succeeded and a new resource has been created as a result.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Migration'
        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/Migration'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Migration'
        description: Parameters supplied to start a migration operation.
        required: true
      summary: Migrations start
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/migrations/default/cancel
  : post:
      operationId: Migrations_Undo
      tags:
      - Migrations
      description: Cancel or rollback the migration operation in a Redis Enterprise cluster.
      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]+)*$
      responses:
        '202':
          description: Resource operation 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
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MigrationUndoRequest'
        description: Parameters supplied to undo a migration operation.
      summary: Migrations undo
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/migrations/default/unlinkMigratedEndpoint
  : post:
      operationId: Migrations_UnlinkMigratedEndpoint
      tags:
      - Migrations
      description: Unlinks the migrated endpoint from the Azure Managed Redis cluster that was migrated from Azure Cache for Redis, removing the source cache endpoint that was redirected to this cluster during migration.
      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]+)*$
      responses:
        '202':
          description: Resource operation 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
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Migrations unlink migrated endpoint
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/migrations/default/validate
  : post:
      operationId: Migrations_Validate
      tags:
      - Migrations
      description: Validates if a source Azure Cache for Redis resource can be migrated to a target Azure Managed Redis resource.
      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]+)*$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MigrationValidationResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MigrationValidationRequest'
        description: Parameters supplied to validate a migration operation.
        required: true
      summary: Migrations validate
      x-summary-source: derived
components:
  schemas:
    MigrationValidationWarning:
      type: object
      description: Represents a validation warning that may impact migration.
      properties:
        disparities:
          type: array
          description: List of specific disparities that cause this warning.
          items:
            $ref: '#/components/schemas/MigrationValidationDisparity'
          x-ms-identifiers: []
      required:
      - disparities
    MigrationValidationRequest:
      type: object
      description: Properties for validating migration from Azure Cache for Redis to Redis Enterprise.
      properties:
        sourceResourceId:
          type: string
          format: arm-id
          description: The source resource ID to validate migration from. This is the resource ID of the Azure Cache for Redis.
          x-ms-arm-id-details:
            allowedResources:
            - type: Microsoft.Cache/redis
        skipDataMigration:
          type: boolean
          description: Sets whether the data is migrated from source to target or not. The default value is true.
      required:
      - sourceResourceId
    MigrationList:
      type: object
      description: The response of a list-all migrations.
      properties:
        value:
          type: array
          description: The Migration items on this page
          items:
            $ref: '#/components/schemas/Migration'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    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'
    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
    MigrationRollbackReason:
      type: string
      description: The reason a migration operation is being undone (rolled back).
      enum:
      - performance
      - compatibility
      - clientConnection
      - cost
      - testing
      - stability
      - dataLoss
      - other
      x-ms-enum:
        name: MigrationRollbackReason
        modelAsString: false
        values:
        - name: Performance
          value: performance
          description: The target cache did not meet the expected performance characteristics.
        - name: Compatibility
          value: compatibility
          description: The target cache was not compatible with the client application or workload.
        - name: ClientConnection
          value: clientConnection
          description: The client application was unable to connect to the target cache.
        - name: Cost
          value: cost
          description: The target cache did not meet the expected cost characteristics.
        - name: Testing
          value: testing
          description: The migration was performed as a test and is being reverted.
        - name: Stability
          value: stability
          description: The target cache did not meet the expected stability characteristics.
        - name: DataLoss
          value: dataLoss
          description: Data was lost during or after the migration.
        - name: Other
          value: other
          description: The migration is being undone for a reason not covered by the other values.
    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.
    SourceType:
      type: string
      description: Describes the source of the migration operation.
      enum:
      - AzureCacheForRedis
      x-ms-enum:
        name: SourceType
        modelAsString: true
        values:
        - name: AzureCacheForRedis
          value: AzureCacheForRedis
          description: Migration from Azure Cache for Redis to Redis Enterprise.
    Migration:
      type: object
      description: Describes the current migration operation on a Redis Enterprise cluster.
      properties:
        properties:
          $ref: '#/components/schemas/MigrationProperties'
          description: Properties of the migration operation.
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
    MigrationProvisioningState:
      type: string
      description: Current provisioning status
      enum:
      - Accepted
      - InProgress
      - ReadyForDnsSwitch
      - Succeeded
      - Failed
      - Cancelling
      - Cancelled
      - CancellationFailed
      - Unlinking
      - Unlinked
      - UnlinkFailed
      x-ms-enum:
        name: MigrationProvisioningState
        modelAsString: true
        values:
        - name: Accepted
          value: Accepted
          description: The request has been accepted and the migration operation is being initialized.
        - name: InProgress
          value: InProgress
          description: The migration operation is in progress.
        - name: ReadyForDnsSwitch
          value: ReadyForDnsSwitch
          description: The migration operation has completed transferring data and is ready for DNS switch.
        - name: Succeeded
          value: Succeeded
          description: The migration operation has completed successfully.
        - name: Failed
          value: Failed
          description: The migration operation has failed.
        - name: Cancelling
          value: Cancelling
          description: The migration operation is being cancelled.
        - name: Cancelled
          value: Cancelled
          description: The migration operation has been cancelled.
        - name: CancellationFailed
          value: CancellationFailed
          description: The migration operation cancellation has failed.
        - name: Unlinking
          value: Unlinking
          description: The migrated endpoint is being unlinked from the cluster.
        - name: Unlinked
          value: Unlinked
          description: The migrated endpoint has been unlinked from the cluster.
        - name: UnlinkFailed
          value: UnlinkFailed
          description: Unlinking the migrated endpoint from the cluster has failed.
    MigrationValidationResponse:
      type: object
      description: Response for migration validation operation.
      properties:
        isValid:
          type: boolean
          description: Indicates whether the migration validation passed.
        errors:
          type: array
          description: List of validation errors that prevent migration.
          items:
            $ref: '#/components/schemas/MigrationValidationError'
          x-ms-identifiers: []
        warnings:
          type: array
          description: List of validation warnings that may impact migration.
          items:
            $ref: '#/components/schemas/MigrationValidationWarning'
          x-ms-identifiers: []
      required:
      - isValid
    MigrationValidationError:
      type: object
      description: Represents a validation error that prevents migration.
      properties:
        disparities:
          type: array
          description: List of specific disparities that cause this error.
          items:
            $ref: '#/components/schemas/MigrationValidationDisparity'
          x-ms-identifiers: []
      required:
      - disparities
    MigrationValidationDisparity:
      type: object
      description: Represents a specific validation issue found during migration validation.
      properties:
        category:
          type: string
          description: A localized string denoting the category of the validation issue. Examples are "Region", "Data", "Identity", "Clustering Mode", and "TLS".
        message:
          type: string
          description: Detailed message describing the validation issue.
      required:
      - category
      - message
    MigrationProperties:
      type: object
      description: Properties for Redis Enterprise migration operation.
      properties:
        sourceType:
          $ref: '#/components/schemas/SourceType'
          description: Describes the source of the migration operation.
        targetResourceId:
          type: string
          format: arm-id
          description: The Azure resource ID of the Azure Managed Redis destination cache to migrate.
          readOnly: true
          x-ms-arm-id-details:
            allowedResources:
            - type: Microsoft.Cache/redisEnterprise
        provisioningState:
          $ref: '#/components/schemas/MigrationProvisioningState'
          description: Current provisioning status of the migration
          readOnly: true
        statusDetails:
          type:
          - string
          - 'null'
          description: Additional details about the migration operation's status in free text format.
          readOnly: true
        creationTime:
          type: string
          format: date-time
          description: The timestamp when the migration operation was created.
          readOnly: true
        lastModifiedTime:
          type: string
          format: date-time
          description: The timestamp when the migration operation was last updated.
          readOnly: true
        rollbackEligibleUntil:
          type: string
          format: date-time
          description: The timestamp until which a successful migration remains eligible to be undone (rolled back) to the source cache. This property is only returned while the migration is in the Succeeded state, and is calculated from the time the migration succeeded plus the rollback window. After this time the source cache is released and the migration can no longer be undone.
          readOnly: true
      discriminator:
        propertyName: sourceType
      required:
      - sourceType
    MigrationUndoRequest:
      type: object
      description: Parameters supplied to the undo migration operation.
      properties:
        rollbackReason:
          $ref: '#/components/schemas/MigrationRollbackReason'
          description: The reason for undoing (rolling back) the migration. Choose the value that best describes why the rollback is needed. This information helps us improve the migration experience and does not change how the rollback is performed.
  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.