Subnet interface

Package:

@azure/arm-network

Subnet in a virtual network resource.

Extends

SubResource

Properties

addressPrefix	The address prefix for the subnet.
addressPrefixes	List of address prefixes for the subnet.
applicationGatewayIPConfigurations	Application gateway IP configurations of virtual network resource.
defaultOutboundAccess	Set this property to false to disable default outbound connectivity for all VMs in the subnet. This property can only be set at the time of subnet creation and cannot be updated for an existing subnet.
delegations	An array of references to the delegations on the subnet.
etag	A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.
ipAllocations	Array of IpAllocation which reference this subnet.
ipConfigurationProfiles	Array of IP configuration profiles which reference this subnet. NOTE: This property will not be serialized. It can only be populated by the server.
ipConfigurations	An array of references to the network interface IP configurations using subnet. NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.
natGateway	Nat gateway associated with this subnet.
networkSecurityGroup	The reference to the NetworkSecurityGroup resource.
privateEndpointNetworkPolicies	Enable or Disable apply network policies on private end point in the subnet.
privateEndpoints	An array of references to private endpoints. NOTE: This property will not be serialized. It can only be populated by the server.
privateLinkServiceNetworkPolicies	Enable or Disable apply network policies on private link service in the subnet.
provisioningState	The provisioning state of the subnet resource. NOTE: This property will not be serialized. It can only be populated by the server.
purpose	A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. NOTE: This property will not be serialized. It can only be populated by the server.
resourceNavigationLinks	An array of references to the external resources using subnet. NOTE: This property will not be serialized. It can only be populated by the server.
routeTable	The reference to the RouteTable resource.
serviceAssociationLinks	An array of references to services injecting into this subnet. NOTE: This property will not be serialized. It can only be populated by the server.
serviceEndpointPolicies	An array of service endpoint policies.
serviceEndpoints	An array of service endpoints.
sharingScope	Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty.
type	Resource type.

Inherited Properties

id	Resource ID.

Property Details

addressPrefix

The address prefix for the subnet.

addressPrefix?: string

Property Value

string

addressPrefixes

List of address prefixes for the subnet.

addressPrefixes?: string[]

Property Value

string[]

applicationGatewayIPConfigurations

Application gateway IP configurations of virtual network resource.

applicationGatewayIPConfigurations?: ApplicationGatewayIPConfiguration[]

Property Value

ApplicationGatewayIPConfiguration[]

defaultOutboundAccess

Set this property to false to disable default outbound connectivity for all VMs in the subnet. This property can only be set at the time of subnet creation and cannot be updated for an existing subnet.

defaultOutboundAccess?: boolean

Property Value

boolean

delegations

An array of references to the delegations on the subnet.

delegations?: Delegation[]

Property Value

Delegation[]

etag

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

ipAllocations

Array of IpAllocation which reference this subnet.

ipAllocations?: SubResource[]

Property Value

SubResource[]

ipConfigurationProfiles

Array of IP configuration profiles which reference this subnet. NOTE: This property will not be serialized. It can only be populated by the server.

ipConfigurationProfiles?: IPConfigurationProfile[]

Property Value

IPConfigurationProfile[]

ipConfigurations

An array of references to the network interface IP configurations using subnet. NOTE: This property will not be serialized. It can only be populated by the server.

ipConfigurations?: IPConfiguration[]

Property Value

IPConfiguration[]

name

The name of the resource that is unique within a resource group. This name can be used to access the resource.

name?: string

Property Value

string

natGateway

Nat gateway associated with this subnet.

natGateway?: SubResource

Property Value

SubResource

networkSecurityGroup

The reference to the NetworkSecurityGroup resource.

networkSecurityGroup?: NetworkSecurityGroup

Property Value

NetworkSecurityGroup

privateEndpointNetworkPolicies

Enable or Disable apply network policies on private end point in the subnet.

privateEndpointNetworkPolicies?: string

Property Value

string

privateEndpoints

An array of references to private endpoints. NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpoints?: PrivateEndpoint[]

Property Value

PrivateEndpoint[]

privateLinkServiceNetworkPolicies

Enable or Disable apply network policies on private link service in the subnet.

privateLinkServiceNetworkPolicies?: string

Property Value

string

provisioningState

The provisioning state of the subnet resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

purpose

A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. NOTE: This property will not be serialized. It can only be populated by the server.

purpose?: string

Property Value

string

resourceNavigationLinks

An array of references to the external resources using subnet. NOTE: This property will not be serialized. It can only be populated by the server.

resourceNavigationLinks?: ResourceNavigationLink[]

Property Value

ResourceNavigationLink[]

routeTable

The reference to the RouteTable resource.

routeTable?: RouteTable

Property Value

RouteTable

serviceAssociationLinks

An array of references to services injecting into this subnet. NOTE: This property will not be serialized. It can only be populated by the server.

serviceAssociationLinks?: ServiceAssociationLink[]

Property Value

ServiceAssociationLink[]

serviceEndpointPolicies

An array of service endpoint policies.

serviceEndpointPolicies?: ServiceEndpointPolicy[]

Property Value

ServiceEndpointPolicy[]

serviceEndpoints

An array of service endpoints.

serviceEndpoints?: ServiceEndpointPropertiesFormat[]

Property Value

ServiceEndpointPropertiesFormat[]

sharingScope

Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty.

sharingScope?: string

Property Value

string

type

Resource type.

type?: string

Property Value

string

Inherited Property Details

id

Resource ID.

id?: string

Property Value

string

Inherited From SubResource.id