Firewall Rules - List By Server

List all the firewall rules in a given server.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/firewallRules?api-version=2017-12-01

URI Parameters

Name In Required Type Description
resourceGroupName
path True
  • string

The name of the resource group. The name is case insensitive.

Regex pattern: ^[-\w\._\(\)]+$

serverName
path True
  • string

The name of the server.

subscriptionId
path True
  • string

The ID of the target subscription.

api-version
query True
  • string

The API version to use for this operation.

Responses

Name Type Description
200 OK

OK

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

FirewallRuleList

Sample Request

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBForPostgreSQL/servers/testserver/firewallRules?api-version=2017-12-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule1",
      "name": "rule1",
      "type": "Microsoft.DBforPostgreSQL/servers/firewallRules",
      "properties": {
        "startIpAddress": "0.0.0.0",
        "endIpAddress": "255.255.255.255"
      }
    },
    {
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule2",
      "name": "rule2",
      "type": "Microsoft.DBforPostgreSQL/servers/firewallRules",
      "properties": {
        "startIpAddress": "1.0.0.0",
        "endIpAddress": "255.0.0.0"
      }
    }
  ]
}

Definitions

CloudError

An error response from the Batch service.

ErrorAdditionalInfo

The resource management error additional info.

ErrorResponse

Error Response

FirewallRule

Represents a server firewall rule.

FirewallRuleListResult

A list of firewall rules.

CloudError

An error response from the Batch service.

Name Type Description
error

Error Response
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info
  • object

The additional info.

type
  • string

The additional info type.

ErrorResponse

Error Response

Name Type Description
additionalInfo

The error additional info.

code
  • string

The error code.

details

The error details.

message
  • string

The error message.

target
  • string

The error target.

FirewallRule

Represents a server firewall rule.

Name Type Description
id
  • string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

The name of the resource

properties.endIpAddress
  • string

The end IP address of the server firewall rule. Must be IPv4 format.

properties.startIpAddress
  • string

The start IP address of the server firewall rule. Must be IPv4 format.

type
  • string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

FirewallRuleListResult

A list of firewall rules.

Name Type Description
value

The list of firewall rules in a server.