Share via

NatGatewaysOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:nat_gateways> attribute.

Constructor

NatGatewaysOperations(*args, **kwargs)

Methods

begin_create_or_update

Creates or updates a nat gateway.
begin_delete

Deletes the specified nat gateway.
get

Gets the specified nat gateway in a specified resource group.
list

Gets all nat gateways in a resource group.
list_all

Gets all the Nat Gateways in a subscription.
update_tags

Updates nat gateway tags.

begin_create_or_update

Creates or updates a nat gateway.

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

Parameters

Name Description
resource_group_name
Required
str

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

The name of the nat gateway. Required.
parameters
Required
NatGateway or IO[bytes]

Parameters supplied to the create or update nat gateway operation. Is either a NatGateway type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[NatGateway]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes the specified nat gateway.

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

Parameters

Name Description
resource_group_name
Required
str

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

The name of the nat 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 nat gateway in a specified resource group.

get(resource_group_name: str, nat_gateway_name: str, *, expand: str | None = None, **kwargs: Any) -> NatGateway

Parameters

Name Description
resource_group_name
Required
str

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

The name of the nat gateway. Required.

Keyword-Only Parameters

Name Description
expand
str

Expands referenced resources. Default value is None.

Default value: None

Returns

Type Description
NatGateway

NatGateway or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Gets all nat gateways in a resource group.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.

Returns

Type Description
ItemPaged[NatGateway]

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

Exceptions

Type Description
HttpResponseError

list_all

Gets all the Nat Gateways in a subscription.

list_all(**kwargs: Any) -> Iterable[NatGateway]

Returns

Type Description
ItemPaged[NatGateway]

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

Exceptions

Type Description
HttpResponseError

update_tags

Updates nat gateway tags.

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

Parameters

Name Description
resource_group_name
Required
str

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

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

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

Returns

Type Description
NatGateway

NatGateway or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.network.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv177\\Lib\\site-packages\\azure\\mgmt\\network\\models\\__init__.py'>