Virtual Networks - Create Or Update

Service:

Dev Test Labs

API Version:

2018-09-15

Create or replace an existing virtual network. This operation can take a while to complete.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks/{name}?api-version=2018-09-15

URI Parameters

Name	In	Required	Type	Description
labName	path	True	string	The name of the lab.
name	path	True	string	The name of the VirtualNetwork
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
location	string	The location of the resource.
properties.allowedSubnets	Subnet[]	The allowed subnets of the virtual network.
properties.description	string	The description of the virtual network.
properties.externalProviderResourceId	string	The Microsoft.Network resource identifier of the virtual network.
properties.subnetOverrides	SubnetOverride[]	The subnet overrides of the virtual network.
tags	object	The tags of the resource.

Responses

Name	Type	Description
200 OK	VirtualNetwork	Resource 'VirtualNetwork' update operation succeeded
201 Created	VirtualNetwork	Resource 'VirtualNetwork' create operation succeeded Headers Location: string Retry-After: integer
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

VirtualNetworks_CreateOrUpdate

Sample request

HTTP

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks/{virtualNetworkName}?api-version=2018-09-15

{
  "properties": {
    "allowedSubnets": [
      {
        "allowPublicIp": "Allow",
        "labSubnetName": "{virtualNetworkName}Subnet",
        "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{virtualNetworkName}Subnet"
      }
    ]
  },
  "location": "{location}",
  "tags": {
    "tagName1": "tagValue1"
  }
}

Sample response

Status code:

200

{
  "name": "{virtualNetworkName}",
  "type": "Microsoft.DevTestLab/labs/virtualNetworks",
  "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualnetworks/{virtualNetworkName}",
  "properties": {
    "createdDate": "2018-10-01T13:01:44.6005134-07:00",
    "provisioningState": "Creating",
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "tags": {
    "tagName1": "tagValue1"
  }
}

Status code:

201

{
  "name": "{virtualNetworkName}",
  "type": "Microsoft.DevTestLab/labs/virtualNetworks",
  "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualnetworks/{virtualNetworkName}",
  "properties": {
    "createdDate": "2018-10-01T13:01:44.6005134-07:00",
    "provisioningState": "Creating",
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "tags": {
    "tagName1": "tagValue1"
  }
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExternalSubnet	Subnet information as returned by the Microsoft.Network API.
Port	Properties of a network port.
Subnet	Subnet information.
SubnetOverride	Property overrides on a subnet of a virtual network.
SubnetSharedPublicIpAddressConfiguration	Configuration for public IP address sharing.
TransportProtocol	The transport protocol for the endpoint.
UsagePermissionType	The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)).
VirtualNetwork	A virtual network.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ExternalSubnet

Object

Subnet information as returned by the Microsoft.Network API.

Name	Type	Description
id	string	Gets or sets the identifier.
name	string	Gets or sets the name.

Port

Object

Properties of a network port.

Name	Type	Description
backendPort	integer (int32)	Backend port of the target virtual machine.
transportProtocol	TransportProtocol	Protocol type of the port.

Subnet

Object

Subnet information.

Name	Type	Description
allowPublicIp	UsagePermissionType	The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)).
labSubnetName	string	The name of the subnet as seen in the lab.
resourceId	string	The resource ID of the subnet.

SubnetOverride

Object

Property overrides on a subnet of a virtual network.

Name	Type	Description
labSubnetName	string	The name given to the subnet within the lab.
resourceId	string	The resource ID of the subnet.
sharedPublicIpAddressConfiguration	SubnetSharedPublicIpAddressConfiguration	Properties that virtual machines on this subnet will share.
useInVmCreationPermission	UsagePermissionType	Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny).
usePublicIpAddressPermission	UsagePermissionType	Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny).
virtualNetworkPoolName	string	The virtual network pool associated with this subnet.

SubnetSharedPublicIpAddressConfiguration

Object

Configuration for public IP address sharing.

Name	Type	Description
allowedPorts	Port[]	Backend ports that virtual machines on this subnet are allowed to expose

TransportProtocol

Enumeration

The transport protocol for the endpoint.

Value	Description
Tcp
Udp

UsagePermissionType

Enumeration

The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)).

Value	Description
Default
Deny
Allow

VirtualNetwork

Object

A virtual network.

Name	Type	Description
id	string	The identifier of the resource.
location	string	The location of the resource.
name	string	The name of the resource.
properties.allowedSubnets	Subnet[]	The allowed subnets of the virtual network.
properties.createdDate	string (date-time)	The creation date of the virtual network.
properties.description	string	The description of the virtual network.
properties.externalProviderResourceId	string	The Microsoft.Network resource identifier of the virtual network.
properties.externalSubnets	ExternalSubnet[]	The external subnet properties.
properties.provisioningState	string	The provisioning status of the resource.
properties.subnetOverrides	SubnetOverride[]	The subnet overrides of the virtual network.
properties.uniqueIdentifier	string	The unique immutable identifier of a resource (Guid).
tags	object	The tags of the resource.
type	string	The type of the resource.