VirtualNetworkGatewayNatRulesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:virtual_network_gateway_nat_rules> attribute.

Inheritance

builtins.object

VirtualNetworkGatewayNatRulesOperations

Constructor

VirtualNetworkGatewayNatRulesOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates a nat rule to a scalable virtual network gateway if it doesn't exist else updates the existing nat rules.
begin_delete	Deletes a nat rule.
get	Retrieves the details of a nat rule.
list_by_virtual_network_gateway	Retrieves all nat rules for a particular virtual network gateway.

begin_create_or_update

Creates a nat rule to a scalable virtual network gateway if it doesn't exist else updates the existing nat rules.

begin_create_or_update(resource_group_name: str, virtual_network_gateway_name: str, nat_rule_name: str, nat_rule_parameters: _models.VirtualNetworkGatewayNatRule, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualNetworkGatewayNatRule]

Parameters

Name	Description
resource_group_name Required	str The resource group name of the Virtual Network Gateway. Required.
virtual_network_gateway_name Required	str The name of the gateway. Required.
nat_rule_name Required	str The name of the nat rule. Required.
nat_rule_parameters Required	VirtualNetworkGatewayNatRule or IO[bytes] Parameters supplied to create or Update a Nat Rule. Is either a VirtualNetworkGatewayNatRule type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[VirtualNetworkGatewayNatRule]	An instance of LROPoller that returns either VirtualNetworkGatewayNatRule or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a nat rule.

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

Parameters

Name	Description
resource_group_name Required	str The resource group name of the Virtual Network Gateway. Required.
virtual_network_gateway_name Required	str The name of the gateway. Required.
nat_rule_name Required	str The name of the nat rule. 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

Retrieves the details of a nat rule.

get(resource_group_name: str, virtual_network_gateway_name: str, nat_rule_name: str, **kwargs: Any) -> VirtualNetworkGatewayNatRule

Parameters

Name	Description
resource_group_name Required	str The resource group name of the Virtual Network Gateway. Required.
virtual_network_gateway_name Required	str The name of the gateway. Required.
nat_rule_name Required	str The name of the nat rule. Required.

Returns

Type	Description
VirtualNetworkGatewayNatRule	VirtualNetworkGatewayNatRule or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_virtual_network_gateway

Retrieves all nat rules for a particular virtual network gateway.

list_by_virtual_network_gateway(resource_group_name: str, virtual_network_gateway_name: str, **kwargs: Any) -> Iterable[VirtualNetworkGatewayNatRule]

Parameters

Name	Description
resource_group_name Required	str The resource group name of the virtual network gateway. Required.
virtual_network_gateway_name Required	str The name of the gateway. Required.

Returns

Type	Description
ItemPaged[VirtualNetworkGatewayNatRule]	An iterator like instance of either VirtualNetworkGatewayNatRule 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'>