swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector SqlDatabasesController API
schemes:
- https
tags:
- name: SqlDatabasesController
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlDatabases
  : get:
      operationId: microsoftAzureSqldatabasescontrollerListbysqlsite
      tags:
      - SqlDatabasesController
      description: Gets the sql Databases.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - name: filter
        in: query
        description: filter query
        required: false
        type: string
      - name: top
        in: query
        description: page size  query
        required: false
        type: string
      - name: continuationToken
        in: query
        description: Optional parameter for continuation token.
        required: false
        type: string
      - name: totalRecordCount
        in: query
        description: Total count of machines in the given site.
        required: false
        type: integer
        format: int32
      - name: siteName
        in: path
        description: Site name
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: sqlSiteName
        in: path
        description: SQL site name.
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/SqlDatabaseV2ListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        SqlDatabasesController_ListBySqlSite_MaximumSet_Gen:
          $ref: ./examples/SqlDatabasesController_ListBySqlSite_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename Sqlsites Sqlsitename Sqldatabases
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlDatabases/{sqlDatabaseName}
  : get:
      operationId: microsoftAzureSqldatabasescontrollerGet
      tags:
      - SqlDatabasesController
      description: Gets the sql Database.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: siteName
        in: path
        description: Site name
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: sqlSiteName
        in: path
        description: SQL site name.
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: sqlDatabaseName
        in: path
        description: SQL Database name.
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/SqlDatabaseV2'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        SqlDatabasesController_Get_MaximumSet_Gen:
          $ref: ./examples/SqlDatabasesController_Get_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename Sqlsites Sqlsitename Sqldatabases Sqldatabasename
