SubnetPropertiesFormat interface

Package:

@azure/arm-network

Properties of the subnet.

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.
delegations	An array of references to the delegations on the subnet.
ipAllocations	Array of IpAllocation which reference this subnet.
ipamPoolPrefixAllocations	A list of IPAM Pools for allocating IP address prefixes.
ipConfigurationProfiles	Array of IP configuration profiles which reference this subnet.
ipConfigurations	An array of references to the network interface IP configurations using subnet.
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.
privateLinkServiceNetworkPolicies	Enable or Disable apply network policies on private link service in the subnet.
provisioningState	The provisioning state of the subnet resource.
purpose	A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties.
resourceNavigationLinks	An array of references to the external resources using subnet.
routeTable	The reference to the RouteTable resource.
serviceAssociationLinks	An array of references to services injecting into this subnet.
serviceEndpointPolicies	An array of service endpoint policies.
serviceEndpoints	An array of service endpoints.
serviceGateway	Reference to an existing service gateway.
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.

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.

defaultOutboundAccess?: boolean

Property Value

boolean

delegations

An array of references to the delegations on the subnet.

delegations?: Delegation[]

Property Value

Delegation[]

ipAllocations

Array of IpAllocation which reference this subnet.

ipAllocations?: SubResource[]

Property Value

SubResource[]

ipamPoolPrefixAllocations

A list of IPAM Pools for allocating IP address prefixes.

ipamPoolPrefixAllocations?: IpamPoolPrefixAllocation[]

Property Value

IpamPoolPrefixAllocation[]

ipConfigurationProfiles

Array of IP configuration profiles which reference this subnet.

ipConfigurationProfiles?: IPConfigurationProfile[]

Property Value

IPConfigurationProfile[]

ipConfigurations

An array of references to the network interface IP configurations using subnet.

ipConfigurations?: IPConfiguration[]

Property Value

IPConfiguration[]

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.

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.

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.

purpose?: string

Property Value

string

resourceNavigationLinks

An array of references to the external resources using subnet.

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.

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[]

serviceGateway

Reference to an existing service gateway.

serviceGateway?: SubResource

Property Value

SubResource

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