Microsoft Azure

Microsoft Azure SQL Database Server Firewall Rules

Microsoft Azure SQL Database Server Firewall Rules allow users to control access to their Azure SQL databases by defining rules that specify the IP addresses or IP address ranges that are allowed to connect to the server. This feature adds an additional layer of security to the database server by restricting access to only trusted sources. Users can create, modify, and delete firewall rules as needed to ensure that only authorized users are able to connect to the database server.

Documentation GitHub OpenAPI

Documentation

📖

Documentation

https://learn.microsoft.com/en-us/azure/azure-sql/database/firewall-configure?view=azuresql

Specifications

⚙

OpenAPI

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

OpenAPI Specification

swagger: '2.0'
info:
  title: Microsoft Azure Azure SQL Database server firewall rules
  description: >-
    Provides create, read, update, and delete functionality for Azure SQL
    Database server firewall rules.
  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}/firewallRules/{firewallRuleName}
  : put:
      tags:
        - FirewallRules
      operationId: microsoftAzureFirewallrulesCreateorupdate
      description: Creates or updates a firewall rule.
      x-ms-examples:
        Create a firewall rule max/min:
          $ref: ./examples/FirewallRuleCreate.json
        Update a firewall rule max/min:
          $ref: ./examples/FirewallRuleUpdate.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: firewallRuleName
          in: path
          required: true
          type: string
          description: The name of the firewall rule.
        - name: parameters
          in: body
          required: true
          schema:
            $ref: '#/definitions/FirewallRule'
          description: The required parameters for creating or updating a firewall rule.
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/FirewallRule'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/FirewallRule'
      summary: >-
        Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Servername Firewallrules Firewallrulename
    delete:
      tags:
        - FirewallRules
      operationId: microsoftAzureFirewallrulesDelete
      description: Deletes a firewall rule.
      x-ms-examples:
        Delete a firewall rule:
          $ref: ./examples/FirewallRuleDelete.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: firewallRuleName
          in: path
          required: true
          type: string
          description: The name of the firewall rule.
      responses:
        '200':
          description: OK
        '204':
          description: NoContent
      summary: >-
        Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Servername Firewallrules Firewallrulename
    get:
      tags:
        - FirewallRules
      operationId: microsoftAzureFirewallrulesGet
      description: Gets a firewall rule.
      x-ms-examples:
        Get Firewall Rule:
          $ref: ./examples/FirewallRuleGet.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: firewallRuleName
          in: path
          required: true
          type: string
          description: The name of the firewall rule.
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/FirewallRule'
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Servername Firewallrules Firewallrulename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules
  : get:
      tags:
        - FirewallRules
      operationId: microsoftAzureFirewallrulesListbyserver
      description: Returns a list of firewall rules.
      x-ms-examples:
        List Firewall Rules:
          $ref: ./examples/FirewallRuleList.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/FirewallRuleListResult'
      x-ms-pageable:
        nextLinkName:
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Servername Firewallrules
definitions:
  FirewallRuleProperties:
    properties:
      startIpAddress:
        type: string
        description: >-
          The start IP address of the firewall rule. Must be IPv4 format. Use
          value '0.0.0.0' to represent all Azure-internal IP addresses.
      endIpAddress:
        type: string
        description: >-
          The end IP address of the firewall rule. Must be IPv4 format. Must be
          greater than or equal to startIpAddress. Use value '0.0.0.0' to
          represent all Azure-internal IP addresses.
    required:
      - startIpAddress
      - endIpAddress
    description: Represents the properties of a server firewall rule.
  FirewallRule:
    properties:
      kind:
        type: string
        description: Kind of server that contains this firewall rule.
        readOnly: true
      location:
        type: string
        description: Location of the server that contains this firewall rule.
        readOnly: true
      type:
        type: string
        description: Type of resource this is.
        readOnly: true
      properties:
        $ref: '#/definitions/FirewallRuleProperties'
        description: The properties representing the resource.
        x-ms-client-flatten: true
    allOf:
      - $ref: ../../../common/v1/types.json#/definitions/ProxyResource
    description: Represents a server firewall rule.
  FirewallRuleListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/FirewallRule'
        description: The list of server firewall rules.
    description: Represents the response to a List Firewall Rules 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: FirewallRules