Firewall Rules - List By Server

Gets a list of firewall rules.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules?api-version=2021-02-01-preview

URI Parameters

Name In Required Type Description
resourceGroupName
path True
  • string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName
path True
  • string

The name of the server.

subscriptionId
path True
  • string

The subscription ID that identifies an Azure subscription.

api-version
query True
  • string

The API version to use for the request.

Responses

Name Type Description
200 OK

Successfully retrieved the list of firewall rules.

Other Status Codes

*** Error Responses: ***

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

  • 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.

  • 404 ResourceNotFound - The requested resource was not found.

Examples

List Firewall Rules

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/firewallrulecrudtest-12/providers/Microsoft.Sql/servers/firewallrulecrudtest-6285/firewallRules?api-version=2021-02-01-preview

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/firewallrulecrudtest-12/providers/Microsoft.Sql/servers/firewallrulecrudtest-6285/firewallRules/firewallrulecrudtest-2304",
      "name": "firewallrulecrudtest-2304",
      "type": "Microsoft.Sql/servers/firewallRules",
      "properties": {
        "startIpAddress": "0.0.0.0",
        "endIpAddress": "0.0.0.0"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/firewallrulecrudtest-12/providers/Microsoft.Sql/servers/firewallrulecrudtest-6285/firewallRules/firewallrulecrudtest-3927",
      "name": "firewallrulecrudtest-3927",
      "type": "Microsoft.Sql/servers/firewallRules",
      "properties": {
        "startIpAddress": "0.0.0.1",
        "endIpAddress": "0.0.0.1"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/firewallrulecrudtest-12/providers/Microsoft.Sql/servers/firewallrulecrudtest-6285/firewallRules/firewallrulecrudtest-5370",
      "name": "firewallrulecrudtest-5370",
      "type": "Microsoft.Sql/servers/firewallRules",
      "properties": {
        "startIpAddress": "0.0.0.3",
        "endIpAddress": "0.0.0.3"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/firewallrulecrudtest-12/providers/Microsoft.Sql/servers/firewallrulecrudtest-6285/firewallRules/firewallrulecrudtest-5767",
      "name": "firewallrulecrudtest-5767",
      "type": "Microsoft.Sql/servers/firewallRules",
      "properties": {
        "startIpAddress": "0.0.0.2",
        "endIpAddress": "0.0.0.2"
      }
    }
  ]
}

Definitions

FirewallRule

A server firewall rule.

FirewallRuleListResult

The response to a list firewall rules request

FirewallRule

A server firewall rule.

Name Type Description
id
  • string

Resource ID.

name
  • string

Resource name.

properties.endIpAddress
  • string

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' for all Azure-internal IP addresses.

properties.startIpAddress
  • string

The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' for all Azure-internal IP addresses.

type
  • string

Resource type.

FirewallRuleListResult

The response to a list firewall rules request

Name Type Description
nextLink
  • string

Link to retrieve next page of results.

value

Array of results.