Virtual Network Links - List

Lists the virtual network links to the specified Private DNS zone.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks?api-version=2018-09-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks?$top={$top}&api-version=2018-09-01

URI Parameters

Name In Required Type Description
privateZoneName
path True

string

The name of the Private DNS zone (without a terminating dot).

resourceGroupName
path True

string

The name of the resource group.

subscriptionId
path True

string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

Client Api Version.

$top
query

integer

int32

The maximum number of virtual network links to return. If not specified, returns up to 100 virtual network links.

Responses

Name Type Description
200 OK

VirtualNetworkLinkListResult

Success.

Other Status Codes

CloudError

Default response. It will be deserialized as per the Error definition.

Examples

Sample Request

GET https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/virtualNetworkLinks?api-version=2018-09-01

Sample Response

{
  "nextLink": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/virtualNetworkLinks?api-version=2018-09-01&$skipToken=skipToken",
  "value": [
    {
      "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/virtualNetworkLinks/virtualNetworkLink1",
      "name": "virtualNetworkLink1",
      "type": "Microsoft.Network/privateDnsZones/virtualNetworkLinks",
      "location": "global",
      "etag": "00000000-0000-0000-0000-000000000000",
      "properties": {
        "virtualNetwork": {
          "id": "/subscriptions/virtualNetworkSubscriptionId/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/virtualNetworkName"
        },
        "registrationEnabled": false,
        "virtualNetworkLinkState": "Completed",
        "provisioningState": "Succeeded"
      },
      "tags": {
        "key1": "value1"
      }
    },
    {
      "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/virtualNetworkLinks/virtualNetworkLink2",
      "name": "virtualNetworkLink2",
      "type": "Microsoft.Network/privateDnsZones/virtualNetworkLinks",
      "location": "global",
      "etag": "00000000-0000-0000-0000-000000000000",
      "properties": {
        "virtualNetwork": {
          "id": "/subscriptions/virtualNetworkSubscriptionId/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/virtualNetworkName"
        },
        "registrationEnabled": true,
        "virtualNetworkLinkState": "InProgress",
        "provisioningState": "Succeeded"
      }
    }
  ]
}

Definitions

Name Description
CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

ProvisioningState

The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.

SubResource

Reference to another subresource.

VirtualNetworkLink

Describes a link to virtual network for a Private DNS zone.

VirtualNetworkLinkListResult

The response to a list virtual network link to Private DNS zone operation.

VirtualNetworkLinkState

The status of the virtual network link to the Private DNS zone. Possible values are 'InProgress' and 'Done'. This is a read-only property and any attempt to set this value will be ignored.

CloudError

An error response from the service.

Name Type Description
error

CloudErrorBody

Cloud error body.

CloudErrorBody

An error response from the service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

CloudErrorBody[]

A list of additional details about the error.

message

string

A message describing the error, intended to be suitable for display in a user interface.

target

string

The target of the particular error. For example, the name of the property in error.

ProvisioningState

The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.

Name Type Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

SubResource

Reference to another subresource.

Name Type Description
id

string

Resource ID.

Describes a link to virtual network for a Private DNS zone.

Name Type Description
etag

string

The ETag of the virtual network link.

id

string

Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'.

location

string

The Azure Region where the resource lives

name

string

The name of the resource

properties.provisioningState

ProvisioningState

The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.

properties.registrationEnabled

boolean

Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled?

properties.virtualNetwork

SubResource

The reference of the virtual network.

properties.virtualNetworkLinkState

VirtualNetworkLinkState

The status of the virtual network link to the Private DNS zone. Possible values are 'InProgress' and 'Done'. This is a read-only property and any attempt to set this value will be ignored.

tags

object

Resource tags.

type

string

The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.

VirtualNetworkLinkListResult

The response to a list virtual network link to Private DNS zone operation.

Name Type Description
nextLink

string

The continuation token for the next page of results.

value

VirtualNetworkLink[]

Information about the virtual network links to the Private DNS zones.

VirtualNetworkLinkState

The status of the virtual network link to the Private DNS zone. Possible values are 'InProgress' and 'Done'. This is a read-only property and any attempt to set this value will be ignored.

Name Type Description
Completed

string

InProgress

string