SubnetsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:subnets> attribute.

Constructor

SubnetsOperations(*args, **kwargs)

Methods

begin_create_or_update

Creates or updates a subnet in the specified virtual network.

begin_delete

Deletes the specified subnet.

begin_prepare_network_policies

Prepares a subnet by applying network intent policies.

begin_unprepare_network_policies

Unprepares a subnet by removing network intent policies.

get

Gets the specified subnet by virtual network and resource group.

list

Gets all subnets in a virtual network.

begin_create_or_update

Creates or updates a subnet in the specified virtual network.

begin_create_or_update(resource_group_name: str, virtual_network_name: str, subnet_name: str, subnet_parameters: _models.Subnet, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Subnet]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

virtual_network_name
Required
str

The name of the virtual network. Required.

subnet_name
Required
str

The name of the subnet. Required.

subnet_parameters
Required
Subnet or <xref:JSON> or IO[bytes]

Parameters supplied to the create or update subnet operation. Is one of the following types: Subnet, JSON, IO[bytes] Required.

Returns

Type Description

An instance of LROPoller that returns Subnet. The Subnet is compatible with MutableMapping

Exceptions

Type Description

begin_delete

Deletes the specified subnet.

begin_delete(resource_group_name: str, virtual_network_name: str, subnet_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

virtual_network_name
Required
str

The name of the virtual network. Required.

subnet_name
Required
str

The name of the subnet. Required.

Returns

Type Description

An instance of LROPoller that returns None

Exceptions

Type Description

begin_prepare_network_policies

Prepares a subnet by applying network intent policies.

begin_prepare_network_policies(resource_group_name: str, virtual_network_name: str, subnet_name: str, prepare_network_policies_request_parameters: _models.PrepareNetworkPoliciesRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

virtual_network_name
Required
str

The name of the virtual network. Required.

subnet_name
Required
str

The name of the subnet. Required.

prepare_network_policies_request_parameters
Required

Parameters supplied to prepare subnet by applying network intent policies. Is one of the following types: PrepareNetworkPoliciesRequest, JSON, IO[bytes] Required.

Returns

Type Description

An instance of LROPoller that returns None

Exceptions

Type Description

begin_unprepare_network_policies

Unprepares a subnet by removing network intent policies.

begin_unprepare_network_policies(resource_group_name: str, virtual_network_name: str, subnet_name: str, unprepare_network_policies_request_parameters: _models.UnprepareNetworkPoliciesRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

virtual_network_name
Required
str

The name of the virtual network. Required.

subnet_name
Required
str

The name of the subnet. Required.

unprepare_network_policies_request_parameters
Required

Parameters supplied to unprepare subnet to remove network intent policies. Is one of the following types: UnprepareNetworkPoliciesRequest, JSON, IO[bytes] Required.

Returns

Type Description

An instance of LROPoller that returns None

Exceptions

Type Description

get

Gets the specified subnet by virtual network and resource group.

get(resource_group_name: str, virtual_network_name: str, subnet_name: str, *, expand: str | None = None, **kwargs: Any) -> Subnet

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

virtual_network_name
Required
str

The name of the virtual network. Required.

subnet_name
Required
str

The name of the subnet. Required.

Keyword-Only Parameters

Name Description
expand
str

Expands referenced resources. Default value is None.

Default value: None

Returns

Type Description

Subnet. The Subnet is compatible with MutableMapping

Exceptions

Type Description

list

Gets all subnets in a virtual network.

list(resource_group_name: str, virtual_network_name: str, **kwargs: Any) -> ItemPaged[Subnet]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

virtual_network_name
Required
str

The name of the virtual network. Required.

Returns

Type Description

An iterator like instance of Subnet

Exceptions

Type Description