ExpressRouteGatewaysOperations interface

Package:

@azure/arm-network

Interface representing a ExpressRouteGateways operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginGetFailoverAllTestsDetails
beginGetFailoverAllTestsDetailsAndWait
beginGetFailoverSingleTestDetails
beginGetFailoverSingleTestDetailsAndWait
beginGetResiliencyInformation
beginGetResiliencyInformationAndWait
beginGetRoutesInformation
beginGetRoutesInformationAndWait
beginStartSiteFailoverTest
beginStartSiteFailoverTestAndWait
beginStopSiteFailoverTest
beginStopSiteFailoverTestAndWait
beginUpdateTags
beginUpdateTagsAndWait
createOrUpdate	Creates or updates a ExpressRoute gateway in a specified resource group.
delete	Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources.
get	Fetches the details of a ExpressRoute gateway in a resource group.
getFailoverAllTestsDetails	Retrieves the details of all the failover tests performed on the ExpressRoute gateway for different peering locations.
getFailoverSingleTestDetails	Retrieves the details of a particular failover test performed on the ExpressRoute gateway based on the test Guid.
getResiliencyInformation	Retrieves the resiliency information for the ExpressRoute gateway.
getRoutesInformation	Retrieves the route sets information for the ExpressRoute gateway.
listByResourceGroup	Lists ExpressRoute gateways in a given resource group.
listBySubscription	Lists ExpressRoute gateways under a given subscription.
startSiteFailoverTest	Starts failover simulation on the ExpressRoute gateway for the specified peering location.
stopSiteFailoverTest	Stops failover simulation on the ExpressRoute gateway for the specified peering location.
updateTags	Updates express route gateway tags.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginGetFailoverAllTestsDetails

Warning

This API is now deprecated.

use getFailoverAllTestsDetails instead

beginGetFailoverAllTestsDetails: (resourceGroupName: string, expressRouteGatewayName: string, options?: ExpressRouteGatewaysGetFailoverAllTestsDetailsOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteFailoverTestDetails[]>, ExpressRouteFailoverTestDetails[]>>

Property Value

(resourceGroupName: string, expressRouteGatewayName: string, options?: ExpressRouteGatewaysGetFailoverAllTestsDetailsOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteFailoverTestDetails[]>, ExpressRouteFailoverTestDetails[]>>

beginGetFailoverAllTestsDetailsAndWait

Warning

This API is now deprecated.

use getFailoverAllTestsDetails instead

beginGetFailoverAllTestsDetailsAndWait: (resourceGroupName: string, expressRouteGatewayName: string, options?: ExpressRouteGatewaysGetFailoverAllTestsDetailsOptionalParams) => Promise<ExpressRouteFailoverTestDetails[]>

Property Value

(resourceGroupName: string, expressRouteGatewayName: string, options?: ExpressRouteGatewaysGetFailoverAllTestsDetailsOptionalParams) => Promise<ExpressRouteFailoverTestDetails[]>

beginGetFailoverSingleTestDetails

Warning

This API is now deprecated.

use getFailoverSingleTestDetails instead

beginGetFailoverSingleTestDetails: (resourceGroupName: string, expressRouteGatewayName: string, peeringLocation: string, failoverTestId: string, options?: ExpressRouteGatewaysGetFailoverSingleTestDetailsOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteFailoverSingleTestDetails[]>, ExpressRouteFailoverSingleTestDetails[]>>

Property Value

(resourceGroupName: string, expressRouteGatewayName: string, peeringLocation: string, failoverTestId: string, options?: ExpressRouteGatewaysGetFailoverSingleTestDetailsOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteFailoverSingleTestDetails[]>, ExpressRouteFailoverSingleTestDetails[]>>

beginGetFailoverSingleTestDetailsAndWait

Warning

This API is now deprecated.

use getFailoverSingleTestDetails instead

beginGetFailoverSingleTestDetailsAndWait: (resourceGroupName: string, expressRouteGatewayName: string, peeringLocation: string, failoverTestId: string, options?: ExpressRouteGatewaysGetFailoverSingleTestDetailsOptionalParams) => Promise<ExpressRouteFailoverSingleTestDetails[]>

Property Value

(resourceGroupName: string, expressRouteGatewayName: string, peeringLocation: string, failoverTestId: string, options?: ExpressRouteGatewaysGetFailoverSingleTestDetailsOptionalParams) => Promise<ExpressRouteFailoverSingleTestDetails[]>

beginGetResiliencyInformation

Warning

This API is now deprecated.

use getResiliencyInformation instead

beginGetResiliencyInformation: (resourceGroupName: string, expressRouteGatewayName: string, options?: ExpressRouteGatewaysGetResiliencyInformationOptionalParams) => Promise<SimplePollerLike<OperationState<GatewayResiliencyInformation>, GatewayResiliencyInformation>>

Property Value

(resourceGroupName: string, expressRouteGatewayName: string, options?: ExpressRouteGatewaysGetResiliencyInformationOptionalParams) => Promise<SimplePollerLike<OperationState<GatewayResiliencyInformation>, GatewayResiliencyInformation>>

beginGetResiliencyInformationAndWait

Warning

This API is now deprecated.

use getResiliencyInformation instead

beginGetResiliencyInformationAndWait: (resourceGroupName: string, expressRouteGatewayName: string, options?: ExpressRouteGatewaysGetResiliencyInformationOptionalParams) => Promise<GatewayResiliencyInformation>

Property Value

(resourceGroupName: string, expressRouteGatewayName: string, options?: ExpressRouteGatewaysGetResiliencyInformationOptionalParams) => Promise<GatewayResiliencyInformation>

beginGetRoutesInformation

Warning

This API is now deprecated.

use getRoutesInformation instead

beginGetRoutesInformation: (resourceGroupName: string, expressRouteGatewayName: string, options?: ExpressRouteGatewaysGetRoutesInformationOptionalParams) => Promise<SimplePollerLike<OperationState<GatewayRouteSetsInformation>, GatewayRouteSetsInformation>>

Property Value

(resourceGroupName: string, expressRouteGatewayName: string, options?: ExpressRouteGatewaysGetRoutesInformationOptionalParams) => Promise<SimplePollerLike<OperationState<GatewayRouteSetsInformation>, GatewayRouteSetsInformation>>

beginGetRoutesInformationAndWait

Warning

This API is now deprecated.

use getRoutesInformation instead

beginGetRoutesInformationAndWait: (resourceGroupName: string, expressRouteGatewayName: string, options?: ExpressRouteGatewaysGetRoutesInformationOptionalParams) => Promise<GatewayRouteSetsInformation>

Property Value

(resourceGroupName: string, expressRouteGatewayName: string, options?: ExpressRouteGatewaysGetRoutesInformationOptionalParams) => Promise<GatewayRouteSetsInformation>

beginStartSiteFailoverTest

Warning

This API is now deprecated.

use startSiteFailoverTest instead

beginStartSiteFailoverTest: (resourceGroupName: string, expressRouteGatewayName: string, peeringLocation: string, options?: ExpressRouteGatewaysStartSiteFailoverTestOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteGatewaysStartSiteFailoverTestResponse>, ExpressRouteGatewaysStartSiteFailoverTestResponse>>

Property Value

(resourceGroupName: string, expressRouteGatewayName: string, peeringLocation: string, options?: ExpressRouteGatewaysStartSiteFailoverTestOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteGatewaysStartSiteFailoverTestResponse>, ExpressRouteGatewaysStartSiteFailoverTestResponse>>

beginStartSiteFailoverTestAndWait

Warning

This API is now deprecated.

use startSiteFailoverTest instead

beginStartSiteFailoverTestAndWait: (resourceGroupName: string, expressRouteGatewayName: string, peeringLocation: string, options?: ExpressRouteGatewaysStartSiteFailoverTestOptionalParams) => Promise<ExpressRouteGatewaysStartSiteFailoverTestResponse>

Property Value

(resourceGroupName: string, expressRouteGatewayName: string, peeringLocation: string, options?: ExpressRouteGatewaysStartSiteFailoverTestOptionalParams) => Promise<ExpressRouteGatewaysStartSiteFailoverTestResponse>

beginStopSiteFailoverTest

Warning

This API is now deprecated.

use stopSiteFailoverTest instead

beginStopSiteFailoverTest: (resourceGroupName: string, expressRouteGatewayName: string, body: { stopParameters: ExpressRouteFailoverStopApiParameters }, options?: ExpressRouteGatewaysStopSiteFailoverTestOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteGatewaysStopSiteFailoverTestResponse>, ExpressRouteGatewaysStopSiteFailoverTestResponse>>

Property Value

(resourceGroupName: string, expressRouteGatewayName: string, body: { stopParameters: ExpressRouteFailoverStopApiParameters }, options?: ExpressRouteGatewaysStopSiteFailoverTestOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteGatewaysStopSiteFailoverTestResponse>, ExpressRouteGatewaysStopSiteFailoverTestResponse>>

beginStopSiteFailoverTestAndWait

Warning

This API is now deprecated.

use stopSiteFailoverTest instead

beginStopSiteFailoverTestAndWait: (resourceGroupName: string, expressRouteGatewayName: string, body: { stopParameters: ExpressRouteFailoverStopApiParameters }, options?: ExpressRouteGatewaysStopSiteFailoverTestOptionalParams) => Promise<ExpressRouteGatewaysStopSiteFailoverTestResponse>

Property Value

(resourceGroupName: string, expressRouteGatewayName: string, body: { stopParameters: ExpressRouteFailoverStopApiParameters }, options?: ExpressRouteGatewaysStopSiteFailoverTestOptionalParams) => Promise<ExpressRouteGatewaysStopSiteFailoverTestResponse>

beginUpdateTags

Warning

This API is now deprecated.

use updateTags instead

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

Property Value

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

beginUpdateTagsAndWait

Warning

This API is now deprecated.

use updateTags instead

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

Property Value

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

createOrUpdate

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

createOrUpdate: (resourceGroupName: string, expressRouteGatewayName: string, putExpressRouteGatewayParameters: ExpressRouteGateway, options?: ExpressRouteGatewaysCreateOrUpdateOptionalParams) => PollerLike<OperationState<ExpressRouteGateway>, ExpressRouteGateway>

Property Value

(resourceGroupName: string, expressRouteGatewayName: string, putExpressRouteGatewayParameters: ExpressRouteGateway, options?: ExpressRouteGatewaysCreateOrUpdateOptionalParams) => PollerLike<OperationState<ExpressRouteGateway>, ExpressRouteGateway>

delete

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

delete: (resourceGroupName: string, expressRouteGatewayName: string, options?: ExpressRouteGatewaysDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, expressRouteGatewayName: string, options?: ExpressRouteGatewaysDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

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

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

Property Value

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

getFailoverAllTestsDetails

Retrieves the details of all the failover tests performed on the ExpressRoute gateway for different peering locations.

getFailoverAllTestsDetails: (resourceGroupName: string, expressRouteGatewayName: string, options?: ExpressRouteGatewaysGetFailoverAllTestsDetailsOptionalParams) => PollerLike<OperationState<ExpressRouteFailoverTestDetails[]>, ExpressRouteFailoverTestDetails[]>

Property Value

(resourceGroupName: string, expressRouteGatewayName: string, options?: ExpressRouteGatewaysGetFailoverAllTestsDetailsOptionalParams) => PollerLike<OperationState<ExpressRouteFailoverTestDetails[]>, ExpressRouteFailoverTestDetails[]>

getFailoverSingleTestDetails

Retrieves the details of a particular failover test performed on the ExpressRoute gateway based on the test Guid.

getFailoverSingleTestDetails: (resourceGroupName: string, expressRouteGatewayName: string, peeringLocation: string, failoverTestId: string, options?: ExpressRouteGatewaysGetFailoverSingleTestDetailsOptionalParams) => PollerLike<OperationState<ExpressRouteFailoverSingleTestDetails[]>, ExpressRouteFailoverSingleTestDetails[]>

Property Value

(resourceGroupName: string, expressRouteGatewayName: string, peeringLocation: string, failoverTestId: string, options?: ExpressRouteGatewaysGetFailoverSingleTestDetailsOptionalParams) => PollerLike<OperationState<ExpressRouteFailoverSingleTestDetails[]>, ExpressRouteFailoverSingleTestDetails[]>

getResiliencyInformation

Retrieves the resiliency information for the ExpressRoute gateway.

getResiliencyInformation: (resourceGroupName: string, expressRouteGatewayName: string, options?: ExpressRouteGatewaysGetResiliencyInformationOptionalParams) => PollerLike<OperationState<GatewayResiliencyInformation>, GatewayResiliencyInformation>

Property Value

(resourceGroupName: string, expressRouteGatewayName: string, options?: ExpressRouteGatewaysGetResiliencyInformationOptionalParams) => PollerLike<OperationState<GatewayResiliencyInformation>, GatewayResiliencyInformation>

getRoutesInformation

Retrieves the route sets information for the ExpressRoute gateway.

getRoutesInformation: (resourceGroupName: string, expressRouteGatewayName: string, options?: ExpressRouteGatewaysGetRoutesInformationOptionalParams) => PollerLike<OperationState<GatewayRouteSetsInformation>, GatewayRouteSetsInformation>

Property Value

(resourceGroupName: string, expressRouteGatewayName: string, options?: ExpressRouteGatewaysGetRoutesInformationOptionalParams) => PollerLike<OperationState<GatewayRouteSetsInformation>, GatewayRouteSetsInformation>

listByResourceGroup

Lists ExpressRoute gateways in a given resource group.

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

Property Value

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

listBySubscription

Lists ExpressRoute gateways under a given subscription.

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

Property Value

(options?: ExpressRouteGatewaysListBySubscriptionOptionalParams) => Promise<ExpressRouteGatewayList>

startSiteFailoverTest

Starts failover simulation on the ExpressRoute gateway for the specified peering location.

startSiteFailoverTest: (resourceGroupName: string, expressRouteGatewayName: string, peeringLocation: string, options?: ExpressRouteGatewaysStartSiteFailoverTestOptionalParams) => PollerLike<OperationState<ExpressRouteGatewaysStartSiteFailoverTestResponse>, ExpressRouteGatewaysStartSiteFailoverTestResponse>

Property Value

(resourceGroupName: string, expressRouteGatewayName: string, peeringLocation: string, options?: ExpressRouteGatewaysStartSiteFailoverTestOptionalParams) => PollerLike<OperationState<ExpressRouteGatewaysStartSiteFailoverTestResponse>, ExpressRouteGatewaysStartSiteFailoverTestResponse>

stopSiteFailoverTest

Stops failover simulation on the ExpressRoute gateway for the specified peering location.

stopSiteFailoverTest: (resourceGroupName: string, expressRouteGatewayName: string, body: { stopParameters: ExpressRouteFailoverStopApiParameters }, options?: ExpressRouteGatewaysStopSiteFailoverTestOptionalParams) => PollerLike<OperationState<ExpressRouteGatewaysStopSiteFailoverTestResponse>, ExpressRouteGatewaysStopSiteFailoverTestResponse>

Property Value

(resourceGroupName: string, expressRouteGatewayName: string, body: { stopParameters: ExpressRouteFailoverStopApiParameters }, options?: ExpressRouteGatewaysStopSiteFailoverTestOptionalParams) => PollerLike<OperationState<ExpressRouteGatewaysStopSiteFailoverTestResponse>, ExpressRouteGatewaysStopSiteFailoverTestResponse>

updateTags

Updates express route gateway tags.

updateTags: (resourceGroupName: string, expressRouteGatewayName: string, expressRouteGatewayParameters: TagsObject, options?: ExpressRouteGatewaysUpdateTagsOptionalParams) => PollerLike<OperationState<ExpressRouteGateway>, ExpressRouteGateway>

Property Value

(resourceGroupName: string, expressRouteGatewayName: string, expressRouteGatewayParameters: TagsObject, options?: ExpressRouteGatewaysUpdateTagsOptionalParams) => PollerLike<OperationState<ExpressRouteGateway>, ExpressRouteGateway>