NatRulesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:nat_rules> attribute.
Constructor
NatRulesOperations(*args, **kwargs)Methods
| begin_create_or_update |
Creates a nat rule to a scalable vpn 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 ruleGet. |
| list_by_vpn_gateway |
Retrieves all nat rules for a particular virtual wan vpn gateway. |
begin_create_or_update
Creates a nat rule to a scalable vpn gateway if it doesn't exist else updates the existing nat rules.
begin_create_or_update(resource_group_name: str, gateway_name: str, nat_rule_name: str, nat_rule_parameters: _models.VpnGatewayNatRule, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VpnGatewayNatRule]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The resource group name of the VpnGateway. Required. |
|
gateway_name
Required
|
The name of the gateway. Required. |
|
nat_rule_name
Required
|
The name of the nat rule. Required. |
|
nat_rule_parameters
Required
|
Parameters supplied to create or Update a Nat Rule. Is either a VpnGatewayNatRule type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either VpnGatewayNatRule or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_delete
Deletes a nat rule.
begin_delete(resource_group_name: str, gateway_name: str, nat_rule_name: str, **kwargs: Any) -> LROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The resource group name of the VpnGateway. Required. |
|
gateway_name
Required
|
The name of the gateway. Required. |
|
nat_rule_name
Required
|
The name of the nat rule. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Retrieves the details of a nat ruleGet.
get(resource_group_name: str, gateway_name: str, nat_rule_name: str, **kwargs: Any) -> VpnGatewayNatRuleParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The resource group name of the VpnGateway. Required. |
|
gateway_name
Required
|
The name of the gateway. Required. |
|
nat_rule_name
Required
|
The name of the nat rule. Required. |
Returns
| Type | Description |
|---|---|
|
VpnGatewayNatRule or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_vpn_gateway
Retrieves all nat rules for a particular virtual wan vpn gateway.
list_by_vpn_gateway(resource_group_name: str, gateway_name: str, **kwargs: Any) -> Iterable[VpnGatewayNatRule]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The resource group name of the VpnGateway. Required. |
|
gateway_name
Required
|
The name of the gateway. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either VpnGatewayNatRule or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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'>