ExpressRouteCircuits interface

Package:

@azure/arm-network

Interface representing a ExpressRouteCircuits.

Methods

beginCreateOrUpdate(string, string, ExpressRouteCircuit, ExpressRouteCircuitsCreateOrUpdateOptionalParams)	Creates or updates an express route circuit.
beginCreateOrUpdateAndWait(string, string, ExpressRouteCircuit, ExpressRouteCircuitsCreateOrUpdateOptionalParams)	Creates or updates an express route circuit.
beginDelete(string, string, ExpressRouteCircuitsDeleteOptionalParams)	Deletes the specified express route circuit.
beginDeleteAndWait(string, string, ExpressRouteCircuitsDeleteOptionalParams)	Deletes the specified express route circuit.
beginListArpTable(string, string, string, string, ExpressRouteCircuitsListArpTableOptionalParams)	Gets the currently advertised ARP table associated with the express route circuit in a resource group.
beginListArpTableAndWait(string, string, string, string, ExpressRouteCircuitsListArpTableOptionalParams)	Gets the currently advertised ARP table associated with the express route circuit in a resource group.
beginListRoutesTable(string, string, string, string, ExpressRouteCircuitsListRoutesTableOptionalParams)	Gets the currently advertised routes table associated with the express route circuit in a resource group.
beginListRoutesTableAndWait(string, string, string, string, ExpressRouteCircuitsListRoutesTableOptionalParams)	Gets the currently advertised routes table associated with the express route circuit in a resource group.
beginListRoutesTableSummary(string, string, string, string, ExpressRouteCircuitsListRoutesTableSummaryOptionalParams)	Gets the currently advertised routes table summary associated with the express route circuit in a resource group.
beginListRoutesTableSummaryAndWait(string, string, string, string, ExpressRouteCircuitsListRoutesTableSummaryOptionalParams)	Gets the currently advertised routes table summary associated with the express route circuit in a resource group.
get(string, string, ExpressRouteCircuitsGetOptionalParams)	Gets information about the specified express route circuit.
getPeeringStats(string, string, string, ExpressRouteCircuitsGetPeeringStatsOptionalParams)	Gets all stats from an express route circuit in a resource group.
getStats(string, string, ExpressRouteCircuitsGetStatsOptionalParams)	Gets all the stats from an express route circuit in a resource group.
list(string, ExpressRouteCircuitsListOptionalParams)	Gets all the express route circuits in a resource group.
listAll(ExpressRouteCircuitsListAllOptionalParams)	Gets all the express route circuits in a subscription.
updateTags(string, string, TagsObject, ExpressRouteCircuitsUpdateTagsOptionalParams)	Updates an express route circuit tags.

Method Details

beginCreateOrUpdate(string, string, ExpressRouteCircuit, ExpressRouteCircuitsCreateOrUpdateOptionalParams)

Creates or updates an express route circuit.

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

Parameters

resourceGroupName

string

The name of the resource group.

circuitName

string

The name of the circuit.

parameters

ExpressRouteCircuit

Parameters supplied to the create or update express route circuit operation.

options

ExpressRouteCircuitsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, ExpressRouteCircuit, ExpressRouteCircuitsCreateOrUpdateOptionalParams)

Creates or updates an express route circuit.

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

Parameters

resourceGroupName

string

The name of the resource group.

circuitName

string

The name of the circuit.

parameters

ExpressRouteCircuit

Parameters supplied to the create or update express route circuit operation.

options

ExpressRouteCircuitsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ExpressRouteCircuit>

beginDelete(string, string, ExpressRouteCircuitsDeleteOptionalParams)

Deletes the specified express route circuit.

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

Parameters

resourceGroupName

string

The name of the resource group.

circuitName

string

The name of the express route circuit.

options

ExpressRouteCircuitsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, ExpressRouteCircuitsDeleteOptionalParams)

Deletes the specified express route circuit.

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

Parameters

resourceGroupName

string

The name of the resource group.

circuitName

string

The name of the express route circuit.

options

ExpressRouteCircuitsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginListArpTable(string, string, string, string, ExpressRouteCircuitsListArpTableOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group.

circuitName

string

The name of the express route circuit.

peeringName

string

The name of the peering.

devicePath

string

The path of the device.

options

ExpressRouteCircuitsListArpTableOptionalParams

The options parameters.

Returns

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

beginListArpTableAndWait(string, string, string, string, ExpressRouteCircuitsListArpTableOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group.

circuitName

string

The name of the express route circuit.

peeringName

string

The name of the peering.

devicePath

string

The path of the device.

options

ExpressRouteCircuitsListArpTableOptionalParams

The options parameters.

Returns

Promise<ExpressRouteCircuitsArpTableListResult>

beginListRoutesTable(string, string, string, string, ExpressRouteCircuitsListRoutesTableOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group.

circuitName

string

The name of the express route circuit.

peeringName

string

The name of the peering.

devicePath

string

The path of the device.

options

ExpressRouteCircuitsListRoutesTableOptionalParams

The options parameters.

Returns

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

beginListRoutesTableAndWait(string, string, string, string, ExpressRouteCircuitsListRoutesTableOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group.

circuitName

string

The name of the express route circuit.

peeringName

string

The name of the peering.

devicePath

string

The path of the device.

options

ExpressRouteCircuitsListRoutesTableOptionalParams

The options parameters.

Returns

Promise<ExpressRouteCircuitsRoutesTableListResult>

beginListRoutesTableSummary(string, string, string, string, ExpressRouteCircuitsListRoutesTableSummaryOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group.

circuitName

string

The name of the express route circuit.

peeringName

string

The name of the peering.

devicePath

string

The path of the device.

options

ExpressRouteCircuitsListRoutesTableSummaryOptionalParams

The options parameters.

Returns

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

beginListRoutesTableSummaryAndWait(string, string, string, string, ExpressRouteCircuitsListRoutesTableSummaryOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group.

circuitName

string

The name of the express route circuit.

peeringName

string

The name of the peering.

devicePath

string

The path of the device.

options

ExpressRouteCircuitsListRoutesTableSummaryOptionalParams

The options parameters.

Returns

Promise<ExpressRouteCircuitsRoutesTableSummaryListResult>

get(string, string, ExpressRouteCircuitsGetOptionalParams)

Gets information about the specified express route circuit.

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

Parameters

resourceGroupName

string

The name of the resource group.

circuitName

string

The name of express route circuit.

options

ExpressRouteCircuitsGetOptionalParams

The options parameters.

Returns

Promise<ExpressRouteCircuit>

getPeeringStats(string, string, string, ExpressRouteCircuitsGetPeeringStatsOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group.

circuitName

string

The name of the express route circuit.

peeringName

string

The name of the peering.

options

ExpressRouteCircuitsGetPeeringStatsOptionalParams

The options parameters.

Returns

Promise<ExpressRouteCircuitStats>

getStats(string, string, ExpressRouteCircuitsGetStatsOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group.

circuitName

string

The name of the express route circuit.

options

ExpressRouteCircuitsGetStatsOptionalParams

The options parameters.

Returns

Promise<ExpressRouteCircuitStats>

list(string, ExpressRouteCircuitsListOptionalParams)

Gets all the express route circuits in a resource group.

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

Parameters

resourceGroupName

string

The name of the resource group.

options

ExpressRouteCircuitsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ExpressRouteCircuit, ExpressRouteCircuit[], PageSettings>

listAll(ExpressRouteCircuitsListAllOptionalParams)

Gets all the express route circuits in a subscription.

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

Parameters

options

ExpressRouteCircuitsListAllOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ExpressRouteCircuit, ExpressRouteCircuit[], PageSettings>

updateTags(string, string, TagsObject, ExpressRouteCircuitsUpdateTagsOptionalParams)

Updates an express route circuit tags.

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

Parameters

resourceGroupName

string

The name of the resource group.

circuitName

string

The name of the circuit.

parameters

TagsObject

Parameters supplied to update express route circuit tags.

options

ExpressRouteCircuitsUpdateTagsOptionalParams

The options parameters.

Returns

Promise<ExpressRouteCircuit>