VirtualNetworks interface

Package:

@azure/arm-hybridcontainerservice

Interface representing a VirtualNetworks.

Methods

beginCreateOrUpdate(string, string, VirtualNetwork, VirtualNetworksCreateOrUpdateOptionalParams)	Creates or updates the virtual network resource
beginCreateOrUpdateAndWait(string, string, VirtualNetwork, VirtualNetworksCreateOrUpdateOptionalParams)	Creates or updates the virtual network resource
beginDelete(string, string, VirtualNetworksDeleteOptionalParams)	Deletes the specified virtual network resource
beginDeleteAndWait(string, string, VirtualNetworksDeleteOptionalParams)	Deletes the specified virtual network resource
beginUpdate(string, string, VirtualNetworksPatch, VirtualNetworksUpdateOptionalParams)	Patches the virtual network resource
beginUpdateAndWait(string, string, VirtualNetworksPatch, VirtualNetworksUpdateOptionalParams)	Patches the virtual network resource
listByResourceGroup(string, VirtualNetworksListByResourceGroupOptionalParams)	Lists the virtual networks in the specified resource group
listBySubscription(VirtualNetworksListBySubscriptionOptionalParams)	Lists the virtual networks in the specified subscription
retrieve(string, string, VirtualNetworksRetrieveOptionalParams)	Gets the specified virtual network resource

Method Details

beginCreateOrUpdate(string, string, VirtualNetwork, VirtualNetworksCreateOrUpdateOptionalParams)

Creates or updates the virtual network resource

function beginCreateOrUpdate(resourceGroupName: string, virtualNetworkName: string, virtualNetworks: VirtualNetwork, options?: VirtualNetworksCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetwork>, VirtualNetwork>>

Parameters

resourceGroupName

string

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

virtualNetworkName

string

Parameter for the name of the virtual network

virtualNetworks

VirtualNetwork

Virtual Network resource definition

options

VirtualNetworksCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetwork>, VirtualNetwork>>

beginCreateOrUpdateAndWait(string, string, VirtualNetwork, VirtualNetworksCreateOrUpdateOptionalParams)

Creates or updates the virtual network resource

function beginCreateOrUpdateAndWait(resourceGroupName: string, virtualNetworkName: string, virtualNetworks: VirtualNetwork, options?: VirtualNetworksCreateOrUpdateOptionalParams): Promise<VirtualNetwork>

Parameters

resourceGroupName

string

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

virtualNetworkName

string

Parameter for the name of the virtual network

virtualNetworks

VirtualNetwork

Virtual Network resource definition

options

VirtualNetworksCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<VirtualNetwork>

beginDelete(string, string, VirtualNetworksDeleteOptionalParams)

Deletes the specified virtual network resource

function beginDelete(resourceGroupName: string, virtualNetworkName: string, options?: VirtualNetworksDeleteOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworksDeleteHeaders>, VirtualNetworksDeleteHeaders>>

Parameters

resourceGroupName

string

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

virtualNetworkName

string

Parameter for the name of the virtual network

options

VirtualNetworksDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworksDeleteHeaders>, VirtualNetworksDeleteHeaders>>

beginDeleteAndWait(string, string, VirtualNetworksDeleteOptionalParams)

Deletes the specified virtual network resource

function beginDeleteAndWait(resourceGroupName: string, virtualNetworkName: string, options?: VirtualNetworksDeleteOptionalParams): Promise<VirtualNetworksDeleteHeaders>

Parameters

resourceGroupName

string

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

virtualNetworkName

string

Parameter for the name of the virtual network

options

VirtualNetworksDeleteOptionalParams

The options parameters.

Returns

Promise<VirtualNetworksDeleteHeaders>

beginUpdate(string, string, VirtualNetworksPatch, VirtualNetworksUpdateOptionalParams)

Patches the virtual network resource

function beginUpdate(resourceGroupName: string, virtualNetworkName: string, virtualNetworks: VirtualNetworksPatch, options?: VirtualNetworksUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetwork>, VirtualNetwork>>

Parameters

resourceGroupName

string

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

virtualNetworkName

string

Parameter for the name of the virtual network

virtualNetworks

VirtualNetworksPatch

Virtual Network resource patch definition

options

VirtualNetworksUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetwork>, VirtualNetwork>>

beginUpdateAndWait(string, string, VirtualNetworksPatch, VirtualNetworksUpdateOptionalParams)

Patches the virtual network resource

function beginUpdateAndWait(resourceGroupName: string, virtualNetworkName: string, virtualNetworks: VirtualNetworksPatch, options?: VirtualNetworksUpdateOptionalParams): Promise<VirtualNetwork>

Parameters

resourceGroupName

string

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

virtualNetworkName

string

Parameter for the name of the virtual network

virtualNetworks

VirtualNetworksPatch

Virtual Network resource patch definition

options

VirtualNetworksUpdateOptionalParams

The options parameters.

Returns

Promise<VirtualNetwork>

listByResourceGroup(string, VirtualNetworksListByResourceGroupOptionalParams)

Lists the virtual networks in the specified resource group

function listByResourceGroup(resourceGroupName: string, options?: VirtualNetworksListByResourceGroupOptionalParams): PagedAsyncIterableIterator<VirtualNetwork, VirtualNetwork[], PageSettings>

Parameters

resourceGroupName

string

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

options

VirtualNetworksListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualNetwork, VirtualNetwork[], PageSettings>

listBySubscription(VirtualNetworksListBySubscriptionOptionalParams)

Lists the virtual networks in the specified subscription

function listBySubscription(options?: VirtualNetworksListBySubscriptionOptionalParams): PagedAsyncIterableIterator<VirtualNetwork, VirtualNetwork[], PageSettings>

Parameters

options

VirtualNetworksListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualNetwork, VirtualNetwork[], PageSettings>

retrieve(string, string, VirtualNetworksRetrieveOptionalParams)

Gets the specified virtual network resource

function retrieve(resourceGroupName: string, virtualNetworkName: string, options?: VirtualNetworksRetrieveOptionalParams): Promise<VirtualNetwork>

Parameters

resourceGroupName

string

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

virtualNetworkName

string

Parameter for the name of the virtual network

options

VirtualNetworksRetrieveOptionalParams

The options parameters.

Returns

Promise<VirtualNetwork>