Share via

LocalNetworkGatewaysOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:local_network_gateways> attribute.

Inheritance
builtins.object
LocalNetworkGatewaysOperations

Constructor

LocalNetworkGatewaysOperations(*args, **kwargs)

Methods

begin_create_or_update

Creates or updates a local network gateway in the specified resource group.
begin_delete

Deletes the specified local network gateway.
get

Gets the specified local network gateway in a resource group.
list

Gets all the local network gateways in a resource group.
update_tags

Updates a local network gateway tags.

begin_create_or_update

Creates or updates a local network gateway in the specified resource group.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
local_network_gateway_name
Required
str

The name of the local network gateway. Required.
parameters
Required
LocalNetworkGateway or IO[bytes]

Parameters supplied to the create or update local network gateway operation. Is either a LocalNetworkGateway type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[LocalNetworkGateway]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes the specified local network gateway.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
local_network_gateway_name
Required
str

The name of the local network 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

get

Gets the specified local network gateway in a resource group.

get(resource_group_name: str, local_network_gateway_name: str, **kwargs: Any) -> LocalNetworkGateway

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
local_network_gateway_name
Required
str

The name of the local network gateway. Required.

Returns

Type Description
LocalNetworkGateway

LocalNetworkGateway or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Gets all the local network gateways in a resource group.

list(resource_group_name: str, **kwargs: Any) -> Iterable[LocalNetworkGateway]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.

Returns

Type Description
ItemPaged[LocalNetworkGateway]

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

Exceptions

Type Description
HttpResponseError

update_tags

Updates a local network gateway tags.

update_tags(resource_group_name: str, local_network_gateway_name: str, parameters: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> _models.LocalNetworkGateway

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
local_network_gateway_name
Required
str

The name of the local network gateway. Required.
parameters
Required
TagsObject or IO[bytes]

Parameters supplied to update local network gateway tags. Is either a TagsObject type or a IO[bytes] type. Required.

Returns

Type Description
LocalNetworkGateway

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