List Virtual Network Sites

  • Article

 

The List Virtual network sites operation retrieves the virtual networks configured for the subscription.

Request

The List Virtual network sites request is specified as follows. Replace <subscription-id> with the subscription ID.

Method

Request URI

GET

https://management.core.windows.net/<subscription-id>/services/networking/virtualnetwork

URI Parameters

None.

Request Headers

The following table describes the request headers.

Request Header

Description

x-ms-version

Required. Specifies the version of the operation to use for this request. The value for this header should be set to 2012-03-01 or higher.

Request Body

None.

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Status Code

A successful operation returns status code 200 (OK).

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers.

Response Header

Description

x-ms-request-id

A value that uniquely identifies a request made against the management service.

Response Body

The format of the response body is as follows:

<VirtualNetworkSites xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.microsoft.com/windowsazure">
  <VirtualNetworkSite>
    <Name>name-of-virtual-network-site</Name>
    <Label>label-of-virtual-network-site</Label>
    <Id>identifier-of-virtual-network-site</Id>
    <AffinityGroup>name-of-affinity-group</AffinityGroup>
    <Location>location-of-virtual-network-site</Location>
    <State>state-of-virtual-network-site</State>
    <AddressSpace>
      <AddressPrefixes>
        <AddressPrefix>CIDR-identifier</AddressPrefix>
      </AddressPrefixes>
    </AddressSpace>
    <Subnets>
      <Subnet>
        <Name>subnet-name</Name>
        <AddressPrefix>CIDR-identifier</AddressPrefix>
        <NetworkSecurityGroup>network-security-group</NetworkSecurityGroup>
      </Subnet>
    </Subnets>
    <DnsServers>
      <DnsServer>
        <Name>primary-DNS-name</Name>
        <Address>IPV4-address-of-the-DNS-server</Address>
      </DnsServer>
    <Gateway>
      <Profile>gateway-profile-size</Profile>
      <Sites>
        <LocalNetworkSite>
          <Name>local-site-name</Name>
          <AddressSpace>
            <AddressPrefixes>
              <AddressPrefix>CIDR-identifier</AddressPrefix>
            </AddressPrefixes>
          </AddressSpace>
          <VpnGatewayAddress>IPV4-address-of-the-vpn-gateway</VpnGatewayAddress>
          <Connections>
            <Connection>
              <Type>connection-type</Type>
            </Connection>
          </Connections>
        </LocalNetworkSite>
      </Sites>
      <VPNClientAddressPool>
        <AddressPrefixes>
          <AddressPrefix>CIDR-identifier</AddressPrefix>
        </AddressPrefixes>
      </VPNClientAddressPool>
    </Gateway>    
  </VirtualNetworkSite>
</VirtualNetworkSites>

The following tables describe the elements of the response body…

VirtualNetworkSite

Specifies the collections of parameters used to configure a virtual network space that is dedicated to your subscription without overlapping with other networks.

Element name

Description

Name

Specifies the name of the virtual network site.

Label

Specifies the friendly identifier of the site.

Id

Specifies a unique string identifier that represents the virtual network site.

AffinityGroup

Specifies the affinity group with which the virtual network site is associated, if any. If the virtual network site is associated with an affinity group, the Location element is not returned.

Location

Specifies the geo-location of the virtual network site in Azure, if the virtual network site is not associated with an affinity group. If a location element is specified, the AffinityGroup element is not returned.

State

Specifies the current status of the virtual network.

Possible values are:

  • Created

  • Creating

  • Updating

  • Deleting

  • Unavailable

AddressSpace

Specifies the list of network address spaces for a virtual network site. This represents the overall network space contained within the virtual network site.

Subnets

Specifies the list of network subnets for a virtual network site. All network subnets must be contained within the overall virtual network address spaces.

DnsServers

Specifies the list of on DNS Servers associated with the virtual network site.

Gateway

Specifies the gateway that contains a list of Local Network Sites which enables the Virtual network site to communicate with a customer’s on premise networks.

AddressSpace

Specifies the list of network address spaces for a virtual network site.

Element name

Description

AddressPrefixes

Specifies a list of address prefixes.

AddressPrefixes

Specifies a list of address prefixes.

Element name

Description

AddressPrefix

Specifies an address space, in CIDR format, in the virtual network.

Subnets

Specifies the list of network subnets for a virtual network site.

Element name

Description

Subnet

Specifies a network subnet for a virtual network site.

Subnet

Specifies a network subnet for a virtual network site.

Element name

Description

Name

Specifies the name for the subnet.

AddressPrefix

Specifies an address space, in CIDR format, that defines the subnet.

NetworkSecurityGroup

Optional. Represents the name of the Network Security Group that will be associated with the Virtual Machine. Network Security Group must exist in the context of subscription and be created in same region to which the virtual machine will be deployed.

The NetworkSecurityGroup element is only available using version 2014-10-01 or higher.

DnsServers

Specifies the list of on DNS Servers associated with the virtual network site.

Element name

Description

DnsServer

Specifies a DNS Server that is associated with the virtual network site.

DnsServer

Specifies a DNS Server that is associated with the virtual network site.

Element name

Description

Name

Specifies the name of the DNS server.

Address

Specifies the IPV4 address of the DNS server.

Gateway

Specifies the gateway that contains a list of Local Network Sites which enables the Virtual network site to communicate with a customer’s on premise networks.

Element name

Description

Profile

Specifies the gateway connection size.

Sites

Specifies the list of local network sites that the virtual network can connect to.

VPNClientAddressPool

Specifies the VPNClientAddressPool reserves a pool of IP addresses for VPN clients. This object is used for point-to-site connectivity.

Sites

Specifies the list of local network sites that the virtual network can connect to.

Element name

Description

LocalNetworkSite

Specifies the list of parameters defining the local network site.

VPNClientAddressPool

Specifies the VPNClientAddressPool reserves a pool of IP addresses for VPN clients. This object is used for point-to-site connectivity.

AddressPrefix

Specifies the CIDR identifier that identifies an address in the pool.

LocalNetworkSite

Specifies the list of parameters defining the local network site.

Element name

Description

Name

Specifies the name of the local network site.

AddressSpace

Specifies the address space of the local network site.

VpnGatewayAddress

Specifies the IPV4 address of the local network site.

Connections

Specifies the connections of the local network site.

AddressSpace

Specifies the address space of the local network site.

Element name

Description

AddressPrefixes

The name of the local network site.

Connections

Specifies connections of the local network site.

Element name

Description

Connection

Specifies the type of connection of the local network site. The value of this element can be either IPsec or Dedicated. The default value is IPsec.