Skip to content

Latest commit

 

History

History
95 lines (67 loc) · 4.69 KB

sp-set-database-firewall-rule-azure-sql-database.md

File metadata and controls

95 lines (67 loc) · 4.69 KB
title titleSuffix description author ms.author ms.reviewer ms.date ms.service ms.topic f1_keywords helpviewer_keywords dev_langs monikerRange
sp_set_database_firewall_rule
Azure SQL Database
sp_set_database_firewall_rule creates or updates the database-level firewall rules for your Azure SQL database.
VanMSFT
vanto
randolphwest
04/08/2024
azure-sql-database
reference
sp_set_database_firewall_rule
sp_set_database_firewall_rule_TSQL
sys.sp_set_database_firewall_rule
sys.sp_set_database_firewall_rule_TSQL
sp_set_database_firewall_rule
firewall_rules, setting database rules
TSQL
= azuresqldb-current

sp_set_database_firewall_rule (Azure SQL Database)

[!INCLUDE Azure SQL Database]

Creates or updates the database-level firewall rules for your [!INCLUDE ssazure-sqldb]. Database firewall rules can be configured for the master database, and for user databases on [!INCLUDE ssSDS]. Database firewall rules can be useful when using contained database users. For more information, see Make your database portable by using contained databases.

Syntax

sp_set_database_firewall_rule
    [ @name = ] N'name'
    , [ @start_ip_address = ] 'start_ip_address'
    , [ @end_ip_address = ] 'end_ip_address'
[ ; ]

Arguments

[ @name = ] N'name'

The name used to describe and distinguish the database-level firewall setting. @name is nvarchar(128) with no default.

[ @start_ip_address = ] 'start_ip_address'

The lowest IP address in the range of the database-level firewall setting. IP addresses equal to or greater than this value can attempt to connect to the [!INCLUDE ssSDS] instance. The lowest possible IP address is 0.0.0.0. @start_ip_address is varchar(50) with no default.

[ @end_ip_address = ] 'end_ip_address'

The highest IP address in the range of the database-level firewall setting. IP addresses equal to or less than this value can attempt to connect to the [!INCLUDE ssSDS] instance. The highest possible IP address is 255.255.255.255. @end_ip_address is varchar(50) with no default.

The following table demonstrates the supported arguments and options in [!INCLUDE ssSDS].

Note

Azure connection attempts are allowed when both this field and the @start_ip_address field equals 0.0.0.0.

Remarks

The names of database-level firewall settings for a database must be unique. If the name of the database-level firewall setting provided for the stored procedure already exists in the database-level firewall settings table, the starting and ending IP addresses are updated. Otherwise, a new database-level firewall setting is created.

When you add a database-level firewall setting where the beginning and ending IP addresses are equal to 0.0.0.0, you enable access to your database in the [!INCLUDE ssSDS] server from any Azure resource. Provide a value to the @name parameter that helps you remember what the firewall setting is for.

Permissions

Requires CONTROL permission on the database.

Examples

The following code creates a database-level firewall setting called Allow Azure that enables access to your database from Azure.

EXECUTE sp_set_database_firewall_rule N'Allow Azure', '0.0.0.0', '0.0.0.0';

The following code creates a database-level firewall setting called Example DB Setting 1 for only the IP address 0.0.0.4. Then, the sp_set_database firewall_rule stored procedure is called again to update the end IP address to 0.0.0.6, in that firewall setting. This example creates a range that allows IP addresses 0.0.0.4, 0.0.0.5, and 0.0.0.6 to access the database.

  • Create database-level firewall setting for only IP 0.0.0.4:

    EXECUTE sp_set_database_firewall_rule N'Example DB Setting 1', '0.0.0.4', '0.0.0.4';

  • Update database-level firewall setting to create a range of allowed IP addresses:

    EXECUTE sp_set_database_firewall_rule N'Example DB Setting 1', '0.0.0.4', '0.0.0.6';

Related content