ExpressRouteCircuitsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:express_route_circuits> attribute.

Inheritance

builtins.object

ExpressRouteCircuitsOperations

Constructor

ExpressRouteCircuitsOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates an express route circuit.
begin_delete	Deletes the specified express route circuit.
begin_list_arp_table	Gets the currently advertised ARP table associated with the express route circuit in a resource group.
begin_list_routes_table	Gets the currently advertised routes table associated with the express route circuit in a resource group.
begin_list_routes_table_summary	Gets the currently advertised routes table summary associated with the express route circuit in a resource group.
get	Gets information about the specified express route circuit.
get_peering_stats	Gets all stats from an express route circuit in a resource group.
get_stats	Gets all the stats from an express route circuit in a resource group.
list	Gets all the express route circuits in a resource group.
list_all	Gets all the express route circuits in a subscription.
update_tags	Updates an express route circuit tags.

begin_create_or_update

Creates or updates an express route circuit.

begin_create_or_update(resource_group_name: str, circuit_name: str, parameters: _models.ExpressRouteCircuit, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ExpressRouteCircuit]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
circuit_name Required	str The name of the circuit. Required.
parameters Required	ExpressRouteCircuit or IO[bytes] Parameters supplied to the create or update express route circuit operation. Is either a ExpressRouteCircuit type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[ExpressRouteCircuit]	An instance of LROPoller that returns either ExpressRouteCircuit or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the specified express route circuit.

begin_delete(resource_group_name: str, circuit_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
circuit_name Required	str The name of the express route circuit. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_list_arp_table

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

begin_list_arp_table(resource_group_name: str, circuit_name: str, peering_name: str, device_path: str, **kwargs: Any) -> LROPoller[ExpressRouteCircuitsArpTableListResult]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
circuit_name Required	str The name of the express route circuit. Required.
peering_name Required	str The name of the peering. Required.
device_path Required	str The path of the device. Required.

Returns

Type	Description
LROPoller[ExpressRouteCircuitsArpTableListResult]	An instance of LROPoller that returns either ExpressRouteCircuitsArpTableListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_list_routes_table

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

begin_list_routes_table(resource_group_name: str, circuit_name: str, peering_name: str, device_path: str, **kwargs: Any) -> LROPoller[ExpressRouteCircuitsRoutesTableListResult]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
circuit_name Required	str The name of the express route circuit. Required.
peering_name Required	str The name of the peering. Required.
device_path Required	str The path of the device. Required.

Returns

Type	Description
LROPoller[ExpressRouteCircuitsRoutesTableListResult]	An instance of LROPoller that returns either ExpressRouteCircuitsRoutesTableListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_list_routes_table_summary

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

begin_list_routes_table_summary(resource_group_name: str, circuit_name: str, peering_name: str, device_path: str, **kwargs: Any) -> LROPoller[ExpressRouteCircuitsRoutesTableSummaryListResult]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
circuit_name Required	str The name of the express route circuit. Required.
peering_name Required	str The name of the peering. Required.
device_path Required	str The path of the device. Required.

Returns

Type	Description
LROPoller[ExpressRouteCircuitsRoutesTableSummaryListResult]	An instance of LROPoller that returns either ExpressRouteCircuitsRoutesTableSummaryListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets information about the specified express route circuit.

get(resource_group_name: str, circuit_name: str, **kwargs: Any) -> ExpressRouteCircuit

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
circuit_name Required	str The name of express route circuit. Required.

Returns

Type	Description
ExpressRouteCircuit	ExpressRouteCircuit or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_peering_stats

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

get_peering_stats(resource_group_name: str, circuit_name: str, peering_name: str, **kwargs: Any) -> ExpressRouteCircuitStats

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
circuit_name Required	str The name of the express route circuit. Required.
peering_name Required	str The name of the peering. Required.

Returns

Type	Description
ExpressRouteCircuitStats	ExpressRouteCircuitStats or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_stats

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

get_stats(resource_group_name: str, circuit_name: str, **kwargs: Any) -> ExpressRouteCircuitStats

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
circuit_name Required	str The name of the express route circuit. Required.

Returns

Type	Description
ExpressRouteCircuitStats	ExpressRouteCircuitStats or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Gets all the express route circuits in a resource group.

list(resource_group_name: str, **kwargs: Any) -> Iterable[ExpressRouteCircuit]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.

Returns

Type	Description
ItemPaged[ExpressRouteCircuit]	An iterator like instance of either ExpressRouteCircuit or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_all

Gets all the express route circuits in a subscription.

list_all(**kwargs: Any) -> Iterable[ExpressRouteCircuit]

Returns

Type	Description
ItemPaged[ExpressRouteCircuit]	An iterator like instance of either ExpressRouteCircuit or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update_tags

Updates an express route circuit tags.

update_tags(resource_group_name: str, circuit_name: str, parameters: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ExpressRouteCircuit

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
circuit_name Required	str The name of the circuit. Required.
parameters Required	TagsObject or IO[bytes] Parameters supplied to update express route circuit tags. Is either a TagsObject type or a IO[bytes] type. Required.

Returns

Type	Description
ExpressRouteCircuit	ExpressRouteCircuit or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.network.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\network\\models\\__init__.py'>