ExpressRouteCircuitsOperations Class

ExpressRouteCircuitsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

ExpressRouteCircuitsOperations

Constructor

ExpressRouteCircuitsOperations(client, config, serializer, deserializer)

Parameters

client

Client for service requests.

config

Configuration of service client.

serializer

An object model serializer.

deserializer

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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.
begin_update_tags	Updates an express route circuit tags.
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.

begin_create_or_update

Creates or updates an express route circuit.

begin_create_or_update(resource_group_name, circuit_name, parameters, **kwargs)

Parameters

resource_group_name

str

Required

The name of the resource group.

circuit_name

str

Required

The name of the circuit.

parameters

ExpressRouteCircuit

Required

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

cls

callable

Required

A custom type or function that will be passed the direct response

continuation_token

str

Required

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ExpressRouteCircuit or the result of cls(response)

Return type

LROPoller[ExpressRouteCircuit]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_delete

Deletes the specified express route circuit.

begin_delete(resource_group_name, circuit_name, **kwargs)

Parameters

resource_group_name

str

Required

The name of the resource group.

circuit_name

str

Required

The name of the express route circuit.

cls

callable

Required

A custom type or function that will be passed the direct response

continuation_token

str

Required

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

~azure.core.exceptions.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, circuit_name, peering_name, device_path, **kwargs)

Parameters

resource_group_name

str

Required

The name of the resource group.

circuit_name

str

Required

The name of the express route circuit.

peering_name

str

Required

The name of the peering.

device_path

str

Required

The path of the device.

cls

callable

Required

A custom type or function that will be passed the direct response

continuation_token

str

Required

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ExpressRouteCircuitsArpTableListResult or the result of cls(response)

Return type

LROPoller[ExpressRouteCircuitsArpTableListResult]

Exceptions

~azure.core.exceptions.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, circuit_name, peering_name, device_path, **kwargs)

Parameters

resource_group_name

str

Required

The name of the resource group.

circuit_name

str

Required

The name of the express route circuit.

peering_name

str

Required

The name of the peering.

device_path

str

Required

The path of the device.

cls

callable

Required

A custom type or function that will be passed the direct response

continuation_token

str

Required

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ExpressRouteCircuitsRoutesTableListResult or the result of cls(response)

Return type

LROPoller[ExpressRouteCircuitsRoutesTableListResult]

Exceptions

~azure.core.exceptions.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, circuit_name, peering_name, device_path, **kwargs)

Parameters

resource_group_name

str

Required

The name of the resource group.

circuit_name

str

Required

The name of the express route circuit.

peering_name

str

Required

The name of the peering.

device_path

str

Required

The path of the device.

cls

callable

Required

A custom type or function that will be passed the direct response

continuation_token

str

Required

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ExpressRouteCircuitsRoutesTableSummaryListResult or the result of cls(response)

Return type

LROPoller[ExpressRouteCircuitsRoutesTableSummaryListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_update_tags

Updates an express route circuit tags.

begin_update_tags(resource_group_name, circuit_name, parameters, **kwargs)

Parameters

resource_group_name

str

Required

The name of the resource group.

circuit_name

str

Required

The name of the circuit.

parameters

TagsObject

Required

Parameters supplied to update express route circuit tags.

cls

callable

Required

A custom type or function that will be passed the direct response

continuation_token

str

Required

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ExpressRouteCircuit or the result of cls(response)

Return type

LROPoller[ExpressRouteCircuit]

Exceptions

~azure.core.exceptions.HttpResponseError

get

Gets information about the specified express route circuit.

get(resource_group_name, circuit_name, **kwargs)

Parameters

resource_group_name

str

Required

The name of the resource group.

circuit_name

str

Required

The name of express route circuit.

cls

callable

Required

A custom type or function that will be passed the direct response

Returns

ExpressRouteCircuit, or the result of cls(response)

Return type

ExpressRouteCircuit

Exceptions

~azure.core.exceptions.HttpResponseError

get_peering_stats

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

get_peering_stats(resource_group_name, circuit_name, peering_name, **kwargs)

Parameters

resource_group_name

str

Required

The name of the resource group.

circuit_name

str

Required

The name of the express route circuit.

peering_name

str

Required

The name of the peering.

cls

callable

Required

A custom type or function that will be passed the direct response

Returns

ExpressRouteCircuitStats, or the result of cls(response)

Return type

ExpressRouteCircuitStats

Exceptions

~azure.core.exceptions.HttpResponseError

get_stats

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

get_stats(resource_group_name, circuit_name, **kwargs)

Parameters

resource_group_name

str

Required

The name of the resource group.

circuit_name

str

Required

The name of the express route circuit.

cls

callable

Required

A custom type or function that will be passed the direct response

Returns

ExpressRouteCircuitStats, or the result of cls(response)

Return type

ExpressRouteCircuitStats

Exceptions

~azure.core.exceptions.HttpResponseError

list

Gets all the express route circuits in a resource group.

list(resource_group_name, **kwargs)

Parameters

resource_group_name

str

Required

The name of the resource group.

cls

callable

Required

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ExpressRouteCircuitListResult or the result of cls(response)

Return type

ItemPaged[ExpressRouteCircuitListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

list_all

Gets all the express route circuits in a subscription.

list_all(**kwargs)

Parameters

cls

callable

Required

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ExpressRouteCircuitListResult or the result of cls(response)

Return type

ItemPaged[ExpressRouteCircuitListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

models = <module 'azure.mgmt.network.v2018_08_01.models' from 'c:\\repo\\venv\\lib\\site-packages\\azure\\mgmt\\network\\v2018_08_01\\models\\__init__.py'>