swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Databases API
  description: Operations for managing Cosmos DB databases
schemes:
- https
tags:
- name: Databases
  description: Operations for managing Cosmos DB databases
paths:
  /dbs:
    get:
      operationId: Databases_List
      summary: Microsoft Azure List Databases
      description: Returns a list of databases under the database account.
      tags:
      - Databases
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/MaxItemCountParameter'
      - $ref: '#/components/parameters/ContinuationParameter'
      responses:
        '200':
          description: Successfully returned the list of databases.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseListResult'
              examples:
                DatabasesList200Example:
                  summary: Default Databases_List 200 response
                  x-microcks-default: true
                  value:
                    _rid: '500123'
                    Databases:
                    - id: abc123
                      _rid: '500123'
                      _ts: 10
                      _self: example_value
                      _etag: example_value
                      _colls: example_value
                      _users: example_value
                    _count: 10
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DatabasesListdefaultExample:
                  summary: Default Databases_List default response
                  x-microcks-default: true
                  value:
                    code: example_value
                    message: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: Databases_Create
      summary: Microsoft Azure Create a Database
      description: Creates a new database in the database account.
      tags:
      - Databases
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: The unique name that identifies the database.
              required:
              - id
            examples:
              DatabasesCreateRequestExample:
                summary: Default Databases_Create request
                x-microcks-default: true
                value:
                  id: abc123
      responses:
        '201':
          description: Successfully created the database.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Database'
              examples:
                DatabasesCreate201Example:
                  summary: Default Databases_Create 201 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    _rid: '500123'
                    _ts: 10
                    _self: example_value
                    _etag: example_value
                    _colls: example_value
                    _users: example_value
        '409':
          description: The database with the specified ID already exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DatabasesCreate409Example:
                  summary: Default Databases_Create 409 response
                  x-microcks-default: true
                  value:
                    code: example_value
                    message: example_value
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DatabasesCreatedefaultExample:
                  summary: Default Databases_Create default response
                  x-microcks-default: true
                  value:
                    code: example_value
                    message: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /dbs/{databaseId}:
    get:
      operationId: Databases_Get
      summary: Microsoft Azure Get a Database
      description: Retrieves a database resource by its ID.
      tags:
      - Databases
      parameters:
      - $ref: '#/components/parameters/DatabaseIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully returned the database.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Database'
              examples:
                DatabasesGet200Example:
                  summary: Default Databases_Get 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    _rid: '500123'
                    _ts: 10
                    _self: example_value
                    _etag: example_value
                    _colls: example_value
                    _users: example_value
        '404':
          description: The database was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DatabasesGet404Example:
                  summary: Default Databases_Get 404 response
                  x-microcks-default: true
                  value:
                    code: example_value
                    message: example_value
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DatabasesGetdefaultExample:
                  summary: Default Databases_Get default response
                  x-microcks-default: true
                  value:
                    code: example_value
                    message: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: Databases_Delete
      summary: Microsoft Azure Delete a Database
      description: Deletes a database and all child resources (containers, items, etc.).
      tags:
      - Databases
      parameters:
      - $ref: '#/components/parameters/DatabaseIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '204':
          description: Successfully deleted the database.
        '404':
          description: The database was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DatabasesDelete404Example:
                  summary: Default Databases_Delete 404 response
                  x-microcks-default: true
                  value:
                    code: example_value
                    message: example_value
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DatabasesDeletedefaultExample:
                  summary: Default Databases_Delete default response
                  x-microcks-default: true
                  value:
                    code: example_value
                    message: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/databases
  : get:
      tags:
      - Databases
      summary: Microsoft Azure Gets A List Of Databases In The Migrate Project
      operationId: microsoftAzureDatabasesEnumeratedatabases
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/migrateProjectName'
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/continuationToken'
      - $ref: '#/parameters/pageSize'
      - $ref: '#/parameters/acceptLanguage'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DatabaseCollection'
      deprecated: false
      x-ms-examples:
        Databases_List:
          $ref: ./examples/Databases_List.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/databases/{databaseName}
  : get:
      tags:
      - Databases
      summary: Microsoft Azure Gets A Database In The Migrate Project
      operationId: microsoftAzureDatabasesGetdatabase
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/migrateProjectName'
      - $ref: '#/parameters/databaseName'
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/acceptLanguage'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Database'
      deprecated: false
      x-ms-examples:
        Databases_Get:
          $ref: ./examples/Databases_Get.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/usages
  : get:
      tags:
      - Databases
      operationId: microsoftAzureDatabaseusagesListbydatabase
      description: Returns database usages.
      x-ms-examples:
        List database usage metrics:
          $ref: ./examples/DatabaseUsageMetricsList.json
      parameters:
      - $ref: ../../../common/v1/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../common/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../common/v1/types.json#/parameters/ResourceGroupParameter
      - $ref: '#/parameters/ServerNameParameter'
      - name: databaseName
        in: path
        required: true
        type: string
        description: The name of the database.
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DatabaseUsageListResult'
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Servername Databases Databasename Usages
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/checkNameAvailability
  : post:
      tags:
      - Databases
      operationId: microsoftAzureDatabasesChecknameavailability
      x-ms-examples:
        KustoDatabaseCheckNameAvailability:
          $ref: ./examples/KustoDatabasesCheckNameAvailability.json
      description: Checks that the database name is valid and is not already in use.
      parameters:
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: databaseName
        in: body
        required: true
        schema:
          $ref: '#/definitions/DatabaseCheckNameRequest'
        description: The name of the database.
      responses:
        '200':
          description: OK -- Operation to check the kusto resource name availability was successful.
          schema:
            $ref: '#/definitions/CheckNameResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Checknameavailability
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases
  : get:
      tags:
      - Databases
      description: Returns the list of databases of the given Kusto cluster.
      operationId: microsoftAzureDatabasesListbycluster
      x-ms-examples:
        KustoDatabasesListByCluster:
          $ref: ./examples/KustoDatabasesListByCluster.json
      parameters:
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the list of databases.
          schema:
            $ref: '#/definitions/DatabaseListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}
  : get:
      tags:
      - Databases
      description: Returns a database.
      operationId: microsoftAzureDatabasesGet
      x-ms-examples:
        KustoDatabasesGet:
          $ref: ./examples/KustoDatabasesGet.json
      parameters:
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the specified database.
          schema:
            $ref: '#/definitions/Database_2'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename
    put:
      tags:
      - Databases
      description: Creates or updates a database.
      operationId: microsoftAzureDatabasesCreateorupdate
      x-ms-examples:
        KustoDatabasesCreateOrUpdate:
          $ref: ./examples/KustoDatabasesCreateOrUpdate.json
      parameters:
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/Database_2'
        description: The database parameters supplied to the CreateOrUpdate operation.
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully updated the database.
          schema:
            $ref: '#/definitions/Database_2'
        '201':
          description: Successfully created the database.
          schema:
            $ref: '#/definitions/Database_2'
        '202':
          description: Accepted the create database request.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename
    patch:
      tags:
      - Databases
      description: Updates a database.
      operationId: microsoftAzureDatabasesUpdate
      x-ms-examples:
        KustoDatabasesUpdate:
          $ref: ./examples/KustoDatabasesUpdate.json
      parameters:
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/DatabaseUpdate'
        description: The database parameters supplied to the Update operation.
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully updated the database.
          schema:
            $ref: '#/definitions/Database_2'
        '201':
          description: Successfully updated the database.
          schema:
            $ref: '#/definitions/Database_2'
        '202':
          description: Accepted the update database request.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename
    delete:
      tags:
      - Databases
      description: Deletes the database with the given name.
      operationId: microsoftAzureDatabasesDelete
      x-ms-examples:
        KustoDatabasesDelete:
          $ref: ./examples/KustoDatabasesDelete.json
      parameters:
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully deleted the database.
        '202':
          description: Accepted.
        '204':
          description: The specified database does not exist.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/listPrincipals
  : post:
      tags:
      - Databases
      description: Returns a list of database principals of the given Kusto cluster and database.
      operationId: microsoftAzureDatabasesListprincipals
      x-ms-examples:
        KustoDatabaseListPrincipals:
          $ref: ./examples/KustoDatabaseListPrincipals.json
      parameters:
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the list of database principals.
          schema:
            $ref: '#/definitions/DatabasePrincipalListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename Listprincipals
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/addPrincipals
  : post:
      tags:
      - Databases
      operationId: microsoftAzureDatabasesAddprincipals
      x-ms-examples:
        KustoDatabaseAddPrincipals:
          $ref: ./examples/KustoDatabaseAddPrincipals.json
      description: Add Database principals permissions.
      parameters:
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: databasePrincipalsToAdd
        in: body
        required: true
        schema:
          $ref: '#/definitions/DatabasePrincipalListRequest'
        description: List of database principals to add.
      responses:
        '200':
          description: OK -- Successfully added the list of database principals. Returns the updated list of principals.
          schema:
            $ref: '#/definitions/DatabasePrincipalListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename Addprincipals
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/removePrincipals
  : post:
      tags:
      - Databases
      operationId: microsoftAzureDatabasesRemoveprincipals
      x-ms-examples:
        KustoDatabaseRemovePrincipals:
          $ref: ./examples/KustoDatabaseRemovePrincipals.json
      description: Remove Database principals permissions.
      parameters:
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/ClusterNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: databasePrincipalsToRemove
        in: body
        required: true
        schema:
          $ref: '#/definitions/DatabasePrincipalListRequest'
        description: List of database principals to remove.
      responses:
        '200':
          description: OK -- Successfully removed the list of database principals. Returns the updated list of principals.
          schema:
            $ref: '#/definitions/DatabasePrincipalListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename Removeprincipals
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/databases/{databaseName}
  : put:
      tags:
      - Databases
      operationId: microsoftAzureDatabasesCreateorupdate
      x-ms-examples:
        DatabaseCreate:
          $ref: ./examples/DatabaseCreate.json
      description: Creates a new database or updates an existing database.
      parameters:
      - $ref: '#/parameters/ApiVersionParameter_2'
      - $ref: '#/parameters/SubscriptionIdParameter_2'
      - $ref: '#/parameters/ResourceGroupParameter_2'
      - $ref: '#/parameters/ServerNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter_2'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/Database_3'
        description: The required parameters for creating or updating a database.
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Database_3'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/Database_3'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbformariadb Servers Servername Databases Databasename
    delete:
      tags:
      - Databases
      operationId: microsoftAzureDatabasesDelete
      x-ms-examples:
        DatabaseDelete:
          $ref: ./examples/DatabaseDelete.json
      description: Deletes a database.
      parameters:
      - $ref: '#/parameters/ApiVersionParameter_2'
      - $ref: '#/parameters/SubscriptionIdParameter_2'
      - $ref: '#/parameters/ResourceGroupParameter_2'
      - $ref: '#/parameters/ServerNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter_2'
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
        '204':
          description: NoContent
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbformariadb Servers Servername Databases Databasename
    get:
      tags:
      - Databases
      operationId: microsoftAzureDatabasesGet
      x-ms-examples:
        DatabaseGet:
          $ref: ./examples/DatabaseGet.json
      description: Gets information about a database.
      parameters:
      - $ref: '#/parameters/ApiVersionParameter_2'
      - $ref: '#/parameters/SubscriptionIdParameter_2'
      - $ref: '#/parameters/ResourceGroupParameter_2'
      - $ref: '#/parameters/ServerNameParameter'
      - $ref: '#/parameters/DatabaseNameParameter_2'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Database_3'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbformariadb Servers Servername Databases Databasename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/databases
  : get:
      tags:
      - Databases
      operationId: microsoftAzureDatabasesListbyserver
      x-ms-examples:
        DatabaseList:
          $ref: ./examples/DatabaseListByServer.json
      description: List all the databases in a given server.
      parameters:
      - $ref: '#/parameters/ApiVersionParameter_2'
      - $ref: '#/parameters/SubscriptionIdParameter_2'
      - $ref: '#/parameters/ResourceGroupParameter_2'
      - $ref: '#/parameters/ServerNameParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DatabaseListResult_2'
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbformariadb Servers Servername Databases
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases
  : get:
      tags:
      - Databases
      operationId: microsoftAzureDatabasesListbycluster
      description: Gets all databases in the specified RedisEnterprise cluster.
      x-ms-examples:
        RedisEnterpriseDatabasesListByCluster:
          $ref: ./examples/RedisEnterpriseDatabasesListByCluster.json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter_3'
      - $ref: '#/parameters/SubscriptionIdParameter_3'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ClusterNameParameter_2'
      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:
      - Databases
      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_2'
      - $ref: '#/parameters/DatabaseNameParameter_3'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/Database_4'
        description: Parameters supplied to the create or update database operation.
      - $ref: '#/parameters/ApiVersionParameter_3'
      - $ref: '#/parameters/SubscriptionIdParameter_3'
      responses:
        '200':
          description: The database was/is being updated. Check provisioningState and resourceState for detailed status.
          schema:
            $ref: '#/definitions/Database_4'
        '201':
          description: The database was/is being created. Check provisioningState and resourceState for detailed status.
          schema:
            $ref: '#/definitions/Database_4'
        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:
      - Databases
      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_2'
      - $ref: '#/parameters/DatabaseNameParameter_3'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/DatabaseUpdate_2'
        description: Parameters supplied to the create or update database operation.
      - $ref: '#/parameters/ApiVersionParameter_3'
      - $ref: '#/parameters/SubscriptionIdParameter_3'
      responses:
        '200':
          description: The database was/is being updated. Check provisioningState and resourceState for detailed status.
          schema:
            $ref: '#/definitions/Database_4'
        '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:
      - Databases
      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_2'
      - $ref: '#/parameters/DatabaseNameParameter_3'
      - $ref: '#/parameters/ApiVersionParameter_3'
      - $ref: '#/parameters/SubscriptionIdParameter_3'
      responses:
        '200':
          description: Successfully found the database
          schema:
            $ref: '#/definitions/Database_4'
        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:
      - Databases
      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_2'
      - $ref: '#/parameters/DatabaseNameParameter_3'
      - $ref: '#/parameters/ApiVersionParameter_3'
      - $ref: '#/parameters/SubscriptionIdParameter_3'
      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:
      - Databases
      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_2'
      - $ref: '#/parameters/DatabaseNameParameter_3'
      - $ref: '#/parameters/ApiVersionParameter_3'
      - $ref: '#/parameters/SubscriptionIdParameter_3'
      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:
      - Databases
      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_2'
      - $ref: '#/parameters/DatabaseNameParameter_3'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/RegenerateKeyParameters'
        description: Specifies which key to regenerate.
      - $ref: '#/parameters/ApiVersionParameter_3'
      - $ref: '#/parameters/SubscriptionIdParameter_3'
      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:
      - Databases
      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_2'
      - $ref: '#/parameters/DatabaseNameParameter_3'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/ImportClusterParameters'
        description: Storage information for importing into the cluster
      - $ref: '#/parameters/ApiVersionParameter_3'
      - $ref: '#/parameters/SubscriptionIdParameter_3'
      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:
      - Databases
      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_2'
      - $ref: '#/parameters/DatabaseNameParameter_3'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/ExportClusterParameters'
        description: Storage information for exporting into the cluster
      - $ref: '#/parameters/ApiVersionParameter_3'
      - $ref: '#/parameters/SubscriptionIdParameter_3'
      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:
      - Databases
      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_3'
      - $ref: '#/parameters/DatabaseNameParameter_4'
      - 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:
      - Databases
      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_3'
      - $ref: '#/parameters/DatabaseNameParameter_4'
      - 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
