Microsoft Azure SqlAvailabilityGroupsController API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Sql Availability Groups Controller API
tags:
- name: SqlAvailabilityGroupsController
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlAvailabilityGroups
  : get:
      operationId: microsoftAzureSqlavailabilitygroupscontrollerListbysqlsite
      tags:
      - SqlAvailabilityGroupsController
      description: Gets the sql availability groups.
      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
        schema:
          type: string
      - name: top
        in: query
        description: page size  query
        required: false
        schema:
          type: string
      - name: continuationToken
        in: query
        description: Optional parameter for continuation token.
        required: false
        schema:
          type: string
      - name: totalRecordCount
        in: query
        description: Total count of machines in the given site.
        required: false
        schema:
          type: integer
          format: int32
      - name: siteName
        in: path
        description: Site name
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: sqlSiteName
        in: path
        description: SQL site name.
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: ARM operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SqlAvailabilityGroupListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        SqlAvailabilityGroupsController_ListBySqlSite_MaximumSet_Gen:
          $ref: ./examples/SqlAvailabilityGroupsController_ListBySqlSite_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename Sqlsites Sqlsitename Sqlavailabilitygroups
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlAvailabilityGroups/{sqlAvailabilityGroupName}
  : get:
      operationId: microsoftAzureSqlavailabilitygroupscontrollerGet
      tags:
      - SqlAvailabilityGroupsController
      description: Gets the sql availability group.
      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
        schema:
          type: string
          pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: sqlSiteName
        in: path
        description: SQL site name.
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: sqlAvailabilityGroupName
        in: path
        description: SQL availability group name.
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: ARM operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SqlAvailabilityGroup'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        SqlAvailabilityGroupsController_Get_MaximumSet_Gen:
          $ref: ./examples/SqlAvailabilityGroupsController_Get_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename Sqlsites Sqlsitename Sqlavailabilitygroups Sqlavailabilitygroupname
