3.1.5.18.2 subnets

The subnets resource is used to create virtual subnets IDs (VSIDs) under a tenant's virtual network routing domain ID (RDID). The user can specify the addressPrefix to use for the subnets, the accessControlLists to protect the subnets, the routeTable to be applied to the subnet, and optionally the service insertion to use within the subnet.

It is invoked through the following URI.

https://<url>/networking/v1/virtualNetworks/{parentResourceId}/subnets/{resourceId}

url: The address or name of the REST server of the Network Controller.

parentResourceId: the identifier for the specific ancestor resource within the resource type. See section 2.2.3.3 for more details.

resourceId: the identifier for the specific descendant resource within the resource type. See section 2.2.3.4 for more details.

Note  The server MAY support additional versions, v1 or later, in the URI.

The following HTTP methods can be performed on this resource.

HTTP method

Section

Description

PUT

3.1.5.18.1.1

Create a new subnets resource or update an existing subnets resource.

GET

3.1.5.18.1.2

Get one subnets resource.

GET ALL

3.1.5.18.1.3

List all subnets resources for a parent virtual network resource.

DELETE

3.1.5.18.1.4

Delete a subnets resource.

The following property elements are valid.

Element name

Type

Description

etag

Read-only

Specified in Common JSON Elements, section 2.2.2.

provisioningState

Read-only

Specified in Common JSON Elements, section 2.2.2.

addressPrefix

Required

Indicates the address prefix that defines the subnet.  The prefix MUST be either IPv4 or IPv6.  This value MUST NOT overlap with other subnets in the virtual network and MUST fall in the addressPrefix defined in the virtual network.

accessControlList

Optional

Indicates a reference to an accessControlLists resource that defines the ACLs in and out of the subnet.

dualStackSubnet

Optional

Indicates a reference to another virtual network subnet part of the same virtual network resources. The two subnets that reference each other MUST be of different address family: one IPV4, the other IPV6. The relationship MUST be at most one to one.

The relationship enables a network interface to support dual stack, meaning both an IPv4 and an IPv6 at the same time.

This property is supported with URI version v3 or later.

serviceInsertion

Optional

Indicates a reference to a serviceInsertions resource that defines the service insertion to be applied to the subnet.

routeTable

Optional

Indicates a reference to a routeTable resource that defines the tenant routes to be applied to the subnet.

ipConfigurations

Read-only

Indicates an array of references of networkInterfaces resources that are connected to the subnet.

VirtualSubnetId

Read-only

String representation of the unique virtual subnet identified allocated by the network controller for this subnet.

This property is supported with URI version v2 or later.

UnbilledEgressBytes

Optional

Number of unbilled bytes sent by virtual machines with network interfaces with IP configurations from this virtual subnet. Unbilled bytes are bytes sent to address ranges that are part of the UnbilledAddressRanges property of the parent virtual network.

This property is supported with URI version v2 or later.

BilledEgressBytes

Optional

Number of billed bytes sent by virtual machines with network interfaces with IP configurations from this virtual subnet. Billed bytes are bytes sent to address ranges that are not part of the UnbilledAddressRanges property of the parent virtual network.

This property is supported with URI version v2 or later.

encryptionEnabled

Optional

Boolean. TRUE indicates encryption is enabled. FALSE by default encryption is disabled.

If this property is set to TRUE, then the parent virtual network resource MUST have the encryptionCredential property set to a valid credential of type X509 certificate.

This property is supported with URI version v2 or later.