ExpressRouteCrossConnectionsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:express_route_cross_connections> attribute.

Constructor

ExpressRouteCrossConnectionsOperations(*args, **kwargs)

Methods

begin_commit_circuit_migration	Commits the express route circuit migration for a cross connection.
begin_create_or_update	Update the specified ExpressRouteCrossConnection.
begin_get_circuit_migration_info	Gets migration health information for an express route circuit cross connection.
begin_list_arp_table	Gets the currently advertised ARP table associated with the express route cross connection in a resource group.
begin_list_routes_table	Gets the currently advertised routes table associated with the express route cross connection in a resource group.
begin_list_routes_table_summary	Gets the route table summary associated with the express route cross connection in a resource group.
begin_migrate_circuit	Executes the express route circuit migration for a cross connection.
begin_prepare_circuit_migration	Prepares an express route circuit migration for a cross connection.
begin_restore_bgp_for_circuit_migration	Restores BGP sessions as part of an express route circuit migration for a cross connection.
begin_rollback_circuit_migration	Rolls back the express route circuit migration for a cross connection.
begin_shut_down_bgp_for_circuit_migration	Shuts down BGP sessions as part of an express route circuit migration for a cross connection.
begin_validate_circuit_migration	Validates express route circuit migration for a cross connection.
get	Gets details about the specified ExpressRouteCrossConnection.
list	Retrieves all the ExpressRouteCrossConnections in a subscription.
list_by_resource_group	Retrieves all the ExpressRouteCrossConnections in a resource group.
update_tags	Updates an express route cross connection tags.

begin_commit_circuit_migration

Commits the express route circuit migration for a cross connection.

begin_commit_circuit_migration(resource_group_name: str, cross_connection_name: str, parameters: _models.MigrateExpressRouteCircuitRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.MigrateExpressRouteCircuitHealthCheckResponse]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cross_connection_name Required	str The name of the ExpressRouteCrossConnection (service key of the circuit). Required.
parameters Required	MigrateExpressRouteCircuitRequest or MigrateExpressRouteCircuitRequest or IO[bytes] Parameters supplied to commit the express route circuit migration. Is either a MigrateExpressRouteCircuitRequest type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[MigrateExpressRouteCircuitHealthCheckResponse]	An instance of LROPoller that returns MigrateExpressRouteCircuitHealthCheckResponse. The MigrateExpressRouteCircuitHealthCheckResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_create_or_update

Update the specified ExpressRouteCrossConnection.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cross_connection_name Required	str The name of the ExpressRouteCrossConnection (service key of the circuit). Required.
parameters Required	ExpressRouteCrossConnection or ExpressRouteCrossConnection or IO[bytes] Parameters supplied to the update express route crossConnection operation. Is either a ExpressRouteCrossConnection type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[ExpressRouteCrossConnection]	An instance of LROPoller that returns ExpressRouteCrossConnection. The ExpressRouteCrossConnection is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_get_circuit_migration_info

Gets migration health information for an express route circuit cross connection.

begin_get_circuit_migration_info(resource_group_name: str, cross_connection_name: str, parameters: _models.MigrateExpressRouteCircuitValidateAndHealthCheckRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.MigrateExpressRouteCircuitHealthCheckResponse]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cross_connection_name Required	str The name of the ExpressRouteCrossConnection (service key of the circuit). Required.
parameters Required	MigrateExpressRouteCircuitValidateAndHealthCheckRequest or MigrateExpressRouteCircuitValidateAndHealthCheckRequest or IO[bytes] Parameters supplied to get express route circuit migration information. Is either a MigrateExpressRouteCircuitValidateAndHealthCheckRequest type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[MigrateExpressRouteCircuitHealthCheckResponse]	An instance of LROPoller that returns MigrateExpressRouteCircuitHealthCheckResponse. The MigrateExpressRouteCircuitHealthCheckResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_list_arp_table

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

