az sql server vnet-rule

Manage a server's virtual network rules.

Commands

Name	Description	Type	Status
az sql server vnet-rule create	Create a virtual network rule to allows access to an Azure SQL Server.	Core	GA
az sql server vnet-rule delete	Deletes the virtual network rule with the given name.	Core	GA
az sql server vnet-rule list	Gets a list of virtual network rules in a server.	Core	GA
az sql server vnet-rule show	Gets a virtual network rule.	Core	GA
az sql server vnet-rule update	Update a virtual network rule.	Core	GA

az sql server vnet-rule create

Edit

Create a virtual network rule to allows access to an Azure SQL Server.

az sql server vnet-rule create --name
                               --resource-group
                               --server
                               --subnet
                               [--ignore-missing-endpoint {false, true}]
                               [--vnet-name]

Examples

Create a vnet rule by providing the subnet id.

az sql server vnet-rule create --server MyAzureSqlServer --name MyVNetRule \
  -g MyResourceGroup --subnet /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Network/virtualNetworks/{VNETName}/subnets/{SubnetName}

Create a vnet rule by providing the vnet and subnet name. The subnet id is created by taking the resource group name and subscription id of the SQL server.

az sql server vnet-rule create --server MyAzureSqlServer --name MyVNetRule \
    -g MyResourceGroup --subnet subnetName --vnet-name vnetName

Required Parameters

--name -n

The name of the virtual network 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>.

--subnet

Name or ID of the subnet that allows access to an Azure Sql Server. If subnet name is provided, --vnet-name must be provided.

Optional Parameters

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

--ignore-missing-endpoint -i

Create firewall rule before the virtual network has vnet service endpoint enabled.

Property	Value
Default value:	False
Accepted values:	false, true

--vnet-name

The virtual network 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 vnet-rule delete

Edit

Deletes the virtual network rule with the given name.

az sql server vnet-rule delete --name
                               [--ids]
                               [--resource-group]
                               [--server]
                               [--subscription]

Required Parameters

--name -n

The name of the virtual network 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 vnet-rule list

Edit

Gets a list of virtual network rules in a server.

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

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 vnet-rule show

Edit

Gets a virtual network rule.

az sql server vnet-rule show --name
                             [--ids]
                             [--resource-group]
                             [--server]
                             [--subscription]

Required Parameters

--name -n

The name of the virtual network 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 vnet-rule update

Edit

Update a virtual network rule.

az sql server vnet-rule update --name
                               --subnet
                               [--ids]
                               [--ignore-missing-endpoint {false, true}]
                               [--resource-group]
                               [--server]
                               [--subscription]

Required Parameters

--name -n

The name of the virtual network rule.

--subnet

Name or ID of the subnet that allows access to an Azure Sql Server. If subnet name is provided, --vnet-name must be provided.

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

--ignore-missing-endpoint -i

Create firewall rule before the virtual network has vnet service endpoint enabled.

Property	Value
Default value:	False
Accepted values:	false, true

--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