VirtualHubs interface

Package:

@azure/arm-network

Interface representing a VirtualHubs.

Methods

beginCreateOrUpdate(string, string, VirtualHub, VirtualHubsCreateOrUpdateOptionalParams)	Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub.
beginCreateOrUpdateAndWait(string, string, VirtualHub, VirtualHubsCreateOrUpdateOptionalParams)	Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub.
beginDelete(string, string, VirtualHubsDeleteOptionalParams)	Deletes a VirtualHub.
beginDeleteAndWait(string, string, VirtualHubsDeleteOptionalParams)	Deletes a VirtualHub.
beginGetEffectiveVirtualHubRoutes(string, string, VirtualHubsGetEffectiveVirtualHubRoutesOptionalParams)	Gets the effective routes configured for the Virtual Hub resource or the specified resource .
beginGetEffectiveVirtualHubRoutesAndWait(string, string, VirtualHubsGetEffectiveVirtualHubRoutesOptionalParams)	Gets the effective routes configured for the Virtual Hub resource or the specified resource .
beginGetInboundRoutes(string, string, GetInboundRoutesParameters, VirtualHubsGetInboundRoutesOptionalParams)	Gets the inbound routes configured for the Virtual Hub on a particular connection.
beginGetInboundRoutesAndWait(string, string, GetInboundRoutesParameters, VirtualHubsGetInboundRoutesOptionalParams)	Gets the inbound routes configured for the Virtual Hub on a particular connection.
beginGetOutboundRoutes(string, string, GetOutboundRoutesParameters, VirtualHubsGetOutboundRoutesOptionalParams)	Gets the outbound routes configured for the Virtual Hub on a particular connection.
beginGetOutboundRoutesAndWait(string, string, GetOutboundRoutesParameters, VirtualHubsGetOutboundRoutesOptionalParams)	Gets the outbound routes configured for the Virtual Hub on a particular connection.
get(string, string, VirtualHubsGetOptionalParams)	Retrieves the details of a VirtualHub.
list(VirtualHubsListOptionalParams)	Lists all the VirtualHubs in a subscription.
listByResourceGroup(string, VirtualHubsListByResourceGroupOptionalParams)	Lists all the VirtualHubs in a resource group.
updateTags(string, string, TagsObject, VirtualHubsUpdateTagsOptionalParams)	Updates VirtualHub tags.

Method Details

beginCreateOrUpdate(string, string, VirtualHub, VirtualHubsCreateOrUpdateOptionalParams)

Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub.

function beginCreateOrUpdate(resourceGroupName: string, virtualHubName: string, virtualHubParameters: VirtualHub, options?: VirtualHubsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualHub>, VirtualHub>>

Parameters

resourceGroupName

string

The resource group name of the VirtualHub.

virtualHubName

string

The name of the VirtualHub.

virtualHubParameters

VirtualHub

Parameters supplied to create or update VirtualHub.

options

VirtualHubsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, VirtualHub, VirtualHubsCreateOrUpdateOptionalParams)

Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub.

function beginCreateOrUpdateAndWait(resourceGroupName: string, virtualHubName: string, virtualHubParameters: VirtualHub, options?: VirtualHubsCreateOrUpdateOptionalParams): Promise<VirtualHub>

Parameters

resourceGroupName

string

The resource group name of the VirtualHub.

virtualHubName

string

The name of the VirtualHub.

virtualHubParameters

VirtualHub

Parameters supplied to create or update VirtualHub.

options

VirtualHubsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<VirtualHub>

beginDelete(string, string, VirtualHubsDeleteOptionalParams)

Deletes a VirtualHub.

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

Parameters

resourceGroupName

string

The resource group name of the VirtualHub.

virtualHubName

string

The name of the VirtualHub.

options

VirtualHubsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, VirtualHubsDeleteOptionalParams)

Deletes a VirtualHub.

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

Parameters

resourceGroupName

string

The resource group name of the VirtualHub.

virtualHubName

string

The name of the VirtualHub.

options

VirtualHubsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginGetEffectiveVirtualHubRoutes(string, string, VirtualHubsGetEffectiveVirtualHubRoutesOptionalParams)

Gets the effective routes configured for the Virtual Hub resource or the specified resource .

function beginGetEffectiveVirtualHubRoutes(resourceGroupName: string, virtualHubName: string, options?: VirtualHubsGetEffectiveVirtualHubRoutesOptionalParams): Promise<SimplePollerLike<OperationState<VirtualHubEffectiveRouteList>, VirtualHubEffectiveRouteList>>

Parameters

resourceGroupName

string

The resource group name of the VirtualHub.

virtualHubName

string

The name of the VirtualHub.

options

VirtualHubsGetEffectiveVirtualHubRoutesOptionalParams

The options parameters.

Returns

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

beginGetEffectiveVirtualHubRoutesAndWait(string, string, VirtualHubsGetEffectiveVirtualHubRoutesOptionalParams)

Gets the effective routes configured for the Virtual Hub resource or the specified resource .

function beginGetEffectiveVirtualHubRoutesAndWait(resourceGroupName: string, virtualHubName: string, options?: VirtualHubsGetEffectiveVirtualHubRoutesOptionalParams): Promise<VirtualHubEffectiveRouteList>

Parameters

resourceGroupName

string

The resource group name of the VirtualHub.

virtualHubName

string

The name of the VirtualHub.

options

