RouteMaps interface

Package:

@azure/arm-network

Interface representing a RouteMaps.

Methods

beginCreateOrUpdate(string, string, string, RouteMap, RouteMapsCreateOrUpdateOptionalParams)	Creates a RouteMap if it doesn't exist else updates the existing one.
beginCreateOrUpdateAndWait(string, string, string, RouteMap, RouteMapsCreateOrUpdateOptionalParams)	Creates a RouteMap if it doesn't exist else updates the existing one.
beginDelete(string, string, string, RouteMapsDeleteOptionalParams)	Deletes a RouteMap.
beginDeleteAndWait(string, string, string, RouteMapsDeleteOptionalParams)	Deletes a RouteMap.
get(string, string, string, RouteMapsGetOptionalParams)	Retrieves the details of a RouteMap.
list(string, string, RouteMapsListOptionalParams)	Retrieves the details of all RouteMaps.

Method Details

beginCreateOrUpdate(string, string, string, RouteMap, RouteMapsCreateOrUpdateOptionalParams)

Creates a RouteMap if it doesn't exist else updates the existing one.

function beginCreateOrUpdate(resourceGroupName: string, virtualHubName: string, routeMapName: string, routeMapParameters: RouteMap, options?: RouteMapsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<RouteMap>, RouteMap>>

Parameters

resourceGroupName

string

The resource group name of the RouteMap's resource group.

virtualHubName

string

The name of the VirtualHub containing the RouteMap.

routeMapName

string

The name of the RouteMap.

routeMapParameters

RouteMap

Parameters supplied to create or update a RouteMap.

options

RouteMapsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, RouteMap, RouteMapsCreateOrUpdateOptionalParams)

Creates a RouteMap if it doesn't exist else updates the existing one.

function beginCreateOrUpdateAndWait(resourceGroupName: string, virtualHubName: string, routeMapName: string, routeMapParameters: RouteMap, options?: RouteMapsCreateOrUpdateOptionalParams): Promise<RouteMap>

Parameters

resourceGroupName

string

The resource group name of the RouteMap's resource group.

virtualHubName

string

The name of the VirtualHub containing the RouteMap.

routeMapName

string

The name of the RouteMap.

routeMapParameters

RouteMap

Parameters supplied to create or update a RouteMap.

options

RouteMapsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<RouteMap>

beginDelete(string, string, string, RouteMapsDeleteOptionalParams)

Deletes a RouteMap.

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

Parameters

resourceGroupName

string

The resource group name of the RouteMap's resource group.

virtualHubName

string

The name of the VirtualHub containing the RouteMap.

routeMapName

string

The name of the RouteMap.

options

RouteMapsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, RouteMapsDeleteOptionalParams)

Deletes a RouteMap.

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

Parameters

resourceGroupName

string

The resource group name of the RouteMap's resource group.

virtualHubName

string

The name of the VirtualHub containing the RouteMap.

routeMapName

string

The name of the RouteMap.

options

RouteMapsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, RouteMapsGetOptionalParams)

Retrieves the details of a RouteMap.

function get(resourceGroupName: string, virtualHubName: string, routeMapName: string, options?: RouteMapsGetOptionalParams): Promise<RouteMap>

Parameters

resourceGroupName

string

The resource group name of the RouteMap's resource group.

virtualHubName

string

The name of the VirtualHub containing the RouteMap.

routeMapName

string

The name of the RouteMap.

options

RouteMapsGetOptionalParams

The options parameters.

Returns

Promise<RouteMap>

list(string, string, RouteMapsListOptionalParams)

Retrieves the details of all RouteMaps.

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

Parameters

resourceGroupName

string

The resource group name of the RouteMap's resource group'.

virtualHubName

string

The name of the VirtualHub containing the RouteMap.

options

RouteMapsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RouteMap, RouteMap[], PageSettings>