ExpressRouteGatewaysOperations Class

ExpressRouteGatewaysOperations async 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

ExpressRouteGatewaysOperations

Constructor

ExpressRouteGatewaysOperations(client, config, serializer, deserializer) -> None

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 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.
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: azure.mgmt.network.v2018_08_01.models._models_py3.ExpressRouteGateway, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.ExpressRouteGateway')]

Parameters

resource_group_name

str

Required

The name of the resource group.

express_route_gateway_name

str

Required

The name of the ExpressRoute gateway.

put_express_route_gateway_parameters

ExpressRouteGateway

Required

Parameters required in an ExpressRoute gateway PUT 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 AsyncPollingMethod

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 AsyncLROPoller that returns either ExpressRouteGateway or the result of cls(response)

Return type

AsyncLROPoller[ExpressRouteGateway]

Exceptions

~azure.core.exceptions.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) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

Parameters

resource_group_name

str

Required

The name of the resource group.

express_route_gateway_name

str

Required

The name of the ExpressRoute gateway.

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 AsyncPollingMethod

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

Return type

AsyncLROPoller[None]

Exceptions

~azure.core.exceptions.HttpResponseError

get

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

get(resource_group_name: str, express_route_gateway_name: str, **kwargs) -> azure.mgmt.network.v2018_08_01.models._models_py3.ExpressRouteGateway

Parameters

resource_group_name

str

Required

The name of the resource group.

express_route_gateway_name

str

Required

The name of the ExpressRoute gateway.

cls

callable

Required

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

Returns

ExpressRouteGateway, or the result of cls(response)

Return type

ExpressRouteGateway

Exceptions

~azure.core.exceptions.HttpResponseError

list_by_resource_group

Lists ExpressRoute gateways in a given resource group.

list_by_resource_group(resource_group_name: str, **kwargs) -> azure.mgmt.network.v2018_08_01.models._models_py3.ExpressRouteGatewayList

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

ExpressRouteGatewayList, or the result of cls(response)

Return type

ExpressRouteGatewayList

Exceptions

~azure.core.exceptions.HttpResponseError

list_by_subscription

Lists ExpressRoute gateways under a given subscription.

list_by_subscription(**kwargs) -> azure.mgmt.network.v2018_08_01.models._models_py3.ExpressRouteGatewayList

Parameters

cls

callable

Required

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

Returns

ExpressRouteGatewayList, or the result of cls(response)

Return type

ExpressRouteGatewayList

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