Virtual Network Rules - Get

Gets a virtual network rule.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}?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.

virtualNetworkRuleName
path True

string

The name of the virtual network rule.

api-version
query True

string

The API version to use for the request.

Responses

Name Type Description
200 OK

VirtualNetworkRule

Successfully retrieved a specified virtual network rule.

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

Gets a virtual network rule

Sample request

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

Sample response

{
  "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.

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.

VirtualNetworkRuleState

Virtual Network Rule State

Name Type Description
Deleting

string

Failed

string

InProgress

string

Initializing

string

Ready

string

Unknown

string