Microsoft Azure SQL Database

Microsoft Azure SQL Database is a cloud-based relational database service offered by Microsoft. It allows users to store and manage relational data in the cloud, eliminating the need for on-premises hardware and maintenance. With Azure SQL Database, users can scale their databases up or down as needed, ensuring optimal performance and cost efficiency. The service also offers built-in security features, automated backups, and high availability to ensure data is always accessible and protected.

OpenAPI Specification

azure-sql-database-openapi-original.yml Raw ↑
swagger: '2.0'
info:
  title: Microsoft Azure Azure SQL Database
  description: >-
    Provides create, read, update and delete functionality for Azure SQL
    Database resources including servers, databases, elastic pools,
    recommendations, operations, and usage metrics.
  version: '2014-04-01'
host: management.azure.com
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/usages:
    get:
      tags:
        - Servers
      operationId: microsoftAzureServerusagesListbyserver
      description: Returns server usages.
      x-ms-examples:
        List servers usages:
          $ref: ./examples/ServerUsageMetricsList.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'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ServerUsageListResult'
      x-ms-pageable:
        nextLinkName:
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Servername Usages
  ? /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:
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Servername Databases Databasename Usages
definitions:
  ServerUsage:
    properties:
      name:
        readOnly: true
        type: string
        description: Name of the server usage metric.
      resourceName:
        readOnly: true
        type: string
        description: The name of the resource.
      displayName:
        readOnly: true
        type: string
        description: The metric display name.
      currentValue:
        readOnly: true
        type: number
        format: double
        description: The current value of the metric.
      limit:
        readOnly: true
        type: number
        format: double
        description: The current limit of the metric.
      unit:
        readOnly: true
        type: string
        description: The units of the metric.
      nextResetTime:
        readOnly: true
        type: string
        format: date-time
        description: The next reset time for the metric (ISO8601 format).
    description: Represents server metrics.
  ServerUsageListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/ServerUsage'
        description: The list of server metrics for the server.
    required:
      - value
    description: Represents the response to a list server metrics request.
  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.
  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.
parameters:
  ServerNameParameter:
    name: serverName
    in: path
    required: true
    type: string
    description: The name of the server.
    x-ms-parameter-location: method
securityDefinitions:
  azure_auth:
    type: oauth2
    description: Azure Active Directory OAuth2 Flow
    flow: implicit
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
    scopes:
      user_impersonation: impersonate your user account
tags:
  - name: Databases
  - name: Servers