Set Network Configuration
[This topic contains preliminary content for the current release of Windows Azure.]
The Set Network Configuration operation asynchronously configures the virtual network.
Request
The Set Network Configuration request is specified as follows. Replace <subscription-id> with your subscription ID.
| Method | Request URI | HTTP Version |
|---|---|---|
|
PUT |
|
HTTP/1.1 |
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. Currently this header should be set to 2012-03-01. |
|
Content-Type |
Required. Set to text/plain. |
Request Body
The request body of the Set Network Configuration operation is a Netcfg.xml file. For more information on the contents of a netcfg.cfg file, see Windows Azure Virtual Network NETCFG Schema.
Sample Request
The following code sample represents a sample network configuration request body.
<?xml version="1.0" encoding="utf-8"?>
<NetworkConfiguration xmlns="http://schemas.microsoft.com/ServiceHosting/2011/07/NetworkConfiguration" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
<VirtualNetworkConfiguration>
<Dns>
<DnsServers>
<DnsServer name="dns-server-name" IPAddress="IPV4-address-of-the-server"/>
...
</DnsServers>
</Dns>
<LocalNetworkSites>
<LocalNetworkSite name="local-site-name">
<AddressSpace>
<AddressPrefix>CIDR-identifier</AddressPrefix>
...
</AddressSpace>
<VPNGatewayAddress>IPV4-address-of-the-vpn-gateway</VPNGatewayAddress>
</LocalNetworkSite>
</LocalNetworkSites>
<VirtualNetworkSites>
<VirtualNetworkSite name="virtual-network-name" AffinityGroup="affinity-group-name">
<Label>label-for-the-site</Label>
<AddressSpace>
<AddressPrefix>CIDR-identifier</AddressPrefix>
...
</AddressSpace>
<Subnets>
<Subnet name="subnet-name">
<AddressPrefix>CIDR-identifier</AddressPrefix>
</Subnet>
...
</Subnets>
<DnsServersRef>
<DnsServerRef name="primary-DNS-name" />
...
</DnsServersRef>
<Gateway profile="Small">
<VPNClientAddressPool>
<AddressPrefix>CIDR-identifier</AddressPrefix>
...
</VPNClientAddressPool>
<ConnectionsToLocalNetwork>
<LocalNetworkSiteRef name="local-site-name">
<Connection type="connection-type"/>
</LocalNetworkSiteRef>
</ConnectionsToLocalNetwork>
</Gateway>
</VirtualNetworkSite>
...
</VirtualNetworkSites>
</VirtualNetworkConfiguration>
</NetworkConfiguration>
VirtualNetworkConfiguration
Contains 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 |
|---|---|
|
Optional. Contains a collection of on premise DNS servers used to resolve the names of instances deployed in Windows Azure. If you do not specify a DNS server, Windows Azure defaults to using the internal Windows Azure DNS service. |
|
|
Optional. Specifies a collection of parameters that are used to configure local network sites in cross-premises network configurations. You can specify a total of five local network sites by default. You can change the local network site limit to a value other than five by contacting Azure support. These settings are only required if you are configuring a cross-premises network configuration. |
|
|
Optional. the collection parameters that describe the virtual networks. Each virtual network is referred to as a site. You can define up to five Virtual Network sites per subscription, by default. You can change the limit of Virtual Network sites to a value other than five for a specific subscription by contacting Windows Azure support. To specify virtual network sites, you must have an affinity group to associate with the virtual network sites. The affinity group must be created prior to uploading this configuration file. For more information creating affinity groups, see Create Affinity Group. |
Dns
| Element name | Description |
|---|---|
|
Optional. Contains the collection of DNS servers. By default, you can specify up to nine DNS servers in this section. You can change the DNS server limit to a value other than nine by contacting Azure support. When you specify a DNS server here, it must be part of an external site, not a part of a Windows Azure Virtual Network. DNS server names must be uniquely identifiable within the subscription. |
DnsServers
| Element name | Description |
|---|---|
|
Optional. Contains the name and IPv4 address of the DNS server. |
DnsServer
| Attribute name | Description |
|---|---|
|
name |
Required. Specifies the name of the DNS server. DNS server names must be uniquely identifiable within the subscription. |
|
address |
Required. Specifies the IPv4 address of the DNS server. This can either be the IP address of your own DNS server, or the IP address of a public DNS server. |
LocalNetworkSites
| Element name | Description |
|---|---|
|
Optional. Specifies the parameters that are used to configure a local network site. |
LocalNetworkSite
| Attribute name | Description |
|---|---|
|
name |
Required. Specifies the identifier for the local network. Each local network site is referred to by a name. The name must be uniquely identifiable within the subscription. The name must not contain any spaces and cannot begin with a number. |
| Element name | Description |
|---|---|
|
Required. Contains a collection of Classless Inter-Domain Routing (CIDR) identifiers that specify the address space that you will use for your local network site. It is recommended that you specify only one public IPv4 address space per local network site. Address space identifiers must conform to the following parameters:
Addresses can be either public or private. |
|
|
VPNGatewayAddress |
Required. Specifies the IPv4 Address of the VPN Gateway. You can specify only one IP address per local network site. To establish the VPN tunnel, you must configure a VPN gateway appliance on your local premises (either software or hardware) that supports the IKE v1 protocol and can be reached by a public IP address. You can specify only one public IPv4 address per local network site. |
AddressSpace
| Element name | Description |
|---|---|
|
AddressPrefix |
Required. Specifies a CIDR identifier that identifies the address space. This setting requires a VPN gateway device that supports the IKE v1 protocol and that can be reached by a public IP address. Only IPv4 addresses are permitted. The IP address ranges must not overlap with the IP address ranges of any other local network sites or virtual network sites. The smallest supported subnet is /29. Example: 198.51.100.0/22 |
VirtualNetworkSites
| Element name | Description |
|---|---|
|
Required. Contains parameters that describe a virtual network site. Each virtual network site must have a unique name and must be associated with an affinity group that has been previously created. |
VirtualNetworkSite
| Attribute name | Description |
|---|---|
|
name |
Required. Specifies a name for the virtual network. The name must be unique within the subscription. |
|
AffinityGroup |
Required. The name of the affinity group that you want this virtual network site to be associated with. The affinity group must already exist in order to refer to it in this section. |
| Element name | Description |
|---|---|
|
Label |
Required. Specifies a friendly identifier for the virtual network. There are no guarantees for uniqueness. Labels can be a maximum of 100 characters in length and can contain special characters. |
|
Required. Specifies the address space for the virtual network. This is a private IP address space that conforms to RFC 1918. Addresses that you specify must not overlap with those specified for other virtual network sites or local network sites. |
|
|
Optional. Contains the specification for the subnets that you want to create within the address space of your virtual network sites. |
|
|
Optional. Contains the specification of DNS servers that are used for name resolution in this virtual network. You must reference the DNS servers that you already declared in the Dns element. |
|
|
Required for cross-premises connections only. Contains gateway references to the local network sites that the virtual network can connect to. If you don’t require cross-premises connectivity, this section is optional. |
Subnets
| Element name | Description |
|---|---|
|
Required. Contains the parameters for a specific subnet. You can specify multiple subnets for the virtual network. The IP addresses of the subnets you specify must be fully contained within the IP address range for the virtual network it resides in. To configure a subnet for cross-premises connectivity, specify a subnet with the name GatewaySubnet. |
Subnet
| Attribute name | Description | ||
|---|---|---|---|
|
name |
Optional. Specifies the name of the subnet. Subnet names must be unique with the virtual network.
|
| Element name | Description |
|---|---|
|
Required. Specifies the address space of the subnet. |
DnsServersRef
| Element name | Description |
|---|---|
|
Required. Specifies a DNS server to use for name resolution. If you do not set any DNS server references, Windows Azure DNS service is set as the default for the virtual. If you do not specify any DNS servers, name resolution will not work across a VPN link. You can specify up to nine DNS servers. |
DnsServerRef
| Attribute name | Description |
|---|---|
|
name |
Required. The name of the DNS server to use for name resolution on the virtual network. |
Gateway
| Attribute name | Description |
|---|---|
|
profile |
Required. Specifies the gateway connection size. The only supported value is Small. |
|
The list of local networks that the virtual network can connect to. |
| Element name | Description |
|---|---|
|
The VPNClientAddressPool reserves a pool of IP addresses for VPN clients. This object is used for point-to-site connectivity. |
|
|
Required for cross-premises connections only. Contains the list of local networks that the virtual network can connect to. Currently you can only specify one site. Any site that you reference in this section must be defined in the network configuration and must fall within the total address space |
VPNClientAddressPool
| Element name | Description |
|---|---|
|
AddressPrefix |
The CIDR identifier that identifies an address in the pool. |
ConnectionsToLocalNetwork
| Element name | Description |
|---|---|
|
Required. Specifies the name of the local network. Any site that you reference must be defined in the LocalNetworkSite element of this request. |
LocalNetworkSiteRef
| Attribute name | Description |
|---|---|
|
name |
Required. Specifies the name of the local network. |
| 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. |
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). For information about status codes, see Service Management Status and Error Codes.
Response Headers
The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.
| Response Header | Description |
|---|---|
|
x-ms-request-id |
A value that uniquely identifies a request made against the Management service. For an asynchronous operation, you can call get operation status with the value of the header to determine whether the operation is complete, has failed, or is still in progress. See Tracking Asynchronous Service Management Requests for more information. |
Response Body
None.
Authorization
Only the account owner may call this operation.
Remarks
Note