New-AzSqlServerFirewallRule

  • Reference
Module:
Az.Sql

Creates a firewall rule for a SQL Database server.

Syntax

New-AzSqlServerFirewallRule
   -FirewallRuleName <String>
   -StartIpAddress <String>
   -EndIpAddress <String>
   [-ServerName] <String>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzSqlServerFirewallRule
   [-AllowAllAzureIPs]
   [-ServerName] <String>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzSqlServerFirewallRule cmdlet creates a firewall rule for the specified Azure SQL Database server.

Examples

Example 1: Create a firewall rule

New-AzSqlServerFirewallRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -FirewallRuleName "Rule01" -StartIpAddress "192.168.0.198" -EndIpAddress "192.168.0.199"

ResourceGroupName : ResourceGroup01
ServerName        : Server01
StartIpAddress    : 192.168.0.198
EndIpAddress      : 192.168.0.199
FirewallRuleName  : Rule01

This command creates a firewall rule named Rule01 on the server named Server01. The rule includes the specified start and end IP addresses.

Example 2: Create a firewall rule that allows all Azure IP addresses to access the server

New-AzSqlServerFirewallRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -AllowAllAzureIPs

This command creates a firewall rule on the server named Server01 that belongs to the resource group named ResourceGroup01. Since the AllowAllAzureIPs parameter is used, the firewall rule allows all Azure IP addresses to access the server.

Parameters

-AllowAllAzureIPs

Indicates that this firewall rule allows all Azure IP addresses to access the server. You cannot use this parameter if you intend to use the FirewallRuleName, StartIpAddress, and EndIpAddress parameters. If you want to allow Azure IPs to access the server, this parameter should be used in a separate cmdlet call that does not use the FirewallRuleName, StartIpAddress, and EndIpAddress parameters.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EndIpAddress

Specifies the end value of the IP address range for this rule.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-FirewallRuleName

Specifies the name of the new firewall rule.

Type:String
Aliases:Name
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of a resource group to which the server is assigned.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ServerName

Specifies the name of a server. Specify the server name, not the fully qualified DNS name.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-StartIpAddress

Specifies the start value of the IP address range for the firewall rule.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Outputs

AzureSqlServerFirewallRuleModel