components:
  schemas:
    DatabaseListResult:
      type: object
      description: List of Cosmos DB databases.
      properties:
        _rid:
          type: string
          readOnly: true
          description: The resource ID.
          example: '500123'
        Databases:
          type: array
          items:
            $ref: '#/components/schemas/Database'
          description: List of databases.
          example: []
        _count:
          type: integer
          readOnly: true
          description: The number of databases returned.
          example: 10
    ErrorResponse:
      type: object
      description: Error response from Cosmos DB.
      properties:
        code:
          type: string
          description: The error code.
          example: example_value
        message:
          type: string
          description: The error message.
          example: example_value
      required:
      - code
      - message
    Database:
      type: object
      description: A Cosmos DB database resource.
      properties:
        id:
          type: string
          description: The unique name that identifies the database.
          example: abc123
        _rid:
          type: string
          readOnly: true
          description: System-generated resource ID.
          example: '500123'
        _ts:
          type: integer
          readOnly: true
          description: System-generated timestamp (epoch value).
          example: 10
        _self:
          type: string
          readOnly: true
          description: System-generated URI for the resource.
          example: example_value
        _etag:
          type: string
          readOnly: true
          description: System-generated resource etag for optimistic concurrency.
          example: example_value
        _colls:
          type: string
          readOnly: true
          description: System-generated addressable path for the collections resource.
          example: example_value
        _users:
          type: string
          readOnly: true
          description: System-generated addressable path for the users resource.
          example: example_value
      required:
      - id
  parameters:
    DatabaseIdParameter:
      name: databaseId
      in: path
      required: true
      description: The ID of the database.
      schema:
        type: string
    ContinuationParameter:
      name: x-ms-continuation
      in: header
      description: A continuation token returned from a previous request for pagination.
      schema:
        type: string
    ApiVersionParameter:
      name: x-ms-version
      in: header
      required: true
      description: The version of the Cosmos DB REST API.
      schema:
        type: string
        default: '2018-12-31'
    MaxItemCountParameter:
      name: x-ms-max-item-count
      in: header
      description: The maximum number of items to return per page. Default is 100, maximum is 1000.
      schema:
        type: integer
        default: 100
        maximum: 1000
