Subnets interface

Package:

@azure/arm-network

Interface representing a Subnets.

Methods

beginCreateOrUpdate(string, string, string, Subnet, SubnetsCreateOrUpdateOptionalParams)	Creates or updates a subnet in the specified virtual network.
beginCreateOrUpdateAndWait(string, string, string, Subnet, SubnetsCreateOrUpdateOptionalParams)	Creates or updates a subnet in the specified virtual network.
beginDelete(string, string, string, SubnetsDeleteOptionalParams)	Deletes the specified subnet.
beginDeleteAndWait(string, string, string, SubnetsDeleteOptionalParams)	Deletes the specified subnet.
beginPrepareNetworkPolicies(string, string, string, PrepareNetworkPoliciesRequest, SubnetsPrepareNetworkPoliciesOptionalParams)	Prepares a subnet by applying network intent policies.
beginPrepareNetworkPoliciesAndWait(string, string, string, PrepareNetworkPoliciesRequest, SubnetsPrepareNetworkPoliciesOptionalParams)	Prepares a subnet by applying network intent policies.
beginUnprepareNetworkPolicies(string, string, string, UnprepareNetworkPoliciesRequest, SubnetsUnprepareNetworkPoliciesOptionalParams)	Unprepares a subnet by removing network intent policies.
beginUnprepareNetworkPoliciesAndWait(string, string, string, UnprepareNetworkPoliciesRequest, SubnetsUnprepareNetworkPoliciesOptionalParams)	Unprepares a subnet by removing network intent policies.
get(string, string, string, SubnetsGetOptionalParams)	Gets the specified subnet by virtual network and resource group.
list(string, string, SubnetsListOptionalParams)	Gets all subnets in a virtual network.

Method Details

beginCreateOrUpdate(string, string, string, Subnet, SubnetsCreateOrUpdateOptionalParams)

Creates or updates a subnet in the specified virtual network.

function beginCreateOrUpdate(resourceGroupName: string, virtualNetworkName: string, subnetName: string, subnetParameters: Subnet, options?: SubnetsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Subnet>, Subnet>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

subnetName

string

The name of the subnet.

subnetParameters

Subnet

Parameters supplied to the create or update subnet operation.

options

SubnetsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<Subnet>, Subnet>>

beginCreateOrUpdateAndWait(string, string, string, Subnet, SubnetsCreateOrUpdateOptionalParams)

Creates or updates a subnet in the specified virtual network.

function beginCreateOrUpdateAndWait(resourceGroupName: string, virtualNetworkName: string, subnetName: string, subnetParameters: Subnet, options?: SubnetsCreateOrUpdateOptionalParams): Promise<Subnet>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

subnetName

string

The name of the subnet.

subnetParameters

Subnet

Parameters supplied to the create or update subnet operation.

options

SubnetsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Subnet>

beginDelete(string, string, string, SubnetsDeleteOptionalParams)

Deletes the specified subnet.

function beginDelete(resourceGroupName: string, virtualNetworkName: string, subnetName: string, options?: SubnetsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

subnetName

string

The name of the subnet.

options

SubnetsDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, SubnetsDeleteOptionalParams)

Deletes the specified subnet.

function beginDeleteAndWait(resourceGroupName: string, virtualNetworkName: string, subnetName: string, options?: SubnetsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

subnetName

string

The name of the subnet.

options

SubnetsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginPrepareNetworkPolicies(string, string, string, PrepareNetworkPoliciesRequest, SubnetsPrepareNetworkPoliciesOptionalParams)

Prepares a subnet by applying network intent policies.

function beginPrepareNetworkPolicies(resourceGroupName: string, virtualNetworkName: string, subnetName: string, prepareNetworkPoliciesRequestParameters: PrepareNetworkPoliciesRequest, options?: SubnetsPrepareNetworkPoliciesOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

subnetName

string

The name of the subnet.

prepareNetworkPoliciesRequestParameters

PrepareNetworkPoliciesRequest

Parameters supplied to prepare subnet by applying network intent policies.

options

SubnetsPrepareNetworkPoliciesOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginPrepareNetworkPoliciesAndWait(string, string, string, PrepareNetworkPoliciesRequest, SubnetsPrepareNetworkPoliciesOptionalParams)

Prepares a subnet by applying network intent policies.

function beginPrepareNetworkPoliciesAndWait(resourceGroupName: string, virtualNetworkName: string, subnetName: string, prepareNetworkPoliciesRequestParameters: PrepareNetworkPoliciesRequest, options?: SubnetsPrepareNetworkPoliciesOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

subnetName

string

The name of the subnet.

prepareNetworkPoliciesRequestParameters

PrepareNetworkPoliciesRequest

Parameters supplied to prepare subnet by applying network intent policies.

options

SubnetsPrepareNetworkPoliciesOptionalParams

The options parameters.

Returns

Promise<void>

beginUnprepareNetworkPolicies(string, string, string, UnprepareNetworkPoliciesRequest, SubnetsUnprepareNetworkPoliciesOptionalParams)

Unprepares a subnet by removing network intent policies.

function beginUnprepareNetworkPolicies(resourceGroupName: string, virtualNetworkName: string, subnetName: string, unprepareNetworkPoliciesRequestParameters: UnprepareNetworkPoliciesRequest, options?: SubnetsUnprepareNetworkPoliciesOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

subnetName

string

The name of the subnet.

unprepareNetworkPoliciesRequestParameters

UnprepareNetworkPoliciesRequest

Parameters supplied to unprepare subnet to remove network intent policies.

options

SubnetsUnprepareNetworkPoliciesOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginUnprepareNetworkPoliciesAndWait(string, string, string, UnprepareNetworkPoliciesRequest, SubnetsUnprepareNetworkPoliciesOptionalParams)

Unprepares a subnet by removing network intent policies.

function beginUnprepareNetworkPoliciesAndWait(resourceGroupName: string, virtualNetworkName: string, subnetName: string, unprepareNetworkPoliciesRequestParameters: UnprepareNetworkPoliciesRequest, options?: SubnetsUnprepareNetworkPoliciesOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

subnetName

string

The name of the subnet.

unprepareNetworkPoliciesRequestParameters

UnprepareNetworkPoliciesRequest

Parameters supplied to unprepare subnet to remove network intent policies.

options

SubnetsUnprepareNetworkPoliciesOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, SubnetsGetOptionalParams)

Gets the specified subnet by virtual network and resource group.

function get(resourceGroupName: string, virtualNetworkName: string, subnetName: string, options?: SubnetsGetOptionalParams): Promise<Subnet>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

subnetName

string

The name of the subnet.

options

SubnetsGetOptionalParams

The options parameters.

Returns

Promise<Subnet>

list(string, string, SubnetsListOptionalParams)

Gets all subnets in a virtual network.

function list(resourceGroupName: string, virtualNetworkName: string, options?: SubnetsListOptionalParams): PagedAsyncIterableIterator<Subnet, Subnet[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

options

SubnetsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Subnet, Subnet[], PageSettings>