Azure Database for MySQL Subscriptions API

The Subscriptions API from Azure Database for MySQL — 6 operation(s) for subscriptions.

GitHub OpenAPI

Operations 6

POST /subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/checkNameAvailability Check name availability without location execute #
GET /subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/capabilities Location based capabilities list #
POST /subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/checkNameAvailability Check name availability execute #
POST /subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/checkVirtualNetworkSubnetUsage Check virtual network subnet usage execute #
GET /subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/operationProgress/{operationId} Get the operation result for a long running operation #
GET /subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/operationResults/{operationId} Get the operation result for a long running operation #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/microsoft-azure-mysql:microsoft-azure-mysql-subscriptions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-azure-mysql-subscriptions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: MySQLManagementClient Subscriptions API
  version: '2024-12-30'
  description: The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules, VNET rules, log files and configurations with new business model.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Subscriptions
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/checkNameAvailability:
    post:
      operationId: CheckNameAvailabilityWithoutLocation_Execute
      description: Check the availability of name for server
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NameAvailability'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NameAvailabilityRequest'
        description: The request body
        required: true
      tags:
      - Subscriptions
      summary: Check name availability without location execute
      x-summary-source: derived
  /subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/capabilities:
    get:
      operationId: LocationBasedCapabilities_List
      description: Get capabilities at specified location in a given subscription.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/LocationNameParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapabilitiesListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Subscriptions
      summary: Location based capabilities list
      x-summary-source: derived
  /subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/checkNameAvailability:
    post:
      operationId: CheckNameAvailability_Execute
      description: Check the availability of name for server
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/LocationNameParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NameAvailability'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NameAvailabilityRequest'
        description: The request body
        required: true
      tags:
      - Subscriptions
      summary: Check name availability execute
      x-summary-source: derived
  /subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/checkVirtualNetworkSubnetUsage:
    post:
      operationId: CheckVirtualNetworkSubnetUsage_Execute
      description: Get virtual network subnet usage for a given vNet resource id.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/LocationNameParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualNetworkSubnetUsageResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VirtualNetworkSubnetUsageParameter'
        description: The request body
        required: true
      tags:
      - Subscriptions
      summary: Check virtual network subnet usage execute
      x-summary-source: derived
  /subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/operationProgress/{operationId}:
    get:
      operationId: OperationProgress_Get
      summary: Get the operation result for a long running operation
      description: Get the operation result for a long running operation.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/LocationNameParameter'
      - $ref: '#/components/parameters/OperationIdParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationProgressResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Subscriptions
  /subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/operationResults/{operationId}:
    get:
      operationId: OperationResults_Get
      summary: Get the operation result for a long running operation
      description: Get the operation result for a long running operation.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/LocationNameParameter'
      - $ref: '#/components/parameters/OperationIdParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationStatusExtendedResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Subscriptions
