Share via

ExpressRouteGatewaysOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:express_route_gateways> attribute.

Inheritance
builtins.object
ExpressRouteGatewaysOperations

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_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. Required.
express_route_gateway_name
Required
str

The name of the ExpressRoute gateway. Required.
put_express_route_gateway_parameters
Required
ExpressRouteGateway or IO[bytes]

Parameters required in an ExpressRoute gateway PUT operation. Is either a ExpressRouteGateway type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[ExpressRouteGateway]

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

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. 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 either None or the result of cls(response)

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 resource group name of the ExpressRouteGateway. Required.
express_route_gateway_name
Required
str

The name of the gateway. Required.
express_route_gateway_parameters
Required
TagsObject or IO[bytes]

Parameters supplied to update a virtual wan express route gateway tags. Is either a TagsObject type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[ExpressRouteGateway]

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

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. Required.
express_route_gateway_name
Required
str

The name of the ExpressRoute gateway. Required.

Returns

Type Description
ExpressRouteGateway

ExpressRouteGateway or the result of cls(response)

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. Required.

Returns

Type Description
ExpressRouteGatewayList

ExpressRouteGatewayList or the result of cls(response)

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 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'>