HubVirtualNetworkConnections interface

Package:

@azure/arm-network

Interface representing a HubVirtualNetworkConnections.

Methods

beginCreateOrUpdate(string, string, string, HubVirtualNetworkConnection, HubVirtualNetworkConnectionsCreateOrUpdateOptionalParams)	Creates a hub virtual network connection if it doesn't exist else updates the existing one.
beginCreateOrUpdateAndWait(string, string, string, HubVirtualNetworkConnection, HubVirtualNetworkConnectionsCreateOrUpdateOptionalParams)	Creates a hub virtual network connection if it doesn't exist else updates the existing one.
beginDelete(string, string, string, HubVirtualNetworkConnectionsDeleteOptionalParams)	Deletes a HubVirtualNetworkConnection.
beginDeleteAndWait(string, string, string, HubVirtualNetworkConnectionsDeleteOptionalParams)	Deletes a HubVirtualNetworkConnection.
get(string, string, string, HubVirtualNetworkConnectionsGetOptionalParams)	Retrieves the details of a HubVirtualNetworkConnection.
list(string, string, HubVirtualNetworkConnectionsListOptionalParams)	Retrieves the details of all HubVirtualNetworkConnections.

Method Details

beginCreateOrUpdate(string, string, string, HubVirtualNetworkConnection, HubVirtualNetworkConnectionsCreateOrUpdateOptionalParams)

Creates a hub virtual network connection if it doesn't exist else updates the existing one.

function beginCreateOrUpdate(resourceGroupName: string, virtualHubName: string, connectionName: string, hubVirtualNetworkConnectionParameters: HubVirtualNetworkConnection, options?: HubVirtualNetworkConnectionsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<HubVirtualNetworkConnection>, HubVirtualNetworkConnection>>

Parameters

resourceGroupName

string

The resource group name of the HubVirtualNetworkConnection.

virtualHubName

string

The name of the VirtualHub.

connectionName

string

The name of the HubVirtualNetworkConnection.

hubVirtualNetworkConnectionParameters

HubVirtualNetworkConnection

Parameters supplied to create or update a hub virtual network connection.

options

HubVirtualNetworkConnectionsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, HubVirtualNetworkConnection, HubVirtualNetworkConnectionsCreateOrUpdateOptionalParams)

Creates a hub virtual network connection if it doesn't exist else updates the existing one.

function beginCreateOrUpdateAndWait(resourceGroupName: string, virtualHubName: string, connectionName: string, hubVirtualNetworkConnectionParameters: HubVirtualNetworkConnection, options?: HubVirtualNetworkConnectionsCreateOrUpdateOptionalParams): Promise<HubVirtualNetworkConnection>

Parameters

resourceGroupName

string

The resource group name of the HubVirtualNetworkConnection.

virtualHubName

string

The name of the VirtualHub.

connectionName

string

The name of the HubVirtualNetworkConnection.

hubVirtualNetworkConnectionParameters

HubVirtualNetworkConnection

Parameters supplied to create or update a hub virtual network connection.

options

HubVirtualNetworkConnectionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<HubVirtualNetworkConnection>

beginDelete(string, string, string, HubVirtualNetworkConnectionsDeleteOptionalParams)

Deletes a HubVirtualNetworkConnection.

function beginDelete(resourceGroupName: string, virtualHubName: string, connectionName: string, options?: HubVirtualNetworkConnectionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The resource group name of the VirtualHub.

virtualHubName

string

The name of the VirtualHub.

connectionName

string

The name of the HubVirtualNetworkConnection.

options

HubVirtualNetworkConnectionsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, HubVirtualNetworkConnectionsDeleteOptionalParams)

Deletes a HubVirtualNetworkConnection.

function beginDeleteAndWait(resourceGroupName: string, virtualHubName: string, connectionName: string, options?: HubVirtualNetworkConnectionsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name of the VirtualHub.

virtualHubName

string

The name of the VirtualHub.

connectionName

string

The name of the HubVirtualNetworkConnection.

options

HubVirtualNetworkConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, HubVirtualNetworkConnectionsGetOptionalParams)

Retrieves the details of a HubVirtualNetworkConnection.

function get(resourceGroupName: string, virtualHubName: string, connectionName: string, options?: HubVirtualNetworkConnectionsGetOptionalParams): Promise<HubVirtualNetworkConnection>

Parameters

resourceGroupName

string

The resource group name of the VirtualHub.

virtualHubName

string

The name of the VirtualHub.

connectionName

string

The name of the vpn connection.

options

HubVirtualNetworkConnectionsGetOptionalParams

The options parameters.

Returns

Promise<HubVirtualNetworkConnection>

list(string, string, HubVirtualNetworkConnectionsListOptionalParams)

Retrieves the details of all HubVirtualNetworkConnections.

function list(resourceGroupName: string, virtualHubName: string, options?: HubVirtualNetworkConnectionsListOptionalParams): PagedAsyncIterableIterator<HubVirtualNetworkConnection, HubVirtualNetworkConnection[], PageSettings>

Parameters

resourceGroupName

string

The resource group name of the VirtualHub.

virtualHubName

string

The name of the VirtualHub.

options

HubVirtualNetworkConnectionsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<HubVirtualNetworkConnection, HubVirtualNetworkConnection[], PageSettings>