Microsoft Azure

Microsoft Azure SQL Server API Spec

The Microsoft Azure SQL Server API Spec is a detailed document that outlines the guidelines and specifications for interacting with the Azure SQL Server API. It provides developers with information on how to make requests, handle responses, and utilize various functionalities of the SQL Server API. This includes details on authentication, endpoints, parameters, payload formats, error handling, and other important aspects of API integration.

Documentation GitHub OpenAPI

Documentation

📖

Documentation

https://learn.microsoft.com/en-us/rest/api/sql/

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/azure-sql-server-api-spec-openapi-original.yml

OpenAPI Specification

swagger: '2.0'
info:
  title: Microsoft Azure Azure SQL Server API spec
  description: >-
    The Azure SQL Server management API provides a RESTful set of web services
    that interact with Azure SQL Server services to manage your databases. The
    API enables users update server connection policy.
  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}/connectionPolicies/{connectionPolicyName}
  : put:
      tags:
        - ConnectionPolicies
      operationId: microsoftAzureServerconnectionpoliciesCreateorupdate
      description: Creates or updates the server's connection policy.
      x-ms-examples:
        Create or update a server's secure connection policy:
          $ref: ./examples/ServerConnectionPolicyCreateOrUpdate.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'
        - $ref: '#/parameters/ConnectionPolicyNameParameter'
        - name: parameters
          in: body
          required: true
          schema:
            $ref: '#/definitions/ServerConnectionPolicy'
          description: The required parameters for updating a secure connection policy.
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ServerConnectionPolicy'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/ServerConnectionPolicy'
      summary: >-
        Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Servername Connectionpolicies Connectionpolicyname
    get:
      tags:
        - ConnectionPolicies
      operationId: microsoftAzureServerconnectionpoliciesGet
      description: Gets the server's secure connection policy.
      x-ms-examples:
        Get a server's secure connection policy:
          $ref: ./examples/ServerConnectionPolicyGet.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'
        - $ref: '#/parameters/ConnectionPolicyNameParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ServerConnectionPolicy'
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Servername Connectionpolicies Connectionpolicyname
definitions:
  ServerConnectionPolicyProperties:
    properties:
      connectionType:
        type: string
        description: The server connection type.
        enum:
          - Default
          - Proxy
          - Redirect
        x-ms-enum:
          name: ServerConnectionType
    required:
      - connectionType
    description: The properties of a server secure connection policy.
  ServerConnectionPolicy:
    properties:
      kind:
        readOnly: true
        type: string
        description: Metadata used for the Azure portal experience.
      location:
        type: string
        description: Resource location.
        readOnly: true
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/ServerConnectionPolicyProperties'
        description: The properties of the server secure connection policy.
    allOf:
      - $ref: ../../../common/v1/types.json#/definitions/ProxyResource
    description: A server secure connection policy.
parameters:
  ServerNameParameter:
    name: serverName
    in: path
    required: true
    type: string
    description: The name of the server.
    x-ms-parameter-location: method
  ConnectionPolicyNameParameter:
    name: connectionPolicyName
    in: path
    required: true
    type: string
    enum:
      - default
    description: The name of the connection policy.
    x-ms-enum:
      modelAsString: true
      name: ConnectionPolicyName
    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: ConnectionPolicies