swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector RedisEnterprise API
schemes:
- https
tags:
- name: RedisEnterprise
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}:
    put:
      tags:
      - RedisEnterprise
      operationId: microsoftAzureRedisenterpriseCreate
      x-ms-examples:
        RedisEnterpriseCreate:
          $ref: ./examples/RedisEnterpriseCreate.json
      description: Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: original-uri
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/Cluster'
        description: Parameters supplied to the Create RedisEnterprise operation.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The cluster was/is being updated. Check provisioningState and resourceState to see detailed status.
          schema:
            $ref: '#/definitions/Cluster'
        '201':
          description: The cluster was/is being created. Check provisioningState and resourceState to see detailed status.
          schema:
            $ref: '#/definitions/Cluster'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername
    patch:
      tags:
      - RedisEnterprise
      operationId: microsoftAzureRedisenterpriseUpdate
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        RedisEnterpriseUpdate:
          $ref: ./examples/RedisEnterpriseUpdate.json
      description: Updates an existing RedisEnterprise cluster
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/ClusterUpdate'
        description: Parameters supplied to the Update RedisEnterprise operation.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The cluster was/is being updated. Check provisioningState and resourceState to see detailed status.
          schema:
            $ref: '#/definitions/Cluster'
        '202':
          description: The cluster update operation was started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername
    delete:
      tags:
      - RedisEnterprise
      operationId: microsoftAzureRedisenterpriseDelete
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        RedisEnterpriseDelete:
          $ref: ./examples/RedisEnterpriseDelete.json
      description: Deletes a RedisEnterprise cache cluster.
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The cluster was successfully deleted.
        '202':
          description: The cluster delete operation was successfully started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status.
        '204':
          description: The cluster was successfully deleted.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername
    get:
      tags:
      - RedisEnterprise
      operationId: microsoftAzureRedisenterpriseGet
      x-ms-examples:
        RedisEnterpriseGet:
          $ref: ./examples/RedisEnterpriseGet.json
      description: Gets information about a RedisEnterprise cluster
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The request succeeded, response body contains the requested details.
          schema:
            $ref: '#/definitions/Cluster'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise:
    get:
      tags:
      - RedisEnterprise
      operationId: microsoftAzureRedisenterpriseListbyresourcegroup
      x-ms-examples:
        RedisEnterpriseListByResourceGroup:
          $ref: ./examples/RedisEnterpriseListByResourceGroup.json
      description: Lists all RedisEnterprise clusters in a resource group.
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The list of RedisEnterprise clusters
          schema:
            $ref: '#/definitions/ClusterList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise
  /subscriptions/{subscriptionId}/providers/Microsoft.Cache/redisEnterprise:
    get:
      tags:
      - RedisEnterprise
      operationId: microsoftAzureRedisenterpriseList
      x-ms-examples:
        RedisEnterpriseList:
          $ref: ./examples/RedisEnterpriseList.json
      description: Gets all RedisEnterprise clusters in the specified subscription.
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The list of RedisEnterprise clusters
          schema:
            $ref: '#/definitions/ClusterList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Cache Redisenterprise
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases
  : get:
      tags:
      - RedisEnterprise
      operationId: microsoftAzureDatabasesListbycluster
      description: Gets all databases in the specified RedisEnterprise cluster.
      x-ms-examples:
        RedisEnterpriseDatabasesListByCluster:
          $ref: ./examples/RedisEnterpriseDatabasesListByCluster.json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      responses:
        '200':
          description: The list of databases
          schema:
            $ref: '#/definitions/DatabaseList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}
  : put:
      tags:
      - RedisEnterprise
      operationId: microsoftAzureDatabasesCreate
      description: Creates a database
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: original-uri
      x-ms-examples:
        RedisEnterpriseDatabasesCreate:
          $ref: ./examples/RedisEnterpriseDatabasesCreate.json
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/Database'
        description: Parameters supplied to the create or update database operation.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The database was/is being updated. Check provisioningState and resourceState for detailed status.
          schema:
            $ref: '#/definitions/Database'
        '201':
          description: The database was/is being created. Check provisioningState and resourceState for detailed status.
          schema:
            $ref: '#/definitions/Database'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename
    patch:
      tags:
      - RedisEnterprise
      operationId: microsoftAzureDatabasesUpdate
      description: Updates a database
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        RedisEnterpriseDatabasesUpdate:
          $ref: ./examples/RedisEnterpriseDatabasesUpdate.json
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/DatabaseUpdate'
        description: Parameters supplied to the create or update database operation.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The database was/is being updated. Check provisioningState and resourceState for detailed status.
          schema:
            $ref: '#/definitions/Database'
        '202':
          description: The database update operation was successfully started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename
    get:
      tags:
      - RedisEnterprise
      operationId: microsoftAzureDatabasesGet
      description: Gets information about a database in a RedisEnterprise cluster.
      x-ms-examples:
        RedisEnterpriseDatabasesGet:
          $ref: ./examples/RedisEnterpriseDatabasesGet.json
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Successfully found the database
          schema:
            $ref: '#/definitions/Database'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename
    delete:
      tags:
      - RedisEnterprise
      operationId: microsoftAzureDatabasesDelete
      description: Deletes a single database
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        RedisEnterpriseDatabasesDelete:
          $ref: ./examples/RedisEnterpriseDatabasesDelete.json
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Successfully deleted the database.
        '202':
          description: The database delete operation started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status.
        '204':
          description: Successfully deleted the database.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/listKeys
  : post:
      tags:
      - RedisEnterprise
      operationId: microsoftAzureDatabasesListkeys
      x-ms-examples:
        RedisEnterpriseDatabasesListKeys:
          $ref: ./examples/RedisEnterpriseDatabasesListKeys.json
      description: Retrieves the access keys for the RedisEnterprise database.
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The access keys for the specified database.
          schema:
            $ref: '#/definitions/AccessKeys'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename Listkeys
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/regenerateKey
  : post:
      tags:
      - RedisEnterprise
      operationId: microsoftAzureDatabasesRegeneratekey
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        RedisEnterpriseDatabasesRegenerateKey:
          $ref: ./examples/RedisEnterpriseDatabasesRegenerateKey.json
      description: Regenerates the RedisEnterprise database's access keys.
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/RegenerateKeyParameters'
        description: Specifies which key to regenerate.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Returns the new access keys for the database
          schema:
            $ref: '#/definitions/AccessKeys'
        '202':
          description: The cluster update operation was started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename Regeneratekey
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/import
  : post:
      tags:
      - RedisEnterprise
      operationId: microsoftAzureDatabasesImport
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        RedisEnterpriseDatabasesImport:
          $ref: ./examples/RedisEnterpriseDatabasesImport.json
      description: Imports a database file to target database.
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/ImportClusterParameters'
        description: Storage information for importing into the cluster
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Import operation succeeded.
        '202':
          description: The import operation was started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename Import
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/export
  : post:
      tags:
      - RedisEnterprise
      operationId: microsoftAzureDatabasesExport
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        RedisEnterpriseDatabasesExport:
          $ref: ./examples/RedisEnterpriseDatabasesExport.json
      description: Exports a database file from target database.
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/ExportClusterParameters'
        description: Storage information for exporting into the cluster
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Export operation succeeded.
        '202':
          description: Export operation successfully enqueued; follow the Location header to poll for final outcome.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename Export
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/forceUnlink
  : post:
      tags:
      - RedisEnterprise
      operationId: microsoftAzureDatabasesForceunlink
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        How to unlink a database during a regional outage:
          $ref: ./examples/RedisEnterpriseDatabasesForceUnlink.json
      description: Forcibly removes the link to the specified database resource.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/ForceUnlinkParameters'
        description: Information identifying the database to be unlinked.
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Force unlink operation succeeded. The unlinked database must be deleted before it can be recreated and linked again.
        '202':
          description: Force unlink operation successfully enqueued; follow the Azure-AsyncOperation header to poll for final outcome.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename Forceunlink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/flush
  : post:
      tags:
      - RedisEnterprise
      operationId: microsoftAzureDatabasesFlush
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        How to flush all the keys in the database:
          $ref: ./examples/RedisEnterpriseDatabasesFlush.json
      description: Flushes all the keys in this database and also from its linked databases.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/FlushParameters'
        description: Information identifying the databases to be flushed
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Flush operation succeeded. All the keys are cleared in this and all its linked databases.
        '202':
          description: Flush operation successfully enqueued; follow the Azure-AsyncOperation header to poll for final outcome.
          headers:
            Location:
              description: Location URI to poll for result
              type: string
            Azure-AsyncOperation:
              description: URI to poll for the operation status
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename Flush
definitions:
  Sku:
    description: SKU parameters supplied to the create RedisEnterprise operation.
    properties:
      name:
        type: string
        description: 'The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.)'
        enum:
        - Enterprise_E10
        - Enterprise_E20
        - Enterprise_E50
        - Enterprise_E100
        - EnterpriseFlash_F300
        - EnterpriseFlash_F700
        - EnterpriseFlash_F1500
        x-ms-enum:
          name: SkuName
          modelAsString: true
      capacity:
        type: integer
        format: int32
        description: The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs.
    required:
    - name
  ClusterUpdate:
    description: A partial update to the RedisEnterprise cluster
    properties:
      sku:
        $ref: '#/definitions/Sku'
        description: The SKU to create, which affects price, performance, and features.
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/ClusterProperties'
        description: Other properties of the cluster.
      tags:
        type: object
        additionalProperties:
          type: string
        x-ms-mutability:
        - read
        - create
        - update
        description: Resource tags.
  Database:
    description: Describes a database on the RedisEnterprise cluster
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/DatabaseProperties'
        description: Other properties of the database.
    allOf:
    - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource
  ExportClusterParameters:
    title: Export an RDB file into a target database
    properties:
      sasUri:
        type: string
        description: SAS Uri for the target directory to export to
    required:
    - sasUri
    description: Parameters for a Redis Enterprise export operation.
  AccessKeys:
    title: Access keys
    description: The secret access keys used for authenticating connections to redis
    type: object
    properties:
      primaryKey:
        readOnly: true
        type: string
        description: The current primary key that clients can use to authenticate
      secondaryKey:
        readOnly: true
        type: string
        description: The current secondary key that clients can use to authenticate
  Cluster:
    description: Describes the RedisEnterprise cluster
    properties:
      sku:
        $ref: '#/definitions/Sku'
        description: The SKU to create, which affects price, performance, and features.
      zones:
        type: array
        items:
          type: string
        description: The zones where this cluster will be deployed.
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/ClusterProperties'
        description: Other properties of the cluster.
    required:
    - sku
    allOf:
    - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource
  DatabaseProperties:
    title: RedisEnterprise database properties
    description: Properties of RedisEnterprise databases, as opposed to general resource properties like location, tags
    properties:
      clientProtocol:
        type: string
        description: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
        enum:
        - Encrypted
        - Plaintext
        x-ms-enum:
          name: Protocol
          modelAsString: true
      port:
        type: integer
        format: int32
        x-ms-mutability:
        - read
        - create
        description: TCP port of the database endpoint. Specified at create time. Defaults to an available port.
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        readOnly: true
        description: Current provisioning status of the database
      resourceState:
        $ref: '#/definitions/ResourceState'
        readOnly: true
        description: Current resource status of the database
      clusteringPolicy:
        type: string
        description: Clustering policy - default is OSSCluster. Specified at create time.
        enum:
        - EnterpriseCluster
        - OSSCluster
        x-ms-enum:
          name: ClusteringPolicy
          modelAsString: true
        x-ms-mutability:
        - read
        - create
      evictionPolicy:
        type: string
        description: Redis eviction policy - default is VolatileLRU
        enum:
        - AllKeysLFU
        - AllKeysLRU
        - AllKeysRandom
        - VolatileLRU
        - VolatileLFU
        - VolatileTTL
        - VolatileRandom
        - NoEviction
        x-ms-enum:
          name: EvictionPolicy
          modelAsString: true
      modules:
        type: array
        description: Optional set of redis modules to enable in this database - modules can only be added at creation time.
        items:
          $ref: '#/definitions/Module'
        x-ms-mutability:
        - read
        - create
  ClusterProperties:
    title: RedisEnterprise cluster properties
    description: Properties of RedisEnterprise clusters, as opposed to general resource properties like location, tags
    properties:
      minimumTlsVersion:
        type: string
        x-ms-mutability:
        - read
        - create
        description: The minimum TLS version for the cluster to support, e.g. '1.2'
      hostName:
        type: string
        readOnly: true
        description: DNS name of the cluster endpoint
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        readOnly: true
        description: Current provisioning status of the cluster
      resourceState:
        $ref: '#/definitions/ResourceState'
        readOnly: true
        description: Current resource status of the cluster
      redisVersion:
        type: string
        readOnly: true
        description: Version of redis the cluster supports, e.g. '6'
      privateEndpointConnections:
        type: array
        readOnly: true
        description: List of private endpoint connections associated with the specified RedisEnterprise cluster
        items:
          $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection
  DatabaseList:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/Database'
        description: List of databases
      nextLink:
        type: string
        readOnly: true
        description: The URI to fetch the next page of results.
    description: The response of a list-all operation.
  ImportClusterParameters:
    title: Import an RDB file into a target database
    properties:
      sasUri:
        type: string
        description: SAS Uri for the target blob to import from
    required:
    - sasUri
    description: Parameters for a Redis Enterprise import operation.
  RegenerateKeyParameters:
    title: Regenerate access keys request
    properties:
      keyType:
        type: string
        description: Which access key to regenerate.
        enum:
        - Primary
        - Secondary
        x-ms-enum:
          name: AccessKeyType
          modelAsString: false
    required:
    - keyType
    description: Specifies which access keys to reset to a new random value.
  ForceUnlinkParameters:
    title: Forcibly unlink another database from this database.
    type: object
    properties:
      ids:
        type: array
        items:
          type: string
          format: arm-id
          x-ms-arm-id-details:
            allowedResources:
            - type: Microsoft.Cache/redisEnterprise/databases
        description: The resource IDs of the database resources to be unlinked.
    required:
    - ids
    description: Parameters for a Redis Enterprise Active Geo Replication Force Unlink operation.
  DatabaseUpdate:
    description: A partial update to the RedisEnterprise database
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/DatabaseProperties'
        description: Properties of the database.
  ClusterList:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/Cluster'
        description: List of clusters.
      nextLink:
        type: string
        readOnly: true
        description: The URI to fetch the next page of results.
    description: The response of a list-all operation.
  Module:
    title: Module settings
    description: Specifies configuration of a redis module
    properties:
      name:
        type: string
        x-ms-mutability:
        - read
        - create
        description: The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
      args:
        type: string
        x-ms-mutability:
        - read
        - create
        description: Configuration options for the module, e.g. 'ERROR_RATE 0.00 INITIAL_SIZE 400'.
      version:
        type: string
        readOnly: true
        description: The version of the module, e.g. '1.0'.
    required:
    - name
  ProvisioningState:
    type: string
    readOnly: true
    description: Current provisioning status
    enum:
    - Succeeded
    - Failed
    - Canceled
    - Creating
    - Updating
    - Deleting
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
  ResourceState:
    type: string
    readOnly: true
    description: Current resource status
    enum:
    - Running
    - Creating
    - CreateFailed
    - Updating
    - UpdateFailed
    - Deleting
    - DeleteFailed
    - Enabling
    - EnableFailed
    - Disabling
    - DisableFailed
    - Disabled
    x-ms-enum:
      name: ResourceState
      modelAsString: true
  FlushParameters:
    title: Flush all the keys from the current and all its linked databases.
    type: object
    properties:
      ids:
        type: array
        items:
          type: string
          format: arm-id
          x-ms-arm-id-details:
            allowedResources:
            - type: Microsoft.Cache/redisEnterprise/databases
        description: The identifiers of all the other database resources in the georeplication group to be flushed.
    description: Parameters for a Redis Enterprise active geo-replication flush operation
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  ResourceGroupNameParameter:
    name: resourceGroupName
    in: path
    required: true
    type: string
    description: The name of the resource group.
    x-ms-parameter-location: method
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  ClusterNameParameter:
    name: clusterName
    in: path
    required: true
    type: string
    description: The name of the RedisEnterprise cluster.
    x-ms-parameter-location: method
  DatabaseNameParameter:
    name: databaseName
    in: path
    required: true
    type: string
    description: The name of the database.
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'