VirtualHubsOperations interface

Package:
@azure/arm-network

Interface representing a VirtualHubs operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginGetEffectiveVirtualHubRoutes
beginGetEffectiveVirtualHubRoutesAndWait
beginGetInboundRoutes
beginGetInboundRoutesAndWait
beginGetOutboundRoutes
beginGetOutboundRoutesAndWait
createOrUpdate

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

Deletes a VirtualHub.
get

Retrieves the details of a VirtualHub.
getEffectiveVirtualHubRoutes

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

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

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

Lists all the VirtualHubs in a subscription.
listByResourceGroup

Lists all the VirtualHubs in a resource group.
updateTags

Updates VirtualHub tags.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginGetEffectiveVirtualHubRoutes

Warning

This API is now deprecated.

use getEffectiveVirtualHubRoutes instead

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

Property Value

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

beginGetEffectiveVirtualHubRoutesAndWait

Warning

This API is now deprecated.

use getEffectiveVirtualHubRoutes instead

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

Property Value

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

beginGetInboundRoutes

Warning

This API is now deprecated.

use getInboundRoutes instead

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

Property Value

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

beginGetInboundRoutesAndWait

Warning

This API is now deprecated.

use getInboundRoutes instead

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

Property Value

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

beginGetOutboundRoutes

Warning

This API is now deprecated.

use getOutboundRoutes instead

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

Property Value

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

beginGetOutboundRoutesAndWait

Warning

This API is now deprecated.

use getOutboundRoutes instead

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

Property Value

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

createOrUpdate

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

createOrUpdate: (resourceGroupName: string, virtualHubName: string, virtualHubParameters: VirtualHub, options?: VirtualHubsCreateOrUpdateOptionalParams) => PollerLike<OperationState<VirtualHub>, VirtualHub>

Property Value

(resourceGroupName: string, virtualHubName: string, virtualHubParameters: VirtualHub, options?: VirtualHubsCreateOrUpdateOptionalParams) => PollerLike<OperationState<VirtualHub>, VirtualHub>

delete

Deletes a VirtualHub.

delete: (resourceGroupName: string, virtualHubName: string, options?: VirtualHubsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, virtualHubName: string, options?: VirtualHubsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Retrieves the details of a VirtualHub.

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

Property Value

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

getEffectiveVirtualHubRoutes

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

getEffectiveVirtualHubRoutes: (resourceGroupName: string, virtualHubName: string, options?: VirtualHubsGetEffectiveVirtualHubRoutesOptionalParams) => PollerLike<OperationState<VirtualHubEffectiveRouteList>, VirtualHubEffectiveRouteList>

Property Value

(resourceGroupName: string, virtualHubName: string, options?: VirtualHubsGetEffectiveVirtualHubRoutesOptionalParams) => PollerLike<OperationState<VirtualHubEffectiveRouteList>, VirtualHubEffectiveRouteList>

getInboundRoutes

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

getInboundRoutes: (resourceGroupName: string, virtualHubName: string, getInboundRoutesParameters: GetInboundRoutesParameters, options?: VirtualHubsGetInboundRoutesOptionalParams) => PollerLike<OperationState<EffectiveRouteMapRouteList>, EffectiveRouteMapRouteList>

Property Value

(resourceGroupName: string, virtualHubName: string, getInboundRoutesParameters: GetInboundRoutesParameters, options?: VirtualHubsGetInboundRoutesOptionalParams) => PollerLike<OperationState<EffectiveRouteMapRouteList>, EffectiveRouteMapRouteList>

getOutboundRoutes

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

getOutboundRoutes: (resourceGroupName: string, virtualHubName: string, getOutboundRoutesParameters: GetOutboundRoutesParameters, options?: VirtualHubsGetOutboundRoutesOptionalParams) => PollerLike<OperationState<EffectiveRouteMapRouteList>, EffectiveRouteMapRouteList>

Property Value

(resourceGroupName: string, virtualHubName: string, getOutboundRoutesParameters: GetOutboundRoutesParameters, options?: VirtualHubsGetOutboundRoutesOptionalParams) => PollerLike<OperationState<EffectiveRouteMapRouteList>, EffectiveRouteMapRouteList>

list

Lists all the VirtualHubs in a subscription.

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

Property Value

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

listByResourceGroup

Lists all the VirtualHubs in a resource group.

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

Property Value

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

updateTags

Updates VirtualHub tags.

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

Property Value

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