Azure SQL Database Servers API

openapi: 3.0.0
info:
  title: Azure SQL Database servers API (Microsoft.Sql 2025-01-01)
  version: 2025-01-01
  description: The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve,
    update, and delete databases, servers, and other entities.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  x-source: https://github.com/Azure/azure-rest-api-specs/blob/main/specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/servers.json
  x-provenance:
    method: searched
    generated: '2026-11-05'
    note: Converted Swagger 2.0 to OpenAPI 3 (swagger2openapi, refs resolved, x-ms-examples dropped) from Microsoft own Azure/azure-rest-api-specs repo; host management.azure.com is Azure Resource Manager,
      operated by Microsoft. Verbatim originals in openapi/_original/.
security:
- azure_auth:
  - user_impersonation
tags:
- name: Servers
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/checkNameAvailability:
    post:
      operationId: Servers_CheckNameAvailability
      tags:
      - Servers
      description: Determines whether a resource can be created with the specified name.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckNameAvailabilityRequest'
        description: The request body
        required: true
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckNameAvailabilityResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/servers:
    get:
      operationId: Servers_List
      tags:
      - Servers
      description: Gets a list of all servers in the subscription.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: $expand
        in: query
        description: The child resources to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers:
    get:
      operationId: Servers_ListByResourceGroup
      tags:
      - Servers
      description: Gets a list of servers in a resource groups.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: $expand
        in: query
        description: The child resources to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}:
    get:
      operationId: Servers_Get
      tags:
      - Servers
      description: Gets a server.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: serverName
        in: path
        description: The name of the server.
        required: true
        schema:
          type: string
      - name: $expand
        in: query
        description: The child resources to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Server'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      operationId: Servers_CreateOrUpdate
      tags:
      - Servers
      description: Creates or updates a server.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: serverName
        in: path
        description: The name of the server.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Server'
        description: The requested server resource state.
        required: true
      responses:
        '200':
          description: Resource 'Server' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Server'
        '201':
          description: Resource 'Server' create operation succeeded
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Server'
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/Server'
      x-ms-long-running-operation: true
    patch:
      operationId: Servers_Update
      tags:
      - Servers
      description: Updates a server.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: serverName
        in: path
        description: The name of the server.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServerUpdate'
        description: The requested server resource state.
        required: true
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Server'
        '202':
          description: Resource update request accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/Server'
      x-ms-long-running-operation: true
    delete:
      operationId: Servers_Delete
      tags:
      - Servers
      description: Deletes a server.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: serverName
        in: path
        description: The name of the server.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource deleted successfully.
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/import:
    post:
      operationId: Servers_ImportDatabase
      tags:
      - Servers
      description: Imports a bacpac into a new database.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: serverName
        in: path
        description: The name of the server.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportNewDatabaseDefinition'
        description: The database import request parameters.
        required: true
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                type: object
                description: An ImportExport operation result resource.
                properties:
                  properties:
                    type: object
                    description: Contains the operation result properties for import/export operation.
                    properties:
                      requestId:
                        type: string
                        format: uuid
                        description: Universally Unique Identifier
                      requestType:
                        type: string
                        description: Request type.
                        readOnly: true
                      queuedTime:
                        type: string
                        description: Queued time.
                        readOnly: true
                      lastModifiedTime:
                        type: string
                        description: Last modified time.
                        readOnly: true
                      blobUri:
                        type: string
                        description: Blob Uri.
                        readOnly: true
                      serverName:
                        type: string
                        description: Server name.
                        readOnly: true
                      databaseName:
                        type: string
                        description: Database name.
                        readOnly: true
                      status:
                        type: string
                        description: Operation status.
                        readOnly: true
                      errorMessage:
                        type: string
                        description: Error message.
                        readOnly: true
                      privateEndpointConnections:
                        type: array
                        description: Gets the status of private endpoints associated with this request.
                        items:
                          type: object
                          description: Contains the private endpoint connection requests status.
                          properties:
                            privateLinkServiceId:
                              type: string
                              description: Resource id for which the private endpoint is created.
                              readOnly: true
                            privateEndpointConnectionName:
                              type: string
                              description: The connection name for the private endpoint.
                              readOnly: true
                            status:
                              type: string
                              description: Status of this private endpoint connection.
                              readOnly: true
                        readOnly: true
                allOf:
                - type: object
                  title: Proxy Resource
                  description: The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
                  allOf:
                  - type: object
                    title: Resource
                    description: Common fields that are returned in the response for all Azure Resource Manager resources
                    properties:
                      id:
                        type: string
                        format: arm-id
                        description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
                        readOnly: true
                      name:
                        type: string
                        description: The name of the resource
                        readOnly: true
                      type:
                        type: string
                        description: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
                        readOnly: true
                      systemData:
                        type: object
                        description: Metadata pertaining to creation and last modification of the resource.
                        properties:
                          createdBy:
                            type: string
                            description: The identity that created the resource.
                          createdByType:
                            type: string
                            description: The type of identity that created the resource.
                            enum:
                            - User
                            - Application
                            - ManagedIdentity
                            - Key
                            x-ms-enum:
                              name: createdByType
                              modelAsString: true
                          createdAt:
                            type: string
                            format: date-time
                            description: The timestamp of resource creation (UTC).
                          lastModifiedBy:
                            type: string
                            description: The identity that last modified the resource.
                          lastModifiedByType:
                            type: string
                            description: The type of identity that last modified the resource.
                            enum:
                            - User
                            - Application
                            - ManagedIdentity
                            - Key
                            x-ms-enum:
                              name: createdByType
                              modelAsString: true
                          lastModifiedAt:
                            type: string
                            format: date-time
                            description: The timestamp of resource last modification (UTC)
                        readOnly: true
                    x-ms-azure-resource: true
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: ./common.json#/definitions/ImportExportOperationResult
      x-ms-long-running-operation: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/refreshExternalGovernanceStatus
  : post:
      operationId: Servers_RefreshStatus
      tags:
      - Servers
      description: Refresh external governance enablement status.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: serverName
        in: path
        description: The name of the server.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefreshExternalGovernanceStatusOperationResult'
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/RefreshExternalGovernanceStatusOperationResult'
      x-ms-long-running-operation: true
servers:


# --- truncated at 32 KB (50 KB total) ---
# Full source: https://artifacts.apis.io/microsoft-azure-sql-database/openapi/microsoft-azure-sql-database-servers-api-openapi.yml