VirtualHubsGetEffectiveVirtualHubRoutesOptionalParams

The options parameters.

Returns

Promise<VirtualHubEffectiveRouteList>

beginGetInboundRoutes(string, string, GetInboundRoutesParameters, VirtualHubsGetInboundRoutesOptionalParams)

Gets the inbound routes configured for the Virtual Hub on a particular connection.

function beginGetInboundRoutes(resourceGroupName: string, virtualHubName: string, getInboundRoutesParameters: GetInboundRoutesParameters, options?: VirtualHubsGetInboundRoutesOptionalParams): Promise<SimplePollerLike<OperationState<EffectiveRouteMapRouteList>, EffectiveRouteMapRouteList>>

Parameters

resourceGroupName

string

The resource group name of the VirtualHub.

virtualHubName

string

The name of the VirtualHub.

getInboundRoutesParameters

GetInboundRoutesParameters

Parameters supplied to get the inbound routes for a connection resource.

options

VirtualHubsGetInboundRoutesOptionalParams

The options parameters.

Returns

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

beginGetInboundRoutesAndWait(string, string, GetInboundRoutesParameters, VirtualHubsGetInboundRoutesOptionalParams)

Gets the inbound routes configured for the Virtual Hub on a particular connection.

function beginGetInboundRoutesAndWait(resourceGroupName: string, virtualHubName: string, getInboundRoutesParameters: GetInboundRoutesParameters, options?: VirtualHubsGetInboundRoutesOptionalParams): Promise<EffectiveRouteMapRouteList>

Parameters

resourceGroupName

string

The resource group name of the VirtualHub.

virtualHubName

string

The name of the VirtualHub.

getInboundRoutesParameters

GetInboundRoutesParameters

Parameters supplied to get the inbound routes for a connection resource.

options

VirtualHubsGetInboundRoutesOptionalParams

The options parameters.

Returns

Promise<EffectiveRouteMapRouteList>

beginGetOutboundRoutes(string, string, GetOutboundRoutesParameters, VirtualHubsGetOutboundRoutesOptionalParams)

Gets the outbound routes configured for the Virtual Hub on a particular connection.

function beginGetOutboundRoutes(resourceGroupName: string, virtualHubName: string, getOutboundRoutesParameters: GetOutboundRoutesParameters, options?: VirtualHubsGetOutboundRoutesOptionalParams): Promise<SimplePollerLike<OperationState<EffectiveRouteMapRouteList>, EffectiveRouteMapRouteList>>

Parameters

resourceGroupName

string

The resource group name of the VirtualHub.

virtualHubName

string

The name of the VirtualHub.

getOutboundRoutesParameters

GetOutboundRoutesParameters

Parameters supplied to get the outbound routes for a connection resource.

options

VirtualHubsGetOutboundRoutesOptionalParams

The options parameters.

Returns

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

beginGetOutboundRoutesAndWait(string, string, GetOutboundRoutesParameters, VirtualHubsGetOutboundRoutesOptionalParams)

Gets the outbound routes configured for the Virtual Hub on a particular connection.

function beginGetOutboundRoutesAndWait(resourceGroupName: string, virtualHubName: string, getOutboundRoutesParameters: GetOutboundRoutesParameters, options?: VirtualHubsGetOutboundRoutesOptionalParams): Promise<EffectiveRouteMapRouteList>

Parameters

resourceGroupName

string

The resource group name of the VirtualHub.

virtualHubName

string

The name of the VirtualHub.

getOutboundRoutesParameters

GetOutboundRoutesParameters

Parameters supplied to get the outbound routes for a connection resource.

options

VirtualHubsGetOutboundRoutesOptionalParams

The options parameters.

Returns

Promise<EffectiveRouteMapRouteList>

get(string, string, VirtualHubsGetOptionalParams)

Retrieves the details of a VirtualHub.

function get(resourceGroupName: string, virtualHubName: string, options?: VirtualHubsGetOptionalParams): Promise<VirtualHub>

Parameters

resourceGroupName

string

The resource group name of the VirtualHub.

virtualHubName

string

The name of the VirtualHub.

options

VirtualHubsGetOptionalParams

The options parameters.

Returns

Promise<VirtualHub>

list(VirtualHubsListOptionalParams)

Lists all the VirtualHubs in a subscription.

function list(options?: VirtualHubsListOptionalParams): PagedAsyncIterableIterator<VirtualHub, VirtualHub[], PageSettings>

Parameters

options

VirtualHubsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualHub, VirtualHub[], PageSettings>

listByResourceGroup(string, VirtualHubsListByResourceGroupOptionalParams)

Lists all the VirtualHubs in a resource group.

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

Parameters

resourceGroupName

string

The resource group name of the VirtualHub.

options

VirtualHubsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualHub, VirtualHub[], PageSettings>

updateTags(string, string, TagsObject, VirtualHubsUpdateTagsOptionalParams)

Updates VirtualHub tags.

function updateTags(resourceGroupName: string, virtualHubName: string, virtualHubParameters: TagsObject, options?: VirtualHubsUpdateTagsOptionalParams): Promise<VirtualHub>

Parameters

resourceGroupName

string

The resource group name of the VirtualHub.

virtualHubName

string

The name of the VirtualHub.

virtualHubParameters

TagsObject

Parameters supplied to update VirtualHub tags.

options

VirtualHubsUpdateTagsOptionalParams

The options parameters.

Returns

Promise<VirtualHub>