definitions:
  DatabaseUsage:
    properties:
      name:
        readOnly: true
        type: string
        description: The name of the usage metric.
      resourceName:
        readOnly: true
        type: string
        description: The name of the resource.
      displayName:
        readOnly: true
        type: string
        description: The usage metric display name.
      currentValue:
        readOnly: true
        type: number
        format: double
        description: The current value of the usage metric.
      limit:
        readOnly: true
        type: number
        format: double
        description: The current limit of the usage metric.
      unit:
        readOnly: true
        type: string
        description: The units of the usage metric.
      nextResetTime:
        readOnly: true
        type: string
        format: date-time
        description: The next reset time for the usage metric (ISO8601 format).
    description: The database usages.
  DatabasePrincipal:
    type: object
    required:
    - name
    - role
    - type
    properties:
      role:
        description: Database principal role.
        type: string
        enum:
        - Admin
        - Ingestor
        - Monitor
        - User
        - UnrestrictedViewers
        - Viewer
        x-ms-enum:
          name: DatabasePrincipalRole
          modelAsString: true
      name:
        description: Database principal name.
        type: string
      type:
        description: Database principal type.
        type: string
        enum:
        - App
        - Group
        - User
        x-ms-enum:
          name: DatabasePrincipalType
          modelAsString: true
      fqn:
        description: Database principal fully qualified name.
        type: string
      email:
        description: Database principal email if exists.
        type: string
      appId:
        description: Application id - relevant only for application principal type.
        type: string
  CloudErrorBody:
    x-ms-external: true
    properties:
      code:
        type: string
        description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
      message:
        type: string
        description: A message describing the error, intended to be suitable for displaying in a user interface.
      target:
        type: string
        description: The target of the particular error. For example, the name of the property in error.
      details:
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
        description: A list of additional details about the error.
    description: An error response from Kusto.
  DatabaseProperties_4:
    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
  DatabasePrincipalListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/DatabasePrincipal'
        description: The list of Kusto database principals.
    description: The list Kusto database principals operation response.
  CheckNameResult:
    type: object
    properties:
      nameAvailable:
        type: boolean
        description: Specifies a Boolean value that indicates if the name is available.
      name:
        type: string
        description: The name that was checked.
      message:
        type: string
        description: Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated.
  Database:
    description: Database REST resource.
    type: object
    properties:
      id:
        description: Gets or sets the relative URL to get to this REST resource.
        type: string
      name:
        description: Gets or sets the name of this REST resource.
        type: string
      type:
        description: Gets the type of this REST resource.
        type: string
        readOnly: true
      properties:
        $ref: '#/definitions/DatabaseProperties'
        description: Gets or sets the properties of the database.
  DatabaseCollection:
    description: Collection of databases.
    type: object
    properties:
      value:
        description: Gets or sets the databases.
        type: array
        items:
          $ref: '#/definitions/Database'
      nextLink:
        description: Gets or sets the value of nextLink.
        type: string
  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.
  DatabaseListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/Database_2'
        description: The list of Kusto databases.
    description: The list Kusto databases operation response.
  DatabaseProperties_2:
    properties:
      provisioningState:
        type: string
        readOnly: true
        description: The provisioned state of the resource.
        enum:
        - Running
        - Creating
        - Deleting
        - Succeeded
        - Failed
        x-ms-enum:
          name: ProvisioningState
          modelAsString: true
      softDeletePeriodInDays:
        type: integer
        description: The number of days data should be kept before it stops being accessible to queries.
      hotCachePeriodInDays:
        type: integer
        description: The number of days of data that should be kept in cache for fast queries.
      statistics:
        $ref: '#/definitions/DatabaseStatistics'
        readOnly: true
        description: The statistics of the database.
    required:
    - softDeletePeriodInDays
    description: Class representing the Kusto database properties.
  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
  DatabaseCheckNameRequest:
    type: object
    properties:
      name:
        type: string
        description: Database name.
      type:
        type: string
        enum:
        - Microsoft.Kusto/clusters/databases
        x-ms-enum:
          name: Type
          modelAsString: false
        description: The type of resource, Microsoft.Kusto/clusters/databases.
    required:
    - name
    - type
  DatabaseProperties_3:
    properties:
      charset:
        type: string
        description: The charset of the database.
      collation:
        type: string
        description: The collation of the database.
    description: The properties of a database.
  DatabaseProperties:
    description: Properties of the database resource.
    type: object
    properties:
      assessmentData:
        description: Gets or sets the assessment details of the database published by various sources.
        type: array
        items:
          $ref: '#/definitions/DatabaseAssessmentDetails'
        x-ms-identifiers:
        - assessmentId
      lastUpdatedTime:
        format: date-time
        description: Gets or sets the time of the last modification of the database.
        type: string
  DatabaseList:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/Database_4'
        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.
  Database_3:
    properties:
      properties:
        $ref: '#/definitions/DatabaseProperties_3'
        x-ms-client-flatten: true
        description: The properties of a database.
    allOf:
    - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource
    description: Represents a Database.
  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.
  Database_4:
    description: Describes a database on the RedisEnterprise cluster
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/DatabaseProperties_4'
        description: Other properties of the database.
    allOf:
    - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource
  DatabaseUsageListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/DatabaseUsage'
        description: The list of database usages for the database.
    required:
    - value
    description: The response to a list database metrics request.
  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.
  DatabaseStatistics:
    type: object
    readOnly: true
    properties:
      size:
        type: number
        description: The database size - the total size of compressed data and index in bytes.
  Database_2:
    properties:
      etag:
        readOnly: true
        type: string
        description: An ETag of the resource created.
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/DatabaseProperties_2'
    allOf:
    - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource
    description: Class representing a Kusto database.
  DatabasePrincipalListRequest:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/DatabasePrincipal'
        description: The list of Kusto database principals.
    description: The list Kusto database principals operation request.
  DatabaseAssessmentDetails:
    description: Assessment properties that can be shared by various publishers.
    type: object
    properties:
      assessmentId:
        description: Gets or sets the database assessment scope/Id.
        type: string
      migrationBlockersCount:
        format: int32
        description: Gets or sets the number of blocking changes found.
        type: integer
      breakingChangesCount:
        format: int32
        description: Gets or sets the number of breaking changes found.
        type: integer
      isReadyForMigration:
        description: Gets or sets a value indicating whether the database is ready for migration.
        type: boolean
      assessmentTargetType:
        description: Gets or sets the assessed target database type.
        type: string
      lastAssessedTime:
        format: date-time
        description: Gets or sets the time when the database was last assessed.
        type: string
      compatibilityLevel:
        description: Gets or sets the compatibility level of the database.
        type: string
      databaseSizeInMB:
        description: Gets or sets the database size.
        type: string
      lastUpdatedTime:
        format: date-time
        description: Gets or sets the time of the last modification of the database details.
        type: string
      enqueueTime:
        description: Gets or sets the time the message was enqueued.
        type: string
      solutionName:
        description: Gets or sets the name of the solution that sent the data.
        type: string
      instanceId:
        description: Gets or sets the database server instance Id.
        type: string
      databaseName:
        description: Gets or sets the database name.
        type: string
      extendedInfo:
        description: Gets or sets the extended properties of the database.
        type: object
        additionalProperties:
          type: string
  DatabaseListResult_2:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/Database_3'
        description: The list of databases housed in a server
    description: A List of databases.
  DatabaseUpdate_2:
    description: A partial update to the RedisEnterprise database
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/DatabaseProperties_4'
        description: Properties of the database.
  CloudError:
    x-ms-external: true
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
    description: An error response from Kusto.
  DatabaseUpdate:
    properties:
      location:
        type: string
        description: Resource location.
      etag:
        readOnly: true
        type: string
        description: An ETag of the resource updated.
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/DatabaseProperties_2'
    allOf:
    - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/Resource
    description: Class representing an update to a Kusto database.
  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
  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
  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:
  SubscriptionIdParameter_2:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: The subscription ID that identifies an Azure subscription.
  migrateProjectName:
    name: migrateProjectName
    description: Name of the Azure Migrate project.
    type: string
    in: path
    x-ms-parameter-location: method
    required: true
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client API Version.
  acceptLanguage:
    description: Standard request header. Used by service to respond to client in appropriate language.
    name: Accept-Language
    type: string
    in: header
    x-ms-parameter-location: client
  resourceGroupName:
    name: resourceGroupName
    description: Name of the Azure Resource Group that migrate project is part of.
    type: string
    in: path
    x-ms-parameter-location: method
    required: true
  ApiVersionParameter_2:
    name: api-version
    in: query
    required: true
    type: string
    description: The API version to use for the request.
  api-version:
    name: api-version
    description: Standard request header. Used by service to identify API version used by client.
    type: string
    in: query
    required: true
    enum:
    - 2018-09-01-preview
  ResourceGroupNameParameter:
    name: resourceGroupName
    in: path
    required: true
    type: string
    description: The name of the resource group.
    x-ms-parameter-location: method
  databaseName:
    name: databaseName
    description: Unique name of a database in Azure migration hub.
    type: string
    in: path
    x-ms-parameter-location: method
    required: true
  ResourceGroupParameter_2:
    name: resourceGroupName
    in: path
    required: true
    type: string
    description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    x-ms-parameter-location: method
  continuationToken:
    name: continuationToken
    description: The continuation token.
    type: string
    in: query
    required: false
    x-ms-parameter-location: method
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  subscriptionId:
    name: subscriptionId
    description: Azure Subscription Id in which migrate project was created.
    type: string
    in: path
    required: true
  DatabaseNameParameter_3:
    name: databaseName
    in: path
    required: true
    type: string
    description: The name of the database.
    x-ms-parameter-location: method
  SubscriptionIdParameter_3:
    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.
  ResourceGroupParameter:
    name: resourceGroupName
    in: path
    description: The name of the resource group containing the Kusto cluster.
    required: true
    type: string
    x-ms-parameter-location: method
  ClusterNameParameter_3:
    name: clusterName
    in: path
    required: true
    type: string
    description: The name of the RedisEnterprise cluster.
    x-ms-parameter-location: method
  ClusterNameParameter_2:
    name: clusterName
    in: path
    required: true
    type: string
    description: The name of the RedisEnterprise cluster.
    x-ms-parameter-location: method
  DatabaseNameParameter_2:
    name: databaseName
    in: path
    required: true
    type: string
    description: The name of the database.
    x-ms-parameter-location: method
  ClusterNameParameter:
    name: clusterName
    in: path
    description: The name of the Kusto cluster.
    required: true
    type: string
    x-ms-parameter-location: method
  ApiVersionParameter_3:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  ServerNameParameter:
    name: serverName
    in: path
    required: true
    type: string
    description: The name of the server.
    x-ms-parameter-location: method
  DatabaseNameParameter:
    name: databaseName
    in: path
    description: The name of the database in the Kusto cluster.
    required: true
    type: string
    x-ms-parameter-location: method
  pageSize:
    name: pageSize
    description: The number of items to be returned in a single page. This value is honored only if it is less than the 100.
    type: integer
    in: query
    required: false
    x-ms-parameter-location: method
  DatabaseNameParameter_4:
    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'