ExpressRouteGateways interface

Package:

@azure/arm-network

Interface representing a ExpressRouteGateways.

Methods

beginCreateOrUpdate(string, string, ExpressRouteGateway, ExpressRouteGatewaysCreateOrUpdateOptionalParams)	Creates or updates a ExpressRoute gateway in a specified resource group.
beginCreateOrUpdateAndWait(string, string, ExpressRouteGateway, ExpressRouteGatewaysCreateOrUpdateOptionalParams)	Creates or updates a ExpressRoute gateway in a specified resource group.
beginDelete(string, string, ExpressRouteGatewaysDeleteOptionalParams)	Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources.
beginDeleteAndWait(string, string, ExpressRouteGatewaysDeleteOptionalParams)	Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources.
beginUpdateTags(string, string, TagsObject, ExpressRouteGatewaysUpdateTagsOptionalParams)	Updates express route gateway tags.
beginUpdateTagsAndWait(string, string, TagsObject, ExpressRouteGatewaysUpdateTagsOptionalParams)	Updates express route gateway tags.
get(string, string, ExpressRouteGatewaysGetOptionalParams)	Fetches the details of a ExpressRoute gateway in a resource group.
listByResourceGroup(string, ExpressRouteGatewaysListByResourceGroupOptionalParams)	Lists ExpressRoute gateways in a given resource group.
listBySubscription(ExpressRouteGatewaysListBySubscriptionOptionalParams)	Lists ExpressRoute gateways under a given subscription.

Method Details

beginCreateOrUpdate(string, string, ExpressRouteGateway, ExpressRouteGatewaysCreateOrUpdateOptionalParams)

Creates or updates a ExpressRoute gateway in a specified resource group.

function beginCreateOrUpdate(resourceGroupName: string, expressRouteGatewayName: string, putExpressRouteGatewayParameters: ExpressRouteGateway, options?: ExpressRouteGatewaysCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ExpressRouteGateway>, ExpressRouteGateway>>

Parameters

resourceGroupName

string

The name of the resource group.

expressRouteGatewayName

string

The name of the ExpressRoute gateway.

putExpressRouteGatewayParameters

ExpressRouteGateway

Parameters required in an ExpressRoute gateway PUT operation.

options

ExpressRouteGatewaysCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, ExpressRouteGateway, ExpressRouteGatewaysCreateOrUpdateOptionalParams)

Creates or updates a ExpressRoute gateway in a specified resource group.

function beginCreateOrUpdateAndWait(resourceGroupName: string, expressRouteGatewayName: string, putExpressRouteGatewayParameters: ExpressRouteGateway, options?: ExpressRouteGatewaysCreateOrUpdateOptionalParams): Promise<ExpressRouteGateway>

Parameters

resourceGroupName

string

The name of the resource group.

expressRouteGatewayName

string

The name of the ExpressRoute gateway.

putExpressRouteGatewayParameters

ExpressRouteGateway

Parameters required in an ExpressRoute gateway PUT operation.

options

ExpressRouteGatewaysCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ExpressRouteGateway>

beginDelete(string, string, ExpressRouteGatewaysDeleteOptionalParams)

Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources.

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

Parameters

resourceGroupName

string

The name of the resource group.

expressRouteGatewayName

string

The name of the ExpressRoute gateway.

options

ExpressRouteGatewaysDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, ExpressRouteGatewaysDeleteOptionalParams)

Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources.

function beginDeleteAndWait(resourceGroupName: string, expressRouteGatewayName: string, options?: ExpressRouteGatewaysDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

expressRouteGatewayName

string

The name of the ExpressRoute gateway.

options

ExpressRouteGatewaysDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdateTags(string, string, TagsObject, ExpressRouteGatewaysUpdateTagsOptionalParams)

Updates express route gateway tags.

function beginUpdateTags(resourceGroupName: string, expressRouteGatewayName: string, expressRouteGatewayParameters: TagsObject, options?: ExpressRouteGatewaysUpdateTagsOptionalParams): Promise<SimplePollerLike<OperationState<ExpressRouteGateway>, ExpressRouteGateway>>

Parameters

resourceGroupName

string

The resource group name of the ExpressRouteGateway.

expressRouteGatewayName

string

The name of the gateway.

expressRouteGatewayParameters

TagsObject

Parameters supplied to update a virtual wan express route gateway tags.

options

ExpressRouteGatewaysUpdateTagsOptionalParams

The options parameters.

Returns

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

beginUpdateTagsAndWait(string, string, TagsObject, ExpressRouteGatewaysUpdateTagsOptionalParams)

Updates express route gateway tags.

function beginUpdateTagsAndWait(resourceGroupName: string, expressRouteGatewayName: string, expressRouteGatewayParameters: TagsObject, options?: ExpressRouteGatewaysUpdateTagsOptionalParams): Promise<ExpressRouteGateway>

Parameters

resourceGroupName

string

The resource group name of the ExpressRouteGateway.

expressRouteGatewayName

string

The name of the gateway.

expressRouteGatewayParameters

TagsObject

Parameters supplied to update a virtual wan express route gateway tags.

options

ExpressRouteGatewaysUpdateTagsOptionalParams

The options parameters.

Returns

Promise<ExpressRouteGateway>

get(string, string, ExpressRouteGatewaysGetOptionalParams)

Fetches the details of a ExpressRoute gateway in a resource group.

function get(resourceGroupName: string, expressRouteGatewayName: string, options?: ExpressRouteGatewaysGetOptionalParams): Promise<ExpressRouteGateway>

Parameters

resourceGroupName

string

The name of the resource group.

expressRouteGatewayName

string

The name of the ExpressRoute gateway.

options

ExpressRouteGatewaysGetOptionalParams

The options parameters.

Returns

Promise<ExpressRouteGateway>

listByResourceGroup(string, ExpressRouteGatewaysListByResourceGroupOptionalParams)

Lists ExpressRoute gateways in a given resource group.

function listByResourceGroup(resourceGroupName: string, options?: ExpressRouteGatewaysListByResourceGroupOptionalParams): Promise<ExpressRouteGatewayList>

Parameters

resourceGroupName

string

The name of the resource group.

options

ExpressRouteGatewaysListByResourceGroupOptionalParams

The options parameters.

Returns

Promise<ExpressRouteGatewayList>

listBySubscription(ExpressRouteGatewaysListBySubscriptionOptionalParams)

Lists ExpressRoute gateways under a given subscription.

function listBySubscription(options?: ExpressRouteGatewaysListBySubscriptionOptionalParams): Promise<ExpressRouteGatewayList>

Parameters

options

ExpressRouteGatewaysListBySubscriptionOptionalParams

The options parameters.

Returns

Promise<ExpressRouteGatewayList>