components:
  schemas:
    SqlAvailabilityReplicaProperties:
      type: object
      description: Class for SQL Server availability replica properties.
      properties:
        availabilityReplicaName:
          type: string
          description: Gets or sets the SQL Availability Replica Name.
        availabilityReplicaId:
          type: string
          description: Gets or sets the SQL Availability Replica Id.
        replicaType:
          $ref: '#/components/schemas/SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaType'
          description: Gets or sets the replica type of the availability group.
        replicaState:
          $ref: '#/components/schemas/SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaState'
          description: Gets or sets the state of the availability replica.
        replicaSyncStatus:
          $ref: '#/components/schemas/SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaSyncStatus'
          description: Gets or sets the synchronization status of the replica.
        replicaCommitMode:
          $ref: '#/components/schemas/SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaCommitMode'
          description: Gets or sets the commit mode of the replica.
        replicaReadMode:
          $ref: '#/components/schemas/SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaReadMode'
          description: Gets or sets the read mode of the replica.
        replicaSeedMode:
          $ref: '#/components/schemas/SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaSeedMode'
          description: Gets or sets the seed mode of the replica.
        sqlDatabaseReplicaInfo:
          $ref: '#/components/schemas/SqlDatabaseReplicaInfo'
          description: "Gets or sets the Availability Replica object if Replica is of type database.\nThis is null in case Replica is\n            of type AG. This is to be populated\nin case of normal AG."
        sqlAvailabilityGroupReplicaInfo:
          $ref: '#/components/schemas/SqlAvailabilityGroupReplicaInfo'
          description: "Gets or sets the Availability Replica object if Replica is of type AG. This is\nnull in case Replica is\n            of type database. This is to be populated\nin case AG is of type DAG."
    SqlDatabaseReplicaInfo:
      type: object
      description: 'Class which represents the SQL availability replica properties of type

        databases.'
      properties:
        hostName:
          type: string
          description: Gets or sets the host name of the availability replica.
        sqlServerName:
          type: string
          description: Gets or sets the SQL Server name of the availability replica.
        sqlServerArmId:
          type: string
          description: Gets or sets the SQL Server name of the availability replica.
    SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaType:
      type: string
      description: ReplicaType
      enum:
      - Unknown
      - DatabaseReplica
      - AvailabilityGroupReplica
      x-ms-enum:
        name: SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaType
        modelAsString: true
        values:
        - name: Unknown
          value: Unknown
          description: Unknown value.
        - name: DatabaseReplica
          value: DatabaseReplica
          description: DatabaseReplica value.
        - name: AvailabilityGroupReplica
          value: AvailabilityGroupReplica
          description: AvailabilityGroupReplica value.
    SqlAvailabilityGroup:
      type: object
      description: Class representing the web model of SQL Availability Group.
      properties:
        properties:
          $ref: '#/components/schemas/SqlAvailabilityGroupProperties'
          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
    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.
    SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaSeedMode:
      type: string
      description: ReplicaSeedMode
      enum:
      - Unknown
      - Manual
      - Automatic
      x-ms-enum:
        name: SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaSeedMode
        modelAsString: true
        values:
        - name: Unknown
          value: Unknown
          description: Unknown value.
        - name: Manual
          value: Manual
          description: Manual value.
        - name: Automatic
          value: Automatic
          description: Automatic value.
    SqlAvailabilityGroupProperties:
      type: object
      description: Class for SQL Server availability group properties.
      properties:
        availabilityGroupName:
          type: string
          description: Gets or sets the SQL Availability Group Name.
        availabilityGroupType:
          $ref: '#/components/schemas/SqlAvailabilityGroupPropertiesAvailabilityGroupType'
          description: 'Gets or sets the type of availability group.             Currently there are two types of AGs Traditional and Distributed. '
        isMultiSubNet:
          type: boolean
          description: Gets or sets a value indicating whether AG is multi subnet or not.
        clusterName:
          type: string
          description: Gets or sets the Cluster name where AG is hosted.
        availabilityReplicas:
          type: array
          description: Gets the list of availability replica properties which together forms this availability group.
          items:
            $ref: '#/components/schemas/SqlAvailabilityReplicaProperties'
          readOnly: true
          x-ms-identifiers: []
        parentReplicaOverviewList:
          type: array
          description: "Gets the parent availability replica overview if any.\n            This would be\nset with details of parent AG and AR for cases where this availability group is\na part of a distributed AG.\n            Currently, we do not populate this\nsince discovery and linking of DAG(Distributed Availability Group) is not\nimplemented."
          items:
            $ref: '#/components/schemas/SqlAvailabilityReplicaOverview'
          readOnly: true
          x-ms-identifiers: []
        isPartOfDistributedAvailabilityGroup:
          type: boolean
          description: 'Gets or sets a value indicating whether this Availability group is part of a

            distributed AG.'
        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.
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          description: provisioning state enum
          readOnly: true
    SqlAvailabilityReplicaOverview:
      type: object
      description: Web model for SQL replica overview.
      properties:
        replicaState:
          $ref: '#/components/schemas/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.
    SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaCommitMode:
      type: string
      description: ReplicaCommitMode
      enum:
      - Unknown
      - Synchronous
      - Asynchronous
      x-ms-enum:
        name: SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaCommitMode
        modelAsString: true
        values:
        - name: Unknown
          value: Unknown
          description: Unknown value.
        - name: Synchronous
          value: Synchronous
          description: Synchronous value.
        - name: Asynchronous
          value: Asynchronous
          description: Asynchronous value.
    SqlAvailabilityGroupListResult:
      type: object
      description: The response of a SqlAvailabilityGroup list operation.
      properties:
        value:
          type: array
          description: The SqlAvailabilityGroup items on this page
          items:
            $ref: '#/components/schemas/SqlAvailabilityGroup'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaState:
      type: string
      description: ReplicaState
      enum:
      - Unknown
      - Primary
      - Secondary
      x-ms-enum:
        name: SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaState
        modelAsString: true
        values:
        - name: Unknown
          value: Unknown
          description: Unknown value.
        - name: Primary
          value: Primary
          description: Primary value.
        - name: Secondary
          value: Secondary
          description: Secondary value.
    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.
    SqlAvailabilityGroupReplicaInfo:
      type: object
      description: Class which represents the SQL availability replica properties of type AG.
      properties:
        clusterName:
          type: string
          description: Gets or sets the name of the cluster on which this replica is hosted.
        availabilityGroupName:
          type: string
          description: Gets or sets the name of the availability replica.
        availabilityGroupArmId:
          type: string
          description: Gets or sets the AG ARM ID which are part of this Replica.
    SqlAvailabilityGroupPropertiesAvailabilityGroupType:
      type: string
      description: AvailabilityGroupType
      enum:
      - Unknown
      - Traditional
      - Distributed
      x-ms-enum:
        name: SqlAvailabilityGroupPropertiesAvailabilityGroupType
        modelAsString: true
        values:
        - name: Unknown
          value: Unknown
          description: Unknown value.
        - name: Traditional
          value: Traditional
          description: Traditional value.
        - name: Distributed
          value: Distributed
          description: Distributed value.
    SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaReadMode:
      type: string
      description: ReplicaReadMode
      enum:
      - Unknown
      - None
      - ReadOnly
      - ReadWrite
      x-ms-enum:
        name: SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaReadMode
        modelAsString: true
        values:
        - name: Unknown
          value: Unknown
          description: Unknown value.
        - name: None
          value: None
          description: None value.
        - name: ReadOnly
          value: ReadOnly
          description: ReadOnly value.
        - name: ReadWrite
          value: ReadWrite
          description: ReadWrite value.
    SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaSyncStatus:
      type: string
      description: ReplicaSyncStatus
      enum:
      - Unknown
      - Synchronized
      - Unsynchronized
      x-ms-enum:
        name: SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaSyncStatus
        modelAsString: true
        values:
        - name: Unknown
          value: Unknown
          description: Unknown value.
        - name: Synchronized
          value: Synchronized
          description: Synchronized value.
        - name: Unsynchronized
          value: Unsynchronized
          description: Unsynchronized value.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'