Virtual Network Rules - List By Server

Service:

SQL Database

API Version:

2021-11-01

Gets a list of virtual network rules in a server.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/virtualNetworkRules?api-version=2021-11-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	path	True	string	The name of the server.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	VirtualNetworkRuleListResult	Successfully retrieved the list of virtual network rules.
Other Status Codes		*** Error Responses: *** 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 ResourceNotFound - The requested resource was not found.

Examples

List virtual network rules

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/vnet-test-svr/virtualNetworkRules?api-version=2021-11-01

Java

import com.azure.core.util.Context;

/** Samples for VirtualNetworkRules ListByServer. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/VirtualNetworkRulesList.json
     */
    /**
     * Sample code: List virtual network rules.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listVirtualNetworkRules(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getVirtualNetworkRules().listByServer("Default", "vnet-test-svr",
            Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/vnet-test-svr/virtualNetworkRules/vnet-firewall-rule",
      "name": "vnet-firewall-rule",
      "type": "Microsoft.Sql/servers/virtualNetworkRules",
      "properties": {
        "ignoreMissingVnetServiceEndpoint": false,
        "state": "Ready",
        "virtualNetworkSubnetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/vnet-test-svr/virtualNetworkRules/vnet-firewall-rule",
      "name": "vnet-firewall-rule",
      "type": "Microsoft.Sql/servers/virtualNetworkRules",
      "properties": {
        "ignoreMissingVnetServiceEndpoint": false,
        "state": "Ready",
        "virtualNetworkSubnetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet"
      }
    }
  ]
}

Definitions

Name	Description
VirtualNetworkRule	A virtual network rule.
VirtualNetworkRuleListResult	A list of virtual network rules.
VirtualNetworkRuleState	Virtual Network Rule State

VirtualNetworkRule

A virtual network rule.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.ignoreMissingVnetServiceEndpoint	boolean	Create firewall rule before the virtual network has vnet service endpoint enabled.
properties.state	VirtualNetworkRuleState	Virtual Network Rule State
properties.virtualNetworkSubnetId	string	The ARM resource id of the virtual network subnet.
type	string	Resource type.

VirtualNetworkRuleListResult

A list of virtual network rules.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	VirtualNetworkRule[]	Array of results.

VirtualNetworkRuleState

Virtual Network Rule State

Name	Type	Description
Deleting	string
Failed	string
InProgress	string
Initializing	string
Ready	string
Unknown	string