components:
  schemas:
    OperationProgressResponseType:
      type: object
      description: Represents the response properties specific to the operation
      properties:
        objectType:
          $ref: '#/components/schemas/ObjectType'
          description: Identifies the type of source operation
      discriminator:
        propertyName: objectType
      required:
      - objectType
    ServerVersionCapability:
      type: object
      description: Server version capabilities.
      properties:
        name:
          type: string
          description: server version
          readOnly: true
        supportedSkus:
          type: array
          description: A list of supported Skus
          items:
            $ref: '#/components/schemas/SkuCapability'
          readOnly: true
          x-ms-identifiers: []
    StorageEditionCapability:
      type: object
      description: storage edition capability
      properties:
        name:
          type: string
          description: storage edition name
          readOnly: true
        minStorageSize:
          type: integer
          format: int64
          description: The minimal supported storage size.
          readOnly: true
        maxStorageSize:
          type: integer
          format: int64
          description: The maximum supported storage size.
          readOnly: true
        minBackupRetentionDays:
          type: integer
          format: int64
          description: Minimal backup retention days
          readOnly: true
        maxBackupRetentionDays:
          type: integer
          format: int64
          description: Maximum backup retention days
          readOnly: true
        minBackupIntervalHours:
          type: integer
          format: int64
          description: Minimal backup interval hours
          readOnly: true
        maxBackupIntervalHours:
          type: integer
          format: int64
          description: Maximum backup interval hours
          readOnly: true
    ObjectType:
      type: string
      description: Identifies the type of source operation
      enum:
      - BackupAndExportResponse
      - ImportFromStorageResponse
      x-ms-enum:
        name: ObjectType
        modelAsString: true
        values:
        - name: BackupAndExportResponse
          value: BackupAndExportResponse
        - name: ImportFromStorageResponse
          value: ImportFromStorageResponse
    SkuCapability:
      type: object
      description: Sku capability
      properties:
        name:
          type: string
          description: vCore name
          readOnly: true
        vCores:
          type: integer
          format: int64
          description: supported vCores
          readOnly: true
        supportedIops:
          type: integer
          format: int64
          description: supported IOPS
          readOnly: true
        supportedMemoryPerVCoreMB:
          type: integer
          format: int64
          description: supported memory per vCore in MB
          readOnly: true
    OperationProgressResult:
      type: object
      description: Represents Operation Results API Response
      properties:
        properties:
          $ref: '#/components/schemas/OperationProgressResponseType'
          description: The response properties specific to the operation
      allOf:
      - $ref: '#/components/schemas/OperationStatusResult'
    DelegatedSubnetUsage:
      type: object
      description: Delegated subnet usage data.
      properties:
        subnetName:
          type: string
          description: name of the subnet
          readOnly: true
        usage:
          type: integer
          format: int64
          description: Number of used delegated subnets
          readOnly: true
    NameAvailability:
      type: object
      description: Represents a resource name availability.
      properties:
        message:
          type: string
          description: Error Message.
        nameAvailable:
          type: boolean
          description: Indicates whether the resource name is available.
        reason:
          type: string
          description: Reason for name being unavailable.
    ServerEditionCapability:
      type: object
      description: Server edition capabilities.
      properties:
        name:
          type: string
          description: Server edition name
          readOnly: true
        supportedStorageEditions:
          type: array
          description: A list of supported storage editions
          items:
            $ref: '#/components/schemas/StorageEditionCapability'
          readOnly: true
          x-ms-identifiers: []
        supportedServerVersions:
          type: array
          description: A list of supported server versions.
          items:
            $ref: '#/components/schemas/ServerVersionCapability'
          readOnly: true
          x-ms-identifiers: []
    OperationStatusResult:
      type: object
      description: The current status of an async operation.
      properties:
        id:
          type: string
          format: arm-id
          description: Fully qualified ID for the async operation.
        resourceId:
          type: string
          format: arm-id
          description: Fully qualified ID of the resource against which the original async operation was started.
          readOnly: true
        name:
          type: string
          description: Name of the async operation.
        status:
          type: string
          description: Operation status.
        percentComplete:
          type: number
          description: Percent of the operation that is complete.
          minimum: 0
          maximum: 100
        startTime:
          type: string
          format: date-time
          description: The start time of the operation.
        endTime:
          type: string
          format: date-time
          description: The end time of the operation.
        operations:
          type: array
          description: The operations list.
          items:
            $ref: '#/components/schemas/OperationStatusResult'
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: If present, details of the operation error.
      required:
      - status
    CapabilityProperties:
      type: object
      description: Location capabilities.
      properties:
        zone:
          type: string
          description: zone name
          readOnly: true
        supportedHAMode:
          type: array
          description: Supported high availability mode
          items:
            type: string
          readOnly: true
        supportedGeoBackupRegions:
          type: array
          description: supported geo backup regions
          items:
            type: string
          readOnly: true
        supportedFlexibleServerEditions:
          type: array
          description: A list of supported flexible server editions.
          items:
            $ref: '#/components/schemas/ServerEditionCapability'
          readOnly: true
          x-ms-identifiers: []
    VirtualNetworkSubnetUsageParameter:
      type: object
      description: Virtual network subnet usage parameter
      properties:
        virtualNetworkResourceId:
          type: string
          description: Virtual network resource id.
    ErrorResponse:
      type: object
      title: Error response
      description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: The error object.
    CapabilitiesListResult:
      type: object
      description: location capability
      properties:
        value:
          type: array
          description: The CapabilityProperties items on this page
          items:
            $ref: '#/components/schemas/CapabilityProperties'
          readOnly: true
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
    VirtualNetworkSubnetUsageResult:
      type: object
      description: Virtual network subnet usage data.
      properties:
        location:
          type: string
          description: The location name.
          readOnly: true
        subscriptionId:
          type: string
          description: The subscription id.
          readOnly: true
        delegatedSubnetsUsage:
          type: array
          description: A list of delegated subnet usage
          items:
            $ref: '#/components/schemas/DelegatedSubnetUsage'
          readOnly: true
          x-ms-identifiers: []
    ErrorDetail:
      type: object
      description: The error detail.
      properties:
        code:
          type: string
          description: The error code.
          readOnly: true
        message:
          type: string
          description: The error message.
          readOnly: true
        target:
          type: string
          description: The error target.
          readOnly: true
        details:
          type: array
          description: The error details.
          items:
            $ref: '#/components/schemas/ErrorDetail'
          readOnly: true
          x-ms-identifiers:
          - message
          - target
        additionalInfo:
          type: array
          description: The error additional info.
          items:
            $ref: '#/components/schemas/ErrorAdditionalInfo'
          readOnly: true
          x-ms-identifiers: []
    NameAvailabilityRequest:
      type: object
      description: Request from client to check resource name availability.
      properties:
        name:
          type: string
          description: Resource name to verify.
        type:
          type: string
          description: Resource type used for verification.
      required:
      - name
    OperationStatusExtendedResult:
      type: object
      description: Represents Operation Results API Response
      properties:
        properties:
          type: object
          description: The extended properties of Operation Results
          additionalProperties: {}
      allOf:
      - $ref: '#/components/schemas/OperationStatusResult'
  parameters:
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription. The value must be an UUID.
      required: true
      schema:
        type: string
        format: uuid
    OperationIdParameter:
      name: operationId
      in: path
      description: The ID of an ongoing async operation.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        minLength: 1
    LocationNameParameter:
      name: locationName
      in: path
      description: The name of the location.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        minLength: 1
        pattern: ^[ \w]+$
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.