Subnet Interface

Implements

public interface Subnet
extends HasInnerModel<SubnetInner>, ChildResource<Network>

A client-side representation of a subnet of a virtual network.

Method Summary

Modifier and Type Method and Description
abstract String addressPrefix()

Gets the address space prefix, in CIDR notation, assigned to this subnet.

abstract List<String> addressPrefixes()

Gets address space prefixes, in CIDR notation, assigned to this subnet.

abstract NetworkSecurityGroup getNetworkSecurityGroup()
abstract RouteTable getRouteTable()
abstract String id()
abstract Set<String> listAvailablePrivateIPAddresses()

List available private IP addresses within this subnet.

abstract Collection<NicIpConfiguration> listNetworkInterfaceIPConfigurations()
abstract String natGatewayId()
abstract int networkInterfaceIPConfigurationCount()
abstract String networkSecurityGroupId()
abstract String routeTableId()
abstract Map<ServiceEndpointType,List<Region>> servicesWithAccess()

Method Details

addressPrefix

public abstract String addressPrefix()

Gets the address space prefix, in CIDR notation, assigned to this subnet.

Use Subnet#addressPrefixes if this subnet has multiple prefixes.

Returns:

the address space prefix, in CIDR notation, assigned to this subnet

addressPrefixes

public abstract List addressPrefixes()

Gets address space prefixes, in CIDR notation, assigned to this subnet.

Use Subnet#addressPrefix if this subnet is created/updated using that property.

Returns:

address space prefixes, in CIDR notation, assigned to this subnet

getNetworkSecurityGroup

public abstract NetworkSecurityGroup getNetworkSecurityGroup()

Returns:

the network security group associated with this subnet, if any

Note that this method will result in a call to Azure each time it is invoked.

getRouteTable

public abstract RouteTable getRouteTable()

Returns:

the route table associated with this subnet, if any

Note that this method will result in a call to Azure each time it is invoked.

id

public abstract String id()

Returns:

the ID of the subnet.

listAvailablePrivateIPAddresses

public abstract Set listAvailablePrivateIPAddresses()

List available private IP addresses within this subnet.

Starting IPs of the address prefixes are not returned, due to:
 1. They are usually reserved by platform(e.g. for gateway usage).
 2. For backward-compatibility.

Returns:

available private IP addresses within this network

listNetworkInterfaceIPConfigurations

public abstract Collection listNetworkInterfaceIPConfigurations()

Returns:

network interface IP configurations that are associated with this subnet

Note that this call may result in multiple calls to Azure to fetch all the referenced interfaces each time it is invoked.

natGatewayId

public abstract String natGatewayId()

Returns:

the resource ID of the NAT gateway associated with this subnet, if any

networkInterfaceIPConfigurationCount

public abstract int networkInterfaceIPConfigurationCount()

Returns:

number of network interface IP configurations associated with this subnet

networkSecurityGroupId

public abstract String networkSecurityGroupId()

Returns:

the resource ID of the network security group associated with this subnet, if any

routeTableId

public abstract String routeTableId()

Returns:

the resource ID of the route table associated with this subnet, if any

servicesWithAccess

public abstract Map> servicesWithAccess()

Returns:

the services that has access to the subnet.

Applies to