Share via

Subnet Class

  • Reference

Subnet in a virtual network resource.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
azure.mgmt.network.models._models_py3.SubResource
Subnet

Constructor

Subnet(*, id: str | None = None, name: str | None = None, type: str | None = None, address_prefix: str | None = None, address_prefixes: List[str] | None = None, network_security_group: _models.NetworkSecurityGroup | None = None, route_table: _models.RouteTable | None = None, nat_gateway: _models.SubResource | None = None, service_endpoints: List[_models.ServiceEndpointPropertiesFormat] | None = None, service_endpoint_policies: List[_models.ServiceEndpointPolicy] | None = None, ip_allocations: List[_models.SubResource] | None = None, delegations: List[_models.Delegation] | None = None, private_endpoint_network_policies: str | _models.VirtualNetworkPrivateEndpointNetworkPolicies = 'Disabled', private_link_service_network_policies: str | _models.VirtualNetworkPrivateLinkServiceNetworkPolicies = 'Enabled', application_gateway_ip_configurations: List[_models.ApplicationGatewayIPConfiguration] | None = None, sharing_scope: str | _models.SharingScope | None = None, default_outbound_access: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
id
str

Resource ID.
name
str

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

Resource type.
address_prefix
str

The address prefix for the subnet.
address_prefixes
list[str]

List of address prefixes for the subnet.
network_security_group
NetworkSecurityGroup

The reference to the NetworkSecurityGroup resource.
route_table
RouteTable

The reference to the RouteTable resource.
nat_gateway
SubResource

Nat gateway associated with this subnet.
service_endpoints
list[ServiceEndpointPropertiesFormat]

An array of service endpoints.
service_endpoint_policies
list[ServiceEndpointPolicy]

An array of service endpoint policies.
ip_allocations
list[SubResource]

Array of IpAllocation which reference this subnet.
delegations
list[Delegation]

An array of references to the delegations on the subnet.
private_endpoint_network_policies
str or VirtualNetworkPrivateEndpointNetworkPolicies

Enable or Disable apply network policies on private end point in the subnet. Known values are: "Enabled", "Disabled", "NetworkSecurityGroupEnabled", and "RouteTableEnabled".

Default value: Disabled
private_link_service_network_policies
str or VirtualNetworkPrivateLinkServiceNetworkPolicies

Enable or Disable apply network policies on private link service in the subnet. Known values are: "Enabled" and "Disabled".

Default value: Enabled
application_gateway_ip_configurations
list[ApplicationGatewayIPConfiguration]

Application gateway IP configurations of virtual network resource.
sharing_scope
str or 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. Known values are: "Tenant" and "DelegatedServices".
default_outbound_access
bool

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.

Variables

Name Description
id
str

Resource ID.
name
str

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

A unique read-only string that changes whenever the resource is updated.
type
str

Resource type.
address_prefix
str

The address prefix for the subnet.
address_prefixes
list[str]

List of address prefixes for the subnet.
network_security_group
NetworkSecurityGroup

The reference to the NetworkSecurityGroup resource.
route_table
RouteTable

The reference to the RouteTable resource.
nat_gateway
SubResource

Nat gateway associated with this subnet.
service_endpoints
list[ServiceEndpointPropertiesFormat]

An array of service endpoints.
service_endpoint_policies
list[ServiceEndpointPolicy]

An array of service endpoint policies.
private_endpoints
list[PrivateEndpoint]

An array of references to private endpoints.
ip_configurations
list[IPConfiguration]

An array of references to the network interface IP configurations using subnet.
ip_configuration_profiles
list[IPConfigurationProfile]

Array of IP configuration profiles which reference this subnet.
ip_allocations
list[SubResource]

Array of IpAllocation which reference this subnet.
resource_navigation_links
list[ResourceNavigationLink]

An array of references to the external resources using subnet.
service_association_links
list[ServiceAssociationLink]

An array of references to services injecting into this subnet.
delegations
list[Delegation]

An array of references to the delegations on the subnet.
purpose
str

A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties.
provisioning_state
str or ProvisioningState

The provisioning state of the subnet resource. Known values are: "Succeeded", "Updating", "Deleting", and "Failed".
private_endpoint_network_policies
str or VirtualNetworkPrivateEndpointNetworkPolicies

Enable or Disable apply network policies on private end point in the subnet. Known values are: "Enabled", "Disabled", "NetworkSecurityGroupEnabled", and "RouteTableEnabled".
private_link_service_network_policies
str or VirtualNetworkPrivateLinkServiceNetworkPolicies

Enable or Disable apply network policies on private link service in the subnet. Known values are: "Enabled" and "Disabled".
application_gateway_ip_configurations
list[ApplicationGatewayIPConfiguration]

Application gateway IP configurations of virtual network resource.
sharing_scope
str or 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. Known values are: "Tenant" and "DelegatedServices".
default_outbound_access
bool

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.