ExpressRouteGatewaysOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:express_route_gateways> attribute.

Constructor

ExpressRouteGatewaysOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates a ExpressRoute gateway in a specified resource group.
begin_delete	Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources.
begin_get_failover_all_tests_details	Retrieves the details of all the failover tests performed on the ExpressRoute gateway for different peering locations.
begin_get_failover_single_test_details	Retrieves the details of a particular failover test performed on the ExpressRoute gateway based on the test Guid.
begin_get_resiliency_information	Retrieves the resiliency information for the ExpressRoute gateway.
begin_get_routes_information	Retrieves the route sets information for the ExpressRoute gateway.
begin_start_site_failover_test	Starts failover simulation on the ExpressRoute gateway for the specified peering location.
begin_stop_site_failover_test	Stops failover simulation on the ExpressRoute gateway for the specified peering location.
begin_update_tags	Updates express route gateway tags.
get	Fetches the details of a ExpressRoute gateway in a resource group.
list_by_resource_group	Lists ExpressRoute gateways in a given resource group.
list_by_subscription	Lists ExpressRoute gateways under a given subscription.

begin_create_or_update

Creates or updates a ExpressRoute gateway in a specified resource group.

begin_create_or_update(resource_group_name: str, express_route_gateway_name: str, put_express_route_gateway_parameters: _models.ExpressRouteGateway, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ExpressRouteGateway]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
express_route_gateway_name Required	str The name of the ExpressRoute gateway. Required.
put_express_route_gateway_parameters Required	ExpressRouteGateway or <xref:JSON> or IO[bytes] Parameters required in an ExpressRoute gateway PUT operation. Is one of the following types: ExpressRouteGateway, JSON, IO[bytes] Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources.

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

Parameters

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

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

Exceptions

Type	Description
HttpResponseError

begin_get_failover_all_tests_details

Retrieves the details of all the failover tests performed on the ExpressRoute gateway for different peering locations.

begin_get_failover_all_tests_details(resource_group_name: str, express_route_gateway_name: str, *, type: str | None = None, fetch_latest: bool | None = None, **kwargs: Any) -> LROPoller[list[azure.mgmt.network.models._models.ExpressRouteFailoverTestDetails]]

Parameters

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

Keyword-Only Parameters

Name	Description
type	str The type of failover test. Default value is None. Default value: None
fetch_latest	bool Fetch only the latest tests for each peering location. Default value is None. Default value: None

Returns

Type	Description
LROPoller[list[ExpressRouteFailoverTestDetails]]	An instance of LROPoller that returns list of ExpressRouteFailoverTestDetails

Exceptions

Type	Description
HttpResponseError

begin_get_failover_single_test_details

Retrieves the details of a particular failover test performed on the ExpressRoute gateway based on the test Guid.

begin_get_failover_single_test_details(resource_group_name: str, express_route_gateway_name: str, *, peering_location: str, failover_test_id: str, **kwargs: Any) -> LROPoller[list[azure.mgmt.network.models._models.ExpressRouteFailoverSingleTestDetails]]

Parameters

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

Keyword-Only Parameters

Name	Description
peering_location	str Peering location of the test. Required.
failover_test_id	str The unique Guid value which identifies the test. Required.

Returns

Type	Description
LROPoller[list[ExpressRouteFailoverSingleTestDetails]]	An instance of LROPoller that returns list of ExpressRouteFailoverSingleTestDetails

Exceptions

Type	Description
HttpResponseError

begin_get_resiliency_information

Retrieves the resiliency information for the ExpressRoute gateway.

begin_get_resiliency_information(resource_group_name: str, express_route_gateway_name: str, *, attempt_refresh: bool | None = None, **kwargs: Any) -> LROPoller[GatewayResiliencyInformation]

Parameters

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

Keyword-Only Parameters

Name	Description
attempt_refresh	bool Whether to attempt a refresh of the resiliency information. Default value is None. Default value: None

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_get_routes_information

Retrieves the route sets information for the ExpressRoute gateway.

begin_get_routes_information(resource_group_name: str, express_route_gateway_name: str, *, attempt_refresh: bool | None = None, **kwargs: Any) -> LROPoller[GatewayRouteSetsInformation]

Parameters

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

Keyword-Only Parameters

Name	Description
attempt_refresh	bool Whether to attempt a refresh of the route sets. Default value is None. Default value: None

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_start_site_failover_test

Starts failover simulation on the ExpressRoute gateway for the specified peering location.

begin_start_site_failover_test(resource_group_name: str, express_route_gateway_name: str, *, peering_location: str, **kwargs: Any) -> LROPoller[str]

Parameters

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

Keyword-Only Parameters

Name	Description
peering_location	str Peering location of the test. Required.

Returns

Type	Description
LROPoller[str]	An instance of LROPoller that returns str

Exceptions

Type	Description
HttpResponseError

begin_stop_site_failover_test

Stops failover simulation on the ExpressRoute gateway for the specified peering location.

begin_stop_site_failover_test(resource_group_name: str, express_route_gateway_name: str, stop_parameters: _models.ExpressRouteFailoverStopApiParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[str]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
express_route_gateway_name Required	str The name of the ExpressRoute gateway. Required.
stop_parameters Required	ExpressRouteFailoverStopApiParameters or <xref:JSON> or IO[bytes] Parameters supplied to stop the failover simulation on the express route gateway. Is one of the following types: ExpressRouteFailoverStopApiParameters, JSON, IO[bytes] Required.

Returns

Type	Description
LROPoller[str]	An instance of LROPoller that returns str

Exceptions

Type	Description
HttpResponseError

begin_update_tags

Updates express route gateway tags.

begin_update_tags(resource_group_name: str, express_route_gateway_name: str, express_route_gateway_parameters: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ExpressRouteGateway]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
express_route_gateway_name Required	str The name of the ExpressRoute gateway. Required.
express_route_gateway_parameters Required	TagsObject or <xref:JSON> or IO[bytes] Parameters supplied to update a virtual wan express route gateway tags. Is one of the following types: TagsObject, JSON, IO[bytes] Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Fetches the details of a ExpressRoute gateway in a resource group.

get(resource_group_name: str, express_route_gateway_name: str, **kwargs: Any) -> ExpressRouteGateway

Parameters

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

Returns

Type	Description
ExpressRouteGateway	ExpressRouteGateway. The ExpressRouteGateway is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Lists ExpressRoute gateways in a given resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> ExpressRouteGatewayList

Parameters

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

Returns

Type	Description
ExpressRouteGatewayList	ExpressRouteGatewayList. The ExpressRouteGatewayList is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list_by_subscription

Lists ExpressRoute gateways under a given subscription.

list_by_subscription(**kwargs: Any) -> ExpressRouteGatewayList

Returns

Type	Description
ExpressRouteGatewayList	ExpressRouteGatewayList. The ExpressRouteGatewayList is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Commenti e suggerimenti

Questa pagina è stata utile?