Get Firewall Rule (classic)

 

Updated: October 5, 2016

THIS TOPIC APPLIES TO: noSQL Server yesAzure SQL DatabaseyesAzure SQL Data Warehouse noParallel Data Warehouse

Gets details for an Azure SQL Database Server firewall rule.

This command uses the classic deployment model. You should use the newer Resource Manager based REST API commands located here. For more information, see Azure Resource Manager vs. classic deployment: Understand deployment models and the state of your resources.

The Get Firewall Rule request must be specified as follows:

  • Replace {subscriptionId} with your subscription ID.

  • Replace {serverName} with the name of the server containing the firewall rule.

  • Replace {ruleName} with the name of the firewall rule to query.

MethodRequest URIHTTP Version
GEThttps://management.core.windows.net:8443/{subscriptionId}/services/sqlservers/servers/{serverName}/firewallrules/{ruleName}HTTP/1.1

In SQL Database, login data required to authenticate a connection and server-level firewall rules are temporarily cached in each database. This cache is periodically refreshed. To force a refresh of the authentication cache and make sure that a database has the latest version of the logins table, execute DBCC FLUSHAUTHCACHE (Transact-SQL).

URI Parameters

None.

Request Headers

The following table describes the required and optional request headers:

Request HeaderDescription
x-ms-versionRequired. Specifies the version of the operation to use for this request. This header should be set to 2012-03-01.

Request Body

None.

The response includes an HTTP status code, a set of response headers, and a response body.

Status Code

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response HeaderDescription
x-ms-request-idA value that uniquely identifies a request made against the database management service. This request id is used for request tracking. If a failure occurs that requires the user to contact Microsoft Support, the request id should be provided to Microsoft to assist in tracking and resolving the failure for the request.

Response Body

The following is an example response body:

<ServiceResource xmlns="http://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">  
  <Name>AllowAll</Name>  
  <Type>Microsoft.SqlAzure.FirewallRule</Type>  
  <State>Normal</State>  
  <SelfLink>https://management.core.windows.net/2eae7c21-ffd1-49e4-ac22-39095e0b9f02/services/sqlservers/servers/bpr0d6li5t/firewallrules/Rule2</SelfLink>  
  <ParentLink>https://management.core.windows.net/2eae7c21-ffd1-49e4-ac22-39095e0b9f02/services/sqlservers/servers/bpr0d6li5t</ParentLink>  
  <StartIPAddress>0.0.0.0</StartIPAddress>  
  <EndIPAddress>255.255.255.255</EndIPAddress>  
</ServiceResource>  

The following table describes the elements of the response body:

Element NameDescription
NameThe name of the firewall rule.
TypeThe type of the returned object; Microsoft.SqlAzure.FirewallRule
StateThe state of the firewall rule.
SelfLinkThe URI identifier for this resource.
ParentLinkThe URI identifier for the parent of this resource (the server).
StartIPAddressThe lowest IP address in the range of the server-level firewall setting. IP addresses equal to or greater than this can attempt to connect to the server.
EndIPAddressThe highest IP address in the range of the server-level firewall setting. IP addresses equal to or less than this can attempt to connect to the server.

Common REST API Error Codes
Azure SQL Database
Azure SQL Database Firewall
Azure SQL Database Security Guidelines and Limitations
Operations for Azure SQL Databases
Azure SQL Database Cmdlets
Get-AzureSqlDatabaseServerFirewallRule

Show: