ExpressRouteCircuitsOperations interface

Package:
@azure/arm-network

Interface representing a ExpressRouteCircuits operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginGetCircuitLinkFailoverAllTestsDetails
beginGetCircuitLinkFailoverAllTestsDetailsAndWait
beginGetCircuitLinkFailoverSingleTestDetails
beginGetCircuitLinkFailoverSingleTestDetailsAndWait
beginListArpTable
beginListArpTableAndWait
beginListRoutesTable
beginListRoutesTableAndWait
beginListRoutesTableSummary
beginListRoutesTableSummaryAndWait
beginStartCircuitLinkFailoverTest
beginStartCircuitLinkFailoverTestAndWait
beginStopCircuitLinkFailoverTest
beginStopCircuitLinkFailoverTestAndWait
createOrUpdate

Creates or updates an express route circuit.
delete

Deletes the specified express route circuit.
get

Gets information about the specified express route circuit.
getCircuitLinkFailoverAllTestsDetails

Retrieves the details of all the link failover tests performed on the express route circuit.
getCircuitLinkFailoverSingleTestDetails

Retrieves the details of a particular link failover test performed on the express route circuit.
getPeeringStats

Gets all stats from an express route circuit in a resource group.
getStats

Gets all the stats from an express route circuit in a resource group.
list

Gets all the express route circuits in a resource group.
listAll

Gets all the express route circuits in a subscription.
listArpTable

Gets the currently advertised ARP table associated with the express route circuit in a resource group.
listRoutesTable

Gets the currently advertised routes table associated with the express route circuit in a resource group.
listRoutesTableSummary

Gets the currently advertised routes table summary associated with the express route circuit in a resource group.
startCircuitLinkFailoverTest

Starts link failover simulation on the express route circuit for the specified link type and test category.
stopCircuitLinkFailoverTest

Stops link failover simulation on the express route circuit.
updateTags

Updates an express route circuit tags.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, circuitName: string, parameters: ExpressRouteCircuit, options?: ExpressRouteCircuitsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteCircuit>, ExpressRouteCircuit>>

Property Value

(resourceGroupName: string, circuitName: string, parameters: ExpressRouteCircuit, options?: ExpressRouteCircuitsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteCircuit>, ExpressRouteCircuit>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, circuitName: string, parameters: ExpressRouteCircuit, options?: ExpressRouteCircuitsCreateOrUpdateOptionalParams) => Promise<ExpressRouteCircuit>

Property Value

(resourceGroupName: string, circuitName: string, parameters: ExpressRouteCircuit, options?: ExpressRouteCircuitsCreateOrUpdateOptionalParams) => Promise<ExpressRouteCircuit>

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

(resourceGroupName: string, circuitName: string, options?: ExpressRouteCircuitsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, circuitName: string, options?: ExpressRouteCircuitsDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, circuitName: string, options?: ExpressRouteCircuitsDeleteOptionalParams) => Promise<void>

beginGetCircuitLinkFailoverAllTestsDetails

Warning

This API is now deprecated.

use getCircuitLinkFailoverAllTestsDetails instead

beginGetCircuitLinkFailoverAllTestsDetails: (resourceGroupName: string, circuitName: string, options?: ExpressRouteCircuitsGetCircuitLinkFailoverAllTestsDetailsOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteLinkFailoverAllTestsDetails[]>, ExpressRouteLinkFailoverAllTestsDetails[]>>

Property Value

(resourceGroupName: string, circuitName: string, options?: ExpressRouteCircuitsGetCircuitLinkFailoverAllTestsDetailsOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteLinkFailoverAllTestsDetails[]>, ExpressRouteLinkFailoverAllTestsDetails[]>>

beginGetCircuitLinkFailoverAllTestsDetailsAndWait

Warning

This API is now deprecated.

use getCircuitLinkFailoverAllTestsDetails instead

beginGetCircuitLinkFailoverAllTestsDetailsAndWait: (resourceGroupName: string, circuitName: string, options?: ExpressRouteCircuitsGetCircuitLinkFailoverAllTestsDetailsOptionalParams) => Promise<ExpressRouteLinkFailoverAllTestsDetails[]>

Property Value

(resourceGroupName: string, circuitName: string, options?: ExpressRouteCircuitsGetCircuitLinkFailoverAllTestsDetailsOptionalParams) => Promise<ExpressRouteLinkFailoverAllTestsDetails[]>

beginGetCircuitLinkFailoverSingleTestDetails

Warning

This API is now deprecated.

use getCircuitLinkFailoverSingleTestDetails instead

beginGetCircuitLinkFailoverSingleTestDetails: (resourceGroupName: string, circuitName: string, linkType: string, circuitTestCategory: string, failoverTestId: string, options?: ExpressRouteCircuitsGetCircuitLinkFailoverSingleTestDetailsOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteLinkFailoverSingleTestDetails[]>, ExpressRouteLinkFailoverSingleTestDetails[]>>

Property Value

(resourceGroupName: string, circuitName: string, linkType: string, circuitTestCategory: string, failoverTestId: string, options?: ExpressRouteCircuitsGetCircuitLinkFailoverSingleTestDetailsOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteLinkFailoverSingleTestDetails[]>, ExpressRouteLinkFailoverSingleTestDetails[]>>

beginGetCircuitLinkFailoverSingleTestDetailsAndWait

Warning

This API is now deprecated.

use getCircuitLinkFailoverSingleTestDetails instead

beginGetCircuitLinkFailoverSingleTestDetailsAndWait: (resourceGroupName: string, circuitName: string, linkType: string, circuitTestCategory: string, failoverTestId: string, options?: ExpressRouteCircuitsGetCircuitLinkFailoverSingleTestDetailsOptionalParams) => Promise<ExpressRouteLinkFailoverSingleTestDetails[]>

Property Value

(resourceGroupName: string, circuitName: string, linkType: string, circuitTestCategory: string, failoverTestId: string, options?: ExpressRouteCircuitsGetCircuitLinkFailoverSingleTestDetailsOptionalParams) => Promise<ExpressRouteLinkFailoverSingleTestDetails[]>

beginListArpTable

Warning

This API is now deprecated.

use listArpTable instead

beginListArpTable: (resourceGroupName: string, circuitName: string, peeringName: string, devicePath: string, options?: ExpressRouteCircuitsListArpTableOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteCircuitsArpTableListResult>, ExpressRouteCircuitsArpTableListResult>>

Property Value

(resourceGroupName: string, circuitName: string, peeringName: string, devicePath: string, options?: ExpressRouteCircuitsListArpTableOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteCircuitsArpTableListResult>, ExpressRouteCircuitsArpTableListResult>>

beginListArpTableAndWait

Warning

This API is now deprecated.

use listArpTable instead

beginListArpTableAndWait: (resourceGroupName: string, circuitName: string, peeringName: string, devicePath: string, options?: ExpressRouteCircuitsListArpTableOptionalParams) => Promise<ExpressRouteCircuitsArpTableListResult>

Property Value

(resourceGroupName: string, circuitName: string, peeringName: string, devicePath: string, options?: ExpressRouteCircuitsListArpTableOptionalParams) => Promise<ExpressRouteCircuitsArpTableListResult>

beginListRoutesTable

Warning

This API is now deprecated.

use listRoutesTable instead

beginListRoutesTable: (resourceGroupName: string, circuitName: string, peeringName: string, devicePath: string, options?: ExpressRouteCircuitsListRoutesTableOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteCircuitsRoutesTableListResult>, ExpressRouteCircuitsRoutesTableListResult>>

Property Value

(resourceGroupName: string, circuitName: string, peeringName: string, devicePath: string, options?: ExpressRouteCircuitsListRoutesTableOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteCircuitsRoutesTableListResult>, ExpressRouteCircuitsRoutesTableListResult>>

beginListRoutesTableAndWait

Warning

This API is now deprecated.

use listRoutesTable instead

beginListRoutesTableAndWait: (resourceGroupName: string, circuitName: string, peeringName: string, devicePath: string, options?: ExpressRouteCircuitsListRoutesTableOptionalParams) => Promise<ExpressRouteCircuitsRoutesTableListResult>

Property Value

(resourceGroupName: string, circuitName: string, peeringName: string, devicePath: string, options?: ExpressRouteCircuitsListRoutesTableOptionalParams) => Promise<ExpressRouteCircuitsRoutesTableListResult>

beginListRoutesTableSummary

Warning

This API is now deprecated.

use listRoutesTableSummary instead

beginListRoutesTableSummary: (resourceGroupName: string, circuitName: string, peeringName: string, devicePath: string, options?: ExpressRouteCircuitsListRoutesTableSummaryOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteCircuitsRoutesTableSummaryListResult>, ExpressRouteCircuitsRoutesTableSummaryListResult>>

Property Value

(resourceGroupName: string, circuitName: string, peeringName: string, devicePath: string, options?: ExpressRouteCircuitsListRoutesTableSummaryOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteCircuitsRoutesTableSummaryListResult>, ExpressRouteCircuitsRoutesTableSummaryListResult>>

beginListRoutesTableSummaryAndWait

Warning

This API is now deprecated.

use listRoutesTableSummary instead

beginListRoutesTableSummaryAndWait: (resourceGroupName: string, circuitName: string, peeringName: string, devicePath: string, options?: ExpressRouteCircuitsListRoutesTableSummaryOptionalParams) => Promise<ExpressRouteCircuitsRoutesTableSummaryListResult>

Property Value

(resourceGroupName: string, circuitName: string, peeringName: string, devicePath: string, options?: ExpressRouteCircuitsListRoutesTableSummaryOptionalParams) => Promise<ExpressRouteCircuitsRoutesTableSummaryListResult>

beginStartCircuitLinkFailoverTest

Warning

This API is now deprecated.

use startCircuitLinkFailoverTest instead

beginStartCircuitLinkFailoverTest: (resourceGroupName: string, circuitName: string, linkType: string, circuitTestCategory: string, options?: ExpressRouteCircuitsStartCircuitLinkFailoverTestOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteCircuitsStartCircuitLinkFailoverTestResponse>, ExpressRouteCircuitsStartCircuitLinkFailoverTestResponse>>

Property Value

(resourceGroupName: string, circuitName: string, linkType: string, circuitTestCategory: string, options?: ExpressRouteCircuitsStartCircuitLinkFailoverTestOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteCircuitsStartCircuitLinkFailoverTestResponse>, ExpressRouteCircuitsStartCircuitLinkFailoverTestResponse>>

beginStartCircuitLinkFailoverTestAndWait

Warning

This API is now deprecated.

use startCircuitLinkFailoverTest instead

beginStartCircuitLinkFailoverTestAndWait: (resourceGroupName: string, circuitName: string, linkType: string, circuitTestCategory: string, options?: ExpressRouteCircuitsStartCircuitLinkFailoverTestOptionalParams) => Promise<ExpressRouteCircuitsStartCircuitLinkFailoverTestResponse>

Property Value

(resourceGroupName: string, circuitName: string, linkType: string, circuitTestCategory: string, options?: ExpressRouteCircuitsStartCircuitLinkFailoverTestOptionalParams) => Promise<ExpressRouteCircuitsStartCircuitLinkFailoverTestResponse>

beginStopCircuitLinkFailoverTest

Warning

This API is now deprecated.

use stopCircuitLinkFailoverTest instead

beginStopCircuitLinkFailoverTest: (resourceGroupName: string, circuitName: string, body: { stopParameters: ExpressRouteLinkFailoverStopApiParameters }, options?: ExpressRouteCircuitsStopCircuitLinkFailoverTestOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteCircuitsStopCircuitLinkFailoverTestResponse>, ExpressRouteCircuitsStopCircuitLinkFailoverTestResponse>>

Property Value

(resourceGroupName: string, circuitName: string, body: { stopParameters: ExpressRouteLinkFailoverStopApiParameters }, options?: ExpressRouteCircuitsStopCircuitLinkFailoverTestOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteCircuitsStopCircuitLinkFailoverTestResponse>, ExpressRouteCircuitsStopCircuitLinkFailoverTestResponse>>

beginStopCircuitLinkFailoverTestAndWait

Warning

This API is now deprecated.

use stopCircuitLinkFailoverTest instead

beginStopCircuitLinkFailoverTestAndWait: (resourceGroupName: string, circuitName: string, body: { stopParameters: ExpressRouteLinkFailoverStopApiParameters }, options?: ExpressRouteCircuitsStopCircuitLinkFailoverTestOptionalParams) => Promise<ExpressRouteCircuitsStopCircuitLinkFailoverTestResponse>

Property Value

(resourceGroupName: string, circuitName: string, body: { stopParameters: ExpressRouteLinkFailoverStopApiParameters }, options?: ExpressRouteCircuitsStopCircuitLinkFailoverTestOptionalParams) => Promise<ExpressRouteCircuitsStopCircuitLinkFailoverTestResponse>

createOrUpdate

Creates or updates an express route circuit.

createOrUpdate: (resourceGroupName: string, circuitName: string, parameters: ExpressRouteCircuit, options?: ExpressRouteCircuitsCreateOrUpdateOptionalParams) => PollerLike<OperationState<ExpressRouteCircuit>, ExpressRouteCircuit>

Property Value

(resourceGroupName: string, circuitName: string, parameters: ExpressRouteCircuit, options?: ExpressRouteCircuitsCreateOrUpdateOptionalParams) => PollerLike<OperationState<ExpressRouteCircuit>, ExpressRouteCircuit>

delete

Deletes the specified express route circuit.

delete: (resourceGroupName: string, circuitName: string, options?: ExpressRouteCircuitsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, circuitName: string, options?: ExpressRouteCircuitsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets information about the specified express route circuit.

get: (resourceGroupName: string, circuitName: string, options?: ExpressRouteCircuitsGetOptionalParams) => Promise<ExpressRouteCircuit>

Property Value

(resourceGroupName: string, circuitName: string, options?: ExpressRouteCircuitsGetOptionalParams) => Promise<ExpressRouteCircuit>

getCircuitLinkFailoverAllTestsDetails

Retrieves the details of all the link failover tests performed on the express route circuit.

getCircuitLinkFailoverAllTestsDetails: (resourceGroupName: string, circuitName: string, options?: ExpressRouteCircuitsGetCircuitLinkFailoverAllTestsDetailsOptionalParams) => PollerLike<OperationState<ExpressRouteLinkFailoverAllTestsDetails[]>, ExpressRouteLinkFailoverAllTestsDetails[]>

Property Value

(resourceGroupName: string, circuitName: string, options?: ExpressRouteCircuitsGetCircuitLinkFailoverAllTestsDetailsOptionalParams) => PollerLike<OperationState<ExpressRouteLinkFailoverAllTestsDetails[]>, ExpressRouteLinkFailoverAllTestsDetails[]>

getCircuitLinkFailoverSingleTestDetails

Retrieves the details of a particular link failover test performed on the express route circuit.

getCircuitLinkFailoverSingleTestDetails: (resourceGroupName: string, circuitName: string, linkType: string, circuitTestCategory: string, failoverTestId: string, options?: ExpressRouteCircuitsGetCircuitLinkFailoverSingleTestDetailsOptionalParams) => PollerLike<OperationState<ExpressRouteLinkFailoverSingleTestDetails[]>, ExpressRouteLinkFailoverSingleTestDetails[]>

Property Value

(resourceGroupName: string, circuitName: string, linkType: string, circuitTestCategory: string, failoverTestId: string, options?: ExpressRouteCircuitsGetCircuitLinkFailoverSingleTestDetailsOptionalParams) => PollerLike<OperationState<ExpressRouteLinkFailoverSingleTestDetails[]>, ExpressRouteLinkFailoverSingleTestDetails[]>

getPeeringStats

Gets all stats from an express route circuit in a resource group.

getPeeringStats: (resourceGroupName: string, circuitName: string, peeringName: string, options?: ExpressRouteCircuitsGetPeeringStatsOptionalParams) => Promise<ExpressRouteCircuitStats>

Property Value

(resourceGroupName: string, circuitName: string, peeringName: string, options?: ExpressRouteCircuitsGetPeeringStatsOptionalParams) => Promise<ExpressRouteCircuitStats>

getStats

Gets all the stats from an express route circuit in a resource group.

getStats: (resourceGroupName: string, circuitName: string, options?: ExpressRouteCircuitsGetStatsOptionalParams) => Promise<ExpressRouteCircuitStats>

Property Value

(resourceGroupName: string, circuitName: string, options?: ExpressRouteCircuitsGetStatsOptionalParams) => Promise<ExpressRouteCircuitStats>

list

Gets all the express route circuits in a resource group.

list: (resourceGroupName: string, options?: ExpressRouteCircuitsListOptionalParams) => PagedAsyncIterableIterator<ExpressRouteCircuit, ExpressRouteCircuit[], PageSettings>

Property Value

(resourceGroupName: string, options?: ExpressRouteCircuitsListOptionalParams) => PagedAsyncIterableIterator<ExpressRouteCircuit, ExpressRouteCircuit[], PageSettings>

listAll

Gets all the express route circuits in a subscription.

listAll: (options?: ExpressRouteCircuitsListAllOptionalParams) => PagedAsyncIterableIterator<ExpressRouteCircuit, ExpressRouteCircuit[], PageSettings>

Property Value

(options?: ExpressRouteCircuitsListAllOptionalParams) => PagedAsyncIterableIterator<ExpressRouteCircuit, ExpressRouteCircuit[], PageSettings>

listArpTable

Gets the currently advertised ARP table associated with the express route circuit in a resource group.

listArpTable: (resourceGroupName: string, circuitName: string, peeringName: string, devicePath: string, options?: ExpressRouteCircuitsListArpTableOptionalParams) => PollerLike<OperationState<ExpressRouteCircuitsArpTableListResult>, ExpressRouteCircuitsArpTableListResult>

Property Value

(resourceGroupName: string, circuitName: string, peeringName: string, devicePath: string, options?: ExpressRouteCircuitsListArpTableOptionalParams) => PollerLike<OperationState<ExpressRouteCircuitsArpTableListResult>, ExpressRouteCircuitsArpTableListResult>

listRoutesTable

Gets the currently advertised routes table associated with the express route circuit in a resource group.

listRoutesTable: (resourceGroupName: string, circuitName: string, peeringName: string, devicePath: string, options?: ExpressRouteCircuitsListRoutesTableOptionalParams) => PollerLike<OperationState<ExpressRouteCircuitsRoutesTableListResult>, ExpressRouteCircuitsRoutesTableListResult>

Property Value

(resourceGroupName: string, circuitName: string, peeringName: string, devicePath: string, options?: ExpressRouteCircuitsListRoutesTableOptionalParams) => PollerLike<OperationState<ExpressRouteCircuitsRoutesTableListResult>, ExpressRouteCircuitsRoutesTableListResult>

listRoutesTableSummary

Gets the currently advertised routes table summary associated with the express route circuit in a resource group.

listRoutesTableSummary: (resourceGroupName: string, circuitName: string, peeringName: string, devicePath: string, options?: ExpressRouteCircuitsListRoutesTableSummaryOptionalParams) => PollerLike<OperationState<ExpressRouteCircuitsRoutesTableSummaryListResult>, ExpressRouteCircuitsRoutesTableSummaryListResult>

Property Value

(resourceGroupName: string, circuitName: string, peeringName: string, devicePath: string, options?: ExpressRouteCircuitsListRoutesTableSummaryOptionalParams) => PollerLike<OperationState<ExpressRouteCircuitsRoutesTableSummaryListResult>, ExpressRouteCircuitsRoutesTableSummaryListResult>

startCircuitLinkFailoverTest

Starts link failover simulation on the express route circuit for the specified link type and test category.

startCircuitLinkFailoverTest: (resourceGroupName: string, circuitName: string, linkType: string, circuitTestCategory: string, options?: ExpressRouteCircuitsStartCircuitLinkFailoverTestOptionalParams) => PollerLike<OperationState<ExpressRouteCircuitsStartCircuitLinkFailoverTestResponse>, ExpressRouteCircuitsStartCircuitLinkFailoverTestResponse>

Property Value

(resourceGroupName: string, circuitName: string, linkType: string, circuitTestCategory: string, options?: ExpressRouteCircuitsStartCircuitLinkFailoverTestOptionalParams) => PollerLike<OperationState<ExpressRouteCircuitsStartCircuitLinkFailoverTestResponse>, ExpressRouteCircuitsStartCircuitLinkFailoverTestResponse>

stopCircuitLinkFailoverTest

Stops link failover simulation on the express route circuit.

stopCircuitLinkFailoverTest: (resourceGroupName: string, circuitName: string, body: { stopParameters: ExpressRouteLinkFailoverStopApiParameters }, options?: ExpressRouteCircuitsStopCircuitLinkFailoverTestOptionalParams) => PollerLike<OperationState<ExpressRouteCircuitsStopCircuitLinkFailoverTestResponse>, ExpressRouteCircuitsStopCircuitLinkFailoverTestResponse>

Property Value

(resourceGroupName: string, circuitName: string, body: { stopParameters: ExpressRouteLinkFailoverStopApiParameters }, options?: ExpressRouteCircuitsStopCircuitLinkFailoverTestOptionalParams) => PollerLike<OperationState<ExpressRouteCircuitsStopCircuitLinkFailoverTestResponse>, ExpressRouteCircuitsStopCircuitLinkFailoverTestResponse>

updateTags

Updates an express route circuit tags.

updateTags: (resourceGroupName: string, circuitName: string, parameters: TagsObject, options?: ExpressRouteCircuitsUpdateTagsOptionalParams) => Promise<ExpressRouteCircuit>

Property Value

(resourceGroupName: string, circuitName: string, parameters: TagsObject, options?: ExpressRouteCircuitsUpdateTagsOptionalParams) => Promise<ExpressRouteCircuit>