Share via

az sql server outbound-firewall-rule

Manage a server's outbound firewall rules.

Commands

Name Description Type Status
az sql server outbound-firewall-rule create

Create a new outbound firewall rule.

 Core GA
az sql server outbound-firewall-rule delete

Delete the outbound firewall rule.

 Core GA
az sql server outbound-firewall-rule list

List a server's outbound firewall rules.

 Core GA
az sql server outbound-firewall-rule show

Show the details for an outbound firewall rule.

 Core GA

az sql server outbound-firewall-rule create

Edit

Create a new outbound firewall rule.

az sql server outbound-firewall-rule create --outbound-rule-fqdn
                                            --resource-group
                                            --server

Examples

Create a new outbound firewall rule

az sql server outbound-firewall-rule create -g mygroup -s myserver -n allowedFQDN

Create a new outbound firewall rule

az sql server outbound-firewall-rule create -g mygroup -s myserver --outbound-rule-fqdn allowedFQDN

Required Parameters

--outbound-rule-fqdn -n

The allowed FQDN for the outbound firewall rule.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--server -s

Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az sql server outbound-firewall-rule delete

Edit

Delete the outbound firewall rule.

az sql server outbound-firewall-rule delete --outbound-rule-fqdn
                                            [--ids]
                                            [--resource-group]
                                            [--server]
                                            [--subscription]

Examples

Delete the outbound firewall rule

az sql server outbound-firewall-rule delete -g mygroup -s myserver -n myrule

Delete the outbound firewall rule

az sql server outbound-firewall-rule delete -g mygroup -s myserver --outbound-rule-fqdn allowedFQDN

Required Parameters

--outbound-rule-fqdn -n

The allowed FQDN for the outbound firewall rule.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--server -s

Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az sql server outbound-firewall-rule list

Edit

List a server's outbound firewall rules.

az sql server outbound-firewall-rule list [--ids]
                                          [--resource-group]
                                          [--server]
                                          [--subscription]

Examples

List a server's outbound firewall rules

az sql server outbound-firewall-rule list -g mygroup -s myserver

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--server -s

Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az sql server outbound-firewall-rule show

Edit

Show the details for an outbound firewall rule.

az sql server outbound-firewall-rule show --outbound-rule-fqdn
                                          [--ids]
                                          [--resource-group]
                                          [--server]
                                          [--subscription]

Examples

Show the outbound firewall rule

az sql server outbound-firewall-rule show -g mygroup -s myserver -n myrule

Show the outbound firewall rule

az sql server outbound-firewall-rule show -g mygroup -s myserver --outbound-rule-fqdn allowedFQDN

Required Parameters

--outbound-rule-fqdn -n

The allowed FQDN for the outbound firewall rule.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--server -s

Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False