NatGatewaysOperations Class

NatGatewaysOperations 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

NatGatewaysOperations

Constructor

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

Parameters

resource_group_name

str

Required

The name of the resource group.

nat_gateway_name

str

Required

The name of the nat gateway.

parameters

NatGateway

Required

Parameters supplied to the create or update nat gateway 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 NatGateway or the result of cls(response)

Return type

AsyncLROPoller[NatGateway]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_delete

Deletes the specified nat gateway.

begin_delete(resource_group_name: str, nat_gateway_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

Parameters

resource_group_name

str

Required

The name of the resource group.

nat_gateway_name

str

Required

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

Gets the specified nat gateway in a specified resource group.

get(resource_group_name: str, nat_gateway_name: str, expand: typing.Union[str, NoneType] = None, **kwargs) -> azure.mgmt.network.v2019_02_01.models._models_py3.NatGateway

Parameters

resource_group_name

str

Required

The name of the resource group.

nat_gateway_name

str

Required

The name of the nat gateway.

expand

str

Required

Expands referenced resources.

cls

callable

Required

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

Returns

NatGateway, or the result of cls(response)

Return type

NatGateway

Exceptions

~azure.core.exceptions.HttpResponseError

list

Gets all nat gateways in a resource group.

list(resource_group_name: str, **kwargs) -> typing.AsyncIterable[_ForwardRef('models.NatGatewayListResult')]

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

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

Return type

AsyncItemPaged[NatGatewayListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

list_all

Gets all the Nat Gateways in a subscription.

list_all(**kwargs) -> typing.AsyncIterable[_ForwardRef('models.NatGatewayListResult')]

Parameters

cls

callable

Required

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

Returns

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

Return type

AsyncItemPaged[NatGatewayListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

update_tags

Updates nat gateway tags.

update_tags(resource_group_name: str, nat_gateway_name: str, parameters: azure.mgmt.network.v2019_02_01.models._models_py3.TagsObject, **kwargs) -> azure.mgmt.network.v2019_02_01.models._models_py3.NatGateway

Parameters

resource_group_name

str

Required

The name of the resource group.

nat_gateway_name

str

Required

The name of the nat gateway.

parameters

TagsObject

Required

Parameters supplied to update nat gateway tags.

cls

callable

Required

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

Returns

NatGateway, or the result of cls(response)

Return type

NatGateway

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

models = <module 'azure.mgmt.network.v2019_02_01.models' from 'c:\\repo\\venv\\lib\\site-packages\\azure\\mgmt\\network\\v2019_02_01\\models\\__init__.py'>