New-AzSqlServerFirewallRule
Creates a firewall rule for a SQL Database server.
Syntax
UserSpecifiedRuleSet
New-AzSqlServerFirewallRule
[-ServerName] <String>
[-ResourceGroupName] <String>
-FirewallRuleName <String>
-StartIpAddress <String>
-EndIpAddress <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
AzureIpRuleSet
New-AzSqlServerFirewallRule
[-ServerName] <String>
[-ResourceGroupName] <String>
[-AllowAllAzureIPs]
[-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.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
AzureIpRuleSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: False Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EndIpAddress
Specifies the end value of the IP address range for this rule.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UserSpecifiedRuleSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-FirewallRuleName
Specifies the name of the new firewall rule.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: Name
Parameter sets
UserSpecifiedRuleSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
Specifies the name of a resource group to which the server is assigned.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ServerName
Specifies the name of a server.
Specify the server name, not the fully qualified DNS name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 1 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-StartIpAddress
Specifies the start value of the IP address range for the firewall rule.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UserSpecifiedRuleSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: False Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
