Outbound Firewall Rules - List By Server

Service:

SQL Database

API Version:

2021-11-01

Gets all outbound firewall rules on a server.

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

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	OutboundFirewallRuleListResult	Successfully retrieved outbound firewall rules.
Other Status Codes		*** Error Responses: *** 404 ResourceNotFound - The requested resource was not found. 409 OutboundFirewallRuleOngoingOperation - The outbound firewall rule '{0}' for server '{1}' is currently busy with another operation: '{2}' 409 OutboundFirewallRuleLimitReached - Limit of {1} Outbound Firewall Rules for Server {0} has been reached

Examples

Gets list of outbound firewall rules on a server.

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/outboundFirewallRules?api-version=2021-11-01

Java

/**
 * Samples for OutboundFirewallRules ListByServer.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/OutboundFirewallRuleList.json
     */
    /**
     * Sample code: Gets list of outbound firewall rules on a server.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getsListOfOutboundFirewallRulesOnAServer(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getOutboundFirewallRules().listByServer("sqlcrudtest-7398",
            "sqlcrudtest-4645", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/outboundFirewallRules/server.datbase.windows.net",
      "name": "server.database.windows.net",
      "type": "Microsoft.Sql/servers/outboundFirewallRules",
      "properties": {
        "provisioningState": "Ready"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/outboundFirewallRules/storage.blob.windows.net",
      "name": "storage.blob.windows.net",
      "type": "Microsoft.Sql/servers/outboundFirewallRules",
      "properties": {
        "provisioningState": "Creating"
      }
    }
  ]
}

Definitions

Name	Description
OutboundFirewallRule	An Azure SQL DB Server Outbound Firewall Rule.
OutboundFirewallRuleListResult	A list of outbound rules.

OutboundFirewallRule

An Azure SQL DB Server Outbound Firewall Rule.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.provisioningState	string	The state of the outbound rule.
type	string	Resource type.

OutboundFirewallRuleListResult

A list of outbound rules.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	OutboundFirewallRule[]	Array of results.