swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector SqlServersController API
schemes:
- https
tags:
- name: SqlServersController
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlServers
  : get:
      operationId: microsoftAzureSqlserverscontrollerListbysqlsite
      tags:
      - SqlServersController
      description: Gets the sql servers.
      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/SqlServerV2ListResult'
        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:
        SqlServersController_ListBySqlSite_MaximumSet_Gen:
          $ref: ./examples/SqlServersController_ListBySqlSite_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename Sqlsites Sqlsitename Sqlservers
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlServers/{sqlServerName}
  : get:
      operationId: microsoftAzureSqlserverscontrollerGet
      tags:
      - SqlServersController
      description: Gets the sql server.
      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: sqlServerName
        in: path
        description: SQL server name.
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/SqlServerV2'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        SqlServersController_Get_MaximumSet_Gen:
          $ref: ./examples/SqlServersController_Get_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename Sqlsites Sqlsitename Sqlservers Sqlservername
    patch:
      operationId: microsoftAzureSqlserverscontrollerUpdate
      tags:
      - SqlServersController
      description: Updates the sql server tags.
      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: sqlServerName
        in: path
        description: SQL server name.
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: body
        in: body
        description: The resource properties to be updated.
        required: true
        schema:
          $ref: '#/definitions/SqlServerV2Update'
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/SqlServerV2'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        SqlServersController_Update_MaximumSet_Gen:
          $ref: ./examples/SqlServersController_Update_MaximumSet_Gen.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename Sqlsites Sqlsitename Sqlservers Sqlservername
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
  SqlMachineOverview:
    type: object
    description: Gets or sets SQL machine overview data.
    properties:
      machineArmId:
        type: string
        description: Gets or sets SQL machine ARM ID.
      displayName:
        type: string
        description: Gets or sets SQL machine display name.
      fciRole:
        $ref: '#/definitions/SqlMachineOverviewFciRole'
        description: Gets or sets SQL machine FCI role.
  esuStatus:
    type: string
    description: esu Status
    enum:
    - Unknown
    - Active
    - InActive
    x-ms-enum:
      name: esuStatus
      modelAsString: true
      values:
      - name: Unknown
        value: Unknown
        description: Unknown value.
      - name: Active
        value: Active
        description: Active value.
      - name: InActive
        value: InActive
        description: InActive value.
  SqlServerV2Update:
    type: object
    description: The type used for update operations of the SqlServerV2.
    properties:
      properties:
        $ref: '#/definitions/SqlServerV2UpdateProperties'
        x-ms-client-flatten: true
  SqlServerV2ListResult:
    type: object
    description: The response of a SqlServerV2 list operation.
    properties:
      value:
        type: array
        description: The SqlServerV2 items on this page
        items:
          $ref: '#/definitions/SqlServerV2'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  ProductSupportStatus:
    type: object
    description: product support status.
    properties:
      currentVersion:
        type: string
        description: current version.
      esuStatus:
        $ref: '#/definitions/esuStatus'
        description: esu status.
      supportStatus:
        $ref: '#/definitions/supportStatus'
        description: support status.
      supportEndDate:
        type: string
        format: date-time
        description: support end date.
      esuYear:
        $ref: '#/definitions/esuYear'
        description: esu year.
  SqlServerV2UpdateProperties:
    type: object
    description: The updatable properties of the SqlServerV2.
    properties:
      numberOfAgDatabases:
        type: integer
        format: int32
        description: Gets or sets the number of databases part of availability group on this SQL instance.
      sqlFciProperties:
        $ref: '#/definitions/SqlFciProperties'
        description: Gets or sets the FCI properties if the instance is an FCI instance. This would be populated if IsClustered is true.
      productSupportStatus:
        $ref: '#/definitions/ProductSupportStatus'
        description: product support status.
      version:
        type: string
        description: Gets or sets the SQL server version.
      numberOfUserDatabases:
        type: integer
        format: int32
        description: Gets or sets total number of users databases.
      sumOfUserDatabasesSizeInMb:
        type: number
        format: float
        description: Gets or sets total size of all user databases.
      tempDbSizeInMb:
        type: number
        format: float
        description: Gets or sets size of temp database.
      maxServerMemoryInUseInMb:
        type: number
        format: float
        description: Gets or sets maximum server memory in use.
      visibleOnlineCoreCount:
        type: integer
        format: int32
        description: Gets or sets the SQL server number of cores that have visible online status.
      numOfLogins:
        type: integer
        format: int32
        description: Gets or sets number of logins.
      physicalCpuCount:
        type: number
        format: float
        description: Gets or sets physical CPU count.
      logicalCpuCount:
        type: integer
        format: int32
        description: Gets or sets logical CPU count.
      engineEdition:
        type: string
        description: Gets or sets the SQL server engine edition.
      edition:
        type: string
        description: Gets or sets the SQL server edition.
      isHighAvailabilityEnabled:
        type: boolean
        description: Gets or sets a value indicating whether High Availability is enabled or not.
      isClustered:
        type: boolean
        description: Gets or sets a value indicating whether failover cluster is configured or not.
      hyperthreadRatio:
        type: integer
        format: int32
        description: Gets or sets the Hyper thread ratio.
      sqlStartTime:
        type: string
        format: date-time
        description: Gets or sets the SQL start time.
      runAsAccountId:
        type: string
        description: Gets or sets the run as account ID of the SQL server.
      hydratedRunAsAccountId:
        type: string
        description: Gets or sets the hydrated run as account ID of the SQL server.
      hostName:
        type: string
        description: Gets or sets hostname.
      sqlServerName:
        type: string
        description: Gets or sets the SQL server instance name.
      portNumber:
        type: integer
        format: int32
        description: Gets or sets the Preferred Port Number.
      tags:
        type: object
        description: Gets or sets tags on the resource.
        additionalProperties:
          $ref: '#/definitions/Azure.ResourceManager.Object'
      isDeleted:
        type: boolean
        description: Gets or sets a value indicating whether the entity is deleted.
      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.
      status:
        $ref: '#/definitions/SqlServerStatus'
        description: Gets or sets the powered on status.
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The status of the last operation.
  SqlFciProperties:
    type: object
    description: The class representing the properties for an FCI instance.
    properties:
      state:
        $ref: '#/definitions/FCIInstanceState'
        description: Gets or sets the state of the FCI instance.
      networkName:
        type: string
        description: Gets or sets the FCI Network Name used to connect to this FCI instance.
      isMultiSubnet:
        type: boolean
        description: 'Gets or sets a value indicating whether the FCI is hosted on possible owners

          which are in multiple subnets.'
      sharedDiskCount:
        type: integer
        format: int32
        description: Gets or sets the count of Shared Disks for SQL FCI.
  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.
  SqlServerStatus:
    type: string
    description: sql server status
    enum:
    - Unknown
    - ContinuePending
    - Paused
    - PausePending
    - Running
    - StartPending
    - Stopped
    - StopPending
    x-ms-enum:
      name: SqlServerStatus
      modelAsString: true
      values:
      - name: Unknown
        value: Unknown
        description: Unknown value.
      - name: ContinuePending
        value: ContinuePending
        description: ContinuePending value.
      - name: Paused
        value: Paused
        description: Paused value.
      - name: PausePending
        value: PausePending
        description: PausePending value.
      - name: Running
        value: Running
        description: Running value.
      - name: StartPending
        value: StartPending
        description: StartPending value.
      - name: Stopped
        value: Stopped
        description: Stopped value.
      - name: StopPending
        value: StopPending
        description: StopPending value.
  SqlServerV2:
    type: object
    description: Class representing the web model of SQL Server.
    properties:
      properties:
        $ref: '#/definitions/SqlServerProperties'
        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
  esuYear:
    type: string
    description: esu year
    enum:
    - Unknown
    - FirstYear
    - SecondYear
    - ThirdYear
    - UpgradeYear
    x-ms-enum:
      name: esuYear
      modelAsString: true
      values:
      - name: Unknown
        value: Unknown
        description: Unknown value.
      - name: FirstYear
        value: FirstYear
        description: FirstYear value.
      - name: SecondYear
        value: SecondYear
        description: SecondYear value.
      - name: ThirdYear
        value: ThirdYear
        description: ThirdYear value.
      - name: UpgradeYear
        value: UpgradeYear
        description: UpgradeYear value.
  SqlServerProperties:
    type: object
    description: Class for SQL Server properties.
    properties:
      machineOverviewList:
        type: array
        description: Gets the Machine Overview properties of all machines on which the SQL server is deployed.
        items:
          $ref: '#/definitions/SqlMachineOverview'
        readOnly: true
        x-ms-identifiers: []
      numberOfAgDatabases:
        type: integer
        format: int32
        description: Gets or sets the number of databases part of availability group on this SQL instance.
      sqlFciProperties:
        $ref: '#/definitions/SqlFciProperties'
        description: Gets or sets the FCI properties if the instance is an FCI instance. This would be populated if IsClustered is true.
      productSupportStatus:
        $ref: '#/definitions/ProductSupportStatus'
        description: product support status.
      version:
        type: string
        description: Gets or sets the SQL server version.
      numberOfUserDatabases:
        type: integer
        format: int32
        description: Gets or sets total number of users databases.
      sumOfUserDatabasesSizeInMb:
        type: number
        format: float
        description: Gets or sets total size of all user databases.
      tempDbSizeInMb:
        type: number
        format: float
        description: Gets or sets size of temp database.
      maxServerMemoryInUseInMb:
        type: number
        format: float
        description: Gets or sets maximum server memory in use.
      visibleOnlineCoreCount:
        type: integer
        format: int32
        description: Gets or sets the SQL server number of cores that have visible online status.
      numOfLogins:
        type: integer
        format: int32
        description: Gets or sets number of logins.
      physicalCpuCount:
        type: number
        format: float
        description: Gets or sets physical CPU count.
      logicalCpuCount:
        type: integer
        format: int32
        description: Gets or sets logical CPU count.
      engineEdition:
        type: string
        description: Gets or sets the SQL server engine edition.
      edition:
        type: string
        description: Gets or sets the SQL server edition.
      isHighAvailabilityEnabled:
        type: boolean
        description: Gets or sets a value indicating whether High Availability is enabled or not.
      isClustered:
        type: boolean
        description: Gets or sets a value indicating whether failover cluster is configured or not.
      hyperthreadRatio:
        type: integer
        format: int32
        description: Gets or sets the Hyper thread ratio.
      sqlStartTime:
        type: string
        format: date-time
        description: Gets or sets the SQL start time.
      machineArmIds:
        type: array
        description: Gets the list of machine ARM Ids on which the SQL server is deployed.
        items:
          type: string
        readOnly: true
      runAsAccountId:
        type: string
        description: Gets or sets the run as account ID of the SQL server.
      hydratedRunAsAccountId:
        type: string
        description: Gets or sets the hydrated run as account ID of the SQL server.
      hostName:
        type: string
        description: Gets or sets hostname.
      sqlServerName:
        type: string
        description: Gets or sets the SQL server instance name.
      portNumber:
        type: integer
        format: int32
        description: Gets or sets the Preferred Port Number.
      errors:
        type: array
        description: Gets the errors.
        items:
          $ref: '#/definitions/Errors'
        readOnly: true
      tags:
        type: object
        description: Gets or sets tags on the resource.
        additionalProperties:
          $ref: '#/definitions/Azure.ResourceManager.Object'
      isDeleted:
        type: boolean
        description: Gets or sets a value indicating whether the entity is deleted.
      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.
      status:
        $ref: '#/definitions/SqlServerStatus'
        description: Gets or sets the powered on status.
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The status of the last operation.
  SqlMachineOverviewFciRole:
    type: string
    description: 'sql fci role '
    enum:
    - Unknown
    - NotApplicable
    - ActiveNode
    - PossibleOwnerNode
    x-ms-enum:
      name: SqlMachineOverviewFciRole
      modelAsString: true
      values:
      - name: Unknown
        value: Unknown
        description: Unknown value.
      - name: NotApplicable
        value: NotApplicable
        description: NotApplicable value.
      - name: ActiveNode
        value: ActiveNode
        description: ActiveNode value.
      - name: PossibleOwnerNode
        value: PossibleOwnerNode
        description: PossibleOwnerNode value.
  Azure.ResourceManager.Object:
    type: object
    description: object model
  FCIInstanceState:
    type: string
    description: 'fci instance state '
    enum:
    - Unknown
    - Inherited
    - Initializing
    - Online
    - Offline
    - Failed
    - Pending
    - OnlinePending
    - OfflinePending
    x-ms-enum:
      name: FCIInstanceState
      modelAsString: true
      values:
      - name: Unknown
        value: Unknown
        description: Unknown value.
      - name: Inherited
        value: Inherited
        description: Inherited value.
      - name: Initializing
        value: Initializing
        description: Initializing value.
      - name: Online
        value: Online
        description: Online value.
      - name: Offline
        value: Offline
        description: Offline value.
      - name: Failed
        value: Failed
        description: Failed value.
      - name: Pending
        value: Pending
        description: Pending value.
      - name: OnlinePending
        value: OnlinePending
        description: OnlinePending value.
      - name: OfflinePending
        value: OfflinePending
        description: OfflinePending 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.
  supportStatus:
    type: string
    description: support status
    enum:
    - Unknown
    - Mainstream
    - Extended
    x-ms-enum:
      name: supportStatus
      modelAsString: true
      values:
      - name: Unknown
        value: Unknown
        description: Unknown value.
      - name: Mainstream
        value: Mainstream
        description: Mainstream value.
      - name: Extended
        value: Extended
        description: Extended value.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'