begin_list_arp_table(resource_group_name: str, cross_connection_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. The name is case insensitive. Required.
cross_connection_name Required	str The name of the ExpressRouteCrossConnection (service key of the 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 ExpressRouteCircuitsArpTableListResult. The ExpressRouteCircuitsArpTableListResult is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_list_routes_table

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

begin_list_routes_table(resource_group_name: str, cross_connection_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. The name is case insensitive. Required.
cross_connection_name Required	str The name of the ExpressRouteCrossConnection (service key of the 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 ExpressRouteCircuitsRoutesTableListResult. The ExpressRouteCircuitsRoutesTableListResult is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_list_routes_table_summary

Gets the route table summary associated with the express route cross connection in a resource group.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cross_connection_name Required	str The name of the ExpressRouteCrossConnection (service key of the 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[ExpressRouteCrossConnectionsRoutesTableSummaryListResult]	An instance of LROPoller that returns ExpressRouteCrossConnectionsRoutesTableSummaryListResult. The ExpressRouteCrossConnectionsRoutesTableSummaryListResult is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_migrate_circuit

Executes the express route circuit migration for a cross connection.

begin_migrate_circuit(resource_group_name: str, cross_connection_name: str, parameters: _models.MigrateExpressRouteCircuitRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.MigrateExpressRouteCircuitHealthCheckResponse]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cross_connection_name Required	str The name of the ExpressRouteCrossConnection (service key of the circuit). Required.
parameters Required	MigrateExpressRouteCircuitRequest or MigrateExpressRouteCircuitRequest or IO[bytes] Parameters supplied to execute the express route circuit migration. Is either a MigrateExpressRouteCircuitRequest type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[MigrateExpressRouteCircuitHealthCheckResponse]	An instance of LROPoller that returns MigrateExpressRouteCircuitHealthCheckResponse. The MigrateExpressRouteCircuitHealthCheckResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_prepare_circuit_migration

Prepares an express route circuit migration for a cross connection.

begin_prepare_circuit_migration(resource_group_name: str, cross_connection_name: str, parameters: _models.MigrateExpressRouteCircuitRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.MigrateExpressRouteCircuitHealthCheckResponse]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cross_connection_name Required	str The name of the ExpressRouteCrossConnection (service key of the circuit). Required.
parameters Required	MigrateExpressRouteCircuitRequest or MigrateExpressRouteCircuitRequest or IO[bytes] Parameters supplied to prepare the express route circuit migration. Is either a MigrateExpressRouteCircuitRequest type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[MigrateExpressRouteCircuitHealthCheckResponse]	An instance of LROPoller that returns MigrateExpressRouteCircuitHealthCheckResponse. The MigrateExpressRouteCircuitHealthCheckResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_restore_bgp_for_circuit_migration

Restores BGP sessions as part of an express route circuit migration for a cross connection.

begin_restore_bgp_for_circuit_migration(resource_group_name: str, cross_connection_name: str, parameters: _models.MigrateExpressRouteCircuitRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.MigrateExpressRouteCircuitHealthCheckResponse]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cross_connection_name Required	str The name of the ExpressRouteCrossConnection (service key of the circuit). Required.
parameters Required	MigrateExpressRouteCircuitRequest or MigrateExpressRouteCircuitRequest or IO[bytes] Parameters supplied to restore BGP for the express route circuit migration. Is either a MigrateExpressRouteCircuitRequest type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[MigrateExpressRouteCircuitHealthCheckResponse]	An instance of LROPoller that returns MigrateExpressRouteCircuitHealthCheckResponse. The MigrateExpressRouteCircuitHealthCheckResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_rollback_circuit_migration

Rolls back the express route circuit migration for a cross connection.

begin_rollback_circuit_migration(resource_group_name: str, cross_connection_name: str, parameters: _models.MigrateExpressRouteCircuitRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.MigrateExpressRouteCircuitHealthCheckResponse]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cross_connection_name Required	str The name of the ExpressRouteCrossConnection (service key of the circuit). Required.
parameters Required	MigrateExpressRouteCircuitRequest or MigrateExpressRouteCircuitRequest or IO[bytes] Parameters supplied to roll back the express route circuit migration. Is either a MigrateExpressRouteCircuitRequest type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[MigrateExpressRouteCircuitHealthCheckResponse]	An instance of LROPoller that returns MigrateExpressRouteCircuitHealthCheckResponse. The MigrateExpressRouteCircuitHealthCheckResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_shut_down_bgp_for_circuit_migration

Shuts down BGP sessions as part of an express route circuit migration for a cross connection.

begin_shut_down_bgp_for_circuit_migration(resource_group_name: str, cross_connection_name: str, parameters: _models.MigrateExpressRouteCircuitRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.MigrateExpressRouteCircuitHealthCheckResponse]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cross_connection_name Required	str The name of the ExpressRouteCrossConnection (service key of the circuit). Required.
parameters Required	MigrateExpressRouteCircuitRequest or MigrateExpressRouteCircuitRequest or IO[bytes] Parameters supplied to shut down BGP for the express route circuit migration. Is either a MigrateExpressRouteCircuitRequest type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[MigrateExpressRouteCircuitHealthCheckResponse]	An instance of LROPoller that returns MigrateExpressRouteCircuitHealthCheckResponse. The MigrateExpressRouteCircuitHealthCheckResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_validate_circuit_migration

Validates express route circuit migration for a cross connection.

begin_validate_circuit_migration(resource_group_name: str, cross_connection_name: str, parameters: _models.MigrateExpressRouteCircuitValidateAndHealthCheckRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.MigrateExpressRouteCircuitValidateResponse]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cross_connection_name Required	str The name of the ExpressRouteCrossConnection (service key of the circuit). Required.
parameters Required	MigrateExpressRouteCircuitValidateAndHealthCheckRequest or MigrateExpressRouteCircuitValidateAndHealthCheckRequest or IO[bytes] Parameters supplied to validate express route circuit migration. Is either a MigrateExpressRouteCircuitValidateAndHealthCheckRequest type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[MigrateExpressRouteCircuitValidateResponse]	An instance of LROPoller that returns MigrateExpressRouteCircuitValidateResponse. The MigrateExpressRouteCircuitValidateResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get

Gets details about the specified ExpressRouteCrossConnection.

get(resource_group_name: str, cross_connection_name: str, **kwargs: Any) -> ExpressRouteCrossConnection

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cross_connection_name Required	str The name of the ExpressRouteCrossConnection (service key of the circuit). Required.

Returns

Type	Description
ExpressRouteCrossConnection	ExpressRouteCrossConnection. The ExpressRouteCrossConnection is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list

Retrieves all the ExpressRouteCrossConnections in a subscription.

list(*, filter: str | None = None, **kwargs: Any) -> ItemPaged[ExpressRouteCrossConnection]

Keyword-Only Parameters

Name	Description
filter	str The filter to apply on the operation. For example, you can use $filter=name eq '{circuitServiceKey}'. Default value is None. Default value: None

Returns

Type	Description
ItemPaged[ExpressRouteCrossConnection]	An iterator like instance of ExpressRouteCrossConnection

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Retrieves all the ExpressRouteCrossConnections in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> ItemPaged[ExpressRouteCrossConnection]

Parameters

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

Returns

Type	Description
ItemPaged[ExpressRouteCrossConnection]	An iterator like instance of ExpressRouteCrossConnection

Exceptions

Type	Description
HttpResponseError

update_tags

Updates an express route cross connection tags.

update_tags(resource_group_name: str, cross_connection_name: str, cross_connection_parameters: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ExpressRouteCrossConnection

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cross_connection_name Required	str The name of the ExpressRouteCrossConnection (service key of the circuit). Required.
cross_connection_parameters Required	TagsObject or TagsObject or IO[bytes] Parameters supplied to update express route cross connection tags. Is either a TagsObject type or a IO[bytes] type. Required.

Returns

Type	Description
ExpressRouteCrossConnection	ExpressRouteCrossConnection. The ExpressRouteCrossConnection is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

意見反應

此頁面對您有幫助嗎？