definitions:
  Errors:
    type: object
    description: The properties of a server machine tracked resource
    properties:
      message:
        type: string
        description: Gets the error message.
        readOnly: true
      messageParameters:
        type: object
        description: Gets the message parameters.
        additionalProperties:
          type: string
        readOnly: true
      applianceName:
        type: string
        description: Gets the appliance name.
        readOnly: true
      id:
        type: integer
        format: int32
        description: Gets the error ID.
        readOnly: true
      code:
        type: string
        description: Gets the error name.
        readOnly: true
      possibleCauses:
        type: string
        description: Gets the possible causes of error.
        readOnly: true
      recommendedAction:
        type: string
        description: Gets the recommended action to resolve error.
        readOnly: true
      severity:
        type: string
        description: Gets the error severity.
        readOnly: true
      summaryMessage:
        type: string
        description: Gets the error summary message.
        readOnly: true
      source:
        $ref: '#/definitions/MicrosoftAzureFDSWebRoleHealthErrorDetailsSource'
        description: Gets the error source.
        readOnly: true
      updatedTimeStamp:
        type: string
        format: date-time
        description: Gets the time stamp when the error was updated.
        readOnly: true
      runAsAccountId:
        type: string
        description: Gets run as account id used while performing discovery             of entity.
        readOnly: true
      discoveryScope:
        $ref: '#/definitions/HealthErrorDetailsDiscoveryScope'
        description: Gets discovery scope for which             error is encountered.
        readOnly: true
  SqlAvailabilityReplicaOverview:
    type: object
    description: Web model for SQL replica overview.
    properties:
      replicaState:
        $ref: '#/definitions/SqlAvailabilityReplicaOverviewReplicaState'
        description: Gets or sets the state of the availability replica.
      availabilityReplicaId:
        type: string
        description: 'Gets or sets the SQL Availability Replica Id within the Availability Group this

          database is a part of.'
      availabilityGroupArmId:
        type: string
        description: 'Gets or sets the Availability Group Id in which this database participates if

          any. It would be set if the database has

          {Microsoft.Azure.FDS.CosmosDB.SqlDatabaseEntity.IsDatabaseHighlyAvailable} has

          a value "true".'
      availabilityGroupName:
        type: string
        description: Gets or sets the SQL Availability group name.
  FileMetaData:
    type: object
    description: File Metadata web model.
    properties:
      logicalName:
        type: string
        description: Gets or sets the logical name of the file.
      physicalFullName:
        type: string
        description: Gets or sets the operating-system full path of the file.
      fileType:
        $ref: '#/definitions/FileType'
        description: Gets or sets the database file type.
      sizeInMb:
        type: number
        format: float
        description: Gets or sets the size of the file in MB.
      isMemoryOptimizedDataOptionEnabled:
        type: boolean
        description: Gets or sets a value indicating whether memory optimized data option is enabled.
  FileType:
    type: string
    description: file type
    enum:
    - Rows
    - Log
    - Filestream
    - NotSupported
    - Fulltext
    x-ms-enum:
      name: FileType
      modelAsString: true
      values:
      - name: Rows
        value: Rows
        description: Rows value.
      - name: Log
        value: Log
        description: Log value.
      - name: Filestream
        value: Filestream
        description: Filestream value.
      - name: NotSupported
        value: NotSupported
        description: NotSpecified value.
      - name: Fulltext
        value: Fulltext
        description: Fulltext value.
  SqlDatabaseV2ListResult:
    type: object
    description: The response of a SqlDatabaseV2 list operation.
    properties:
      value:
        type: array
        description: The SqlDatabaseV2 items on this page
        items:
          $ref: '#/definitions/SqlDatabaseV2'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  HealthErrorDetailsDiscoveryScope:
    type: string
    description: Gets discovery scope for which             error is encountered.
    enum:
    - AppsAndRoles
    - DependencyMap
    - StaticData
    - SQLServerConnectionInfo
    - DiscoveryTargets
    x-ms-enum:
      name: HealthErrorDetailsDiscoveryScope
      modelAsString: true
      values:
      - name: AppsAndRoles
        value: AppsAndRoles
        description: AppsAndRoles value.
      - name: DependencyMap
        value: DependencyMap
        description: DependencyMap value.
      - name: StaticData
        value: StaticData
        description: StaticData value.
      - name: SQLServerConnectionInfo
        value: SQLServerConnectionInfo
        description: SQLServerConnectionInfo value.
      - name: DiscoveryTargets
        value: DiscoveryTargets
        description: DiscoveryTargets value.
  ProvisioningState:
    type: string
    description: The status of the current operation.
    enum:
    - Created
    - Updated
    - Running
    - Completed
    - Failed
    - Succeeded
    - Canceled
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
      values:
      - name: Created
        value: Created
        description: Created value.
      - name: Updated
        value: Updated
        description: Updated value.
      - name: Running
        value: Running
        description: Running value.
      - name: Completed
        value: Completed
        description: Completed value.
      - name: Failed
        value: Failed
        description: Failed value.
      - name: Succeeded
        value: Succeeded
        description: Succeeded value.
      - name: Canceled
        value: Canceled
        description: Canceled value.
  SqlDatabaseV2:
    type: object
    description: Class representing the web model of SQL Database.
    properties:
      properties:
        $ref: '#/definitions/SqlDatabasePropertiesV2'
        description: The resource-specific properties for this resource.
        x-ms-client-flatten: true
        x-ms-mutability:
        - read
        - create
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource
  MicrosoftAzureFDSWebRoleHealthErrorDetailsSource:
    type: string
    description: HealthError Details Source
    enum:
    - RefreshFabricLayout
    - RefreshFabricLayoutGuest
    - RefreshFabricLayoutDependencyMap
    x-ms-enum:
      name: MicrosoftAzureFDSWebRoleHealthErrorDetailsSource
      modelAsString: true
      values:
      - name: RefreshFabricLayout
        value: RefreshFabricLayout
        description: RefreshFabricLayout value.
      - name: RefreshFabricLayoutGuest
        value: RefreshFabricLayoutGuest
        description: RefreshFabricLayoutGuest value.
      - name: RefreshFabricLayoutDependencyMap
        value: RefreshFabricLayoutDependencyMap
        description: RefreshFabricLayoutDependencyMap value.
  SqlDatabasePropertiesV2:
    type: object
    description: Class for SQL Server database properties.
    properties:
      parentReplicaOverview:
        $ref: '#/definitions/SqlAvailabilityReplicaOverview'
        description: Gets or sets the Replica overview.
      isDatabaseHighlyAvailable:
        type: boolean
        description: Gets or sets a value indicating whether this database is a part of an HA setup.
      fileMetadataList:
        type: array
        description: Gets the file metadata list.
        items:
          $ref: '#/definitions/FileMetaData'
        readOnly: true
        x-ms-identifiers: []
      hostname:
        type: string
        description: Gets or sets the hostname.
      sqlServerName:
        type: string
        description: Gets or sets the SQL Server Id in which the database resides.
      status:
        type: string
        description: Gets or sets the status.
      sizeMb:
        type: number
        format: float
        description: Gets or sets the size in Mb.
      databaseName:
        type: string
        description: Gets or sets the SQL database name.
      sqlServerArmId:
        type: string
        description: Gets or sets the SQL Server ARM Id in which the database resides.
      compatibilityLevel:
        type: string
        description: Gets or sets the database compatibility level.
      isDeleted:
        type: boolean
        description: Gets or sets a value indicating whether the entity is deleted.
      errors:
        type: array
        description: Gets the errors.
        items:
          $ref: '#/definitions/Errors'
        readOnly: true
      createdTimestamp:
        type: string
        description: Gets or sets the marking machine creation.
      updatedTimestamp:
        type: string
        description: Gets or sets the timestamp marking last updated on the machine.
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The status of the last operation.
  SqlAvailabilityReplicaOverviewReplicaState:
    type: string
    description: Overview Replica State
    enum:
    - Unknown
    - Primary
    - Secondary
    x-ms-enum:
      name: SqlAvailabilityReplicaOverviewReplicaState
      modelAsString: true
      values:
      - name: Unknown
        value: Unknown
        description: Unknown value.
      - name: Primary
        value: Primary
        description: Primary value.
      - name: Secondary
        value: Secondary
        description: Secondary value.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'