NatRules interface

Package:

@azure/arm-network

Interface representing a NatRules.

Methods

beginCreateOrUpdate(string, string, string, VpnGatewayNatRule, NatRulesCreateOrUpdateOptionalParams)	Creates a nat rule to a scalable vpn gateway if it doesn't exist else updates the existing nat rules.
beginCreateOrUpdateAndWait(string, string, string, VpnGatewayNatRule, NatRulesCreateOrUpdateOptionalParams)	Creates a nat rule to a scalable vpn gateway if it doesn't exist else updates the existing nat rules.
beginDelete(string, string, string, NatRulesDeleteOptionalParams)	Deletes a nat rule.
beginDeleteAndWait(string, string, string, NatRulesDeleteOptionalParams)	Deletes a nat rule.
get(string, string, string, NatRulesGetOptionalParams)	Retrieves the details of a nat ruleGet.
listByVpnGateway(string, string, NatRulesListByVpnGatewayOptionalParams)	Retrieves all nat rules for a particular virtual wan vpn gateway.

Method Details

beginCreateOrUpdate(string, string, string, VpnGatewayNatRule, NatRulesCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdate(resourceGroupName: string, gatewayName: string, natRuleName: string, natRuleParameters: VpnGatewayNatRule, options?: NatRulesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VpnGatewayNatRule>, VpnGatewayNatRule>>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

natRuleName

string

The name of the nat rule.

natRuleParameters

VpnGatewayNatRule

Parameters supplied to create or Update a Nat Rule.

options

NatRulesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VpnGatewayNatRule>, VpnGatewayNatRule>>

beginCreateOrUpdateAndWait(string, string, string, VpnGatewayNatRule, NatRulesCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdateAndWait(resourceGroupName: string, gatewayName: string, natRuleName: string, natRuleParameters: VpnGatewayNatRule, options?: NatRulesCreateOrUpdateOptionalParams): Promise<VpnGatewayNatRule>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

natRuleName

string

The name of the nat rule.

natRuleParameters

VpnGatewayNatRule

Parameters supplied to create or Update a Nat Rule.

options

NatRulesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<VpnGatewayNatRule>

beginDelete(string, string, string, NatRulesDeleteOptionalParams)

Deletes a nat rule.

function beginDelete(resourceGroupName: string, gatewayName: string, natRuleName: string, options?: NatRulesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

natRuleName

string

The name of the nat rule.

options

NatRulesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, NatRulesDeleteOptionalParams)

Deletes a nat rule.

function beginDeleteAndWait(resourceGroupName: string, gatewayName: string, natRuleName: string, options?: NatRulesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

natRuleName

string

The name of the nat rule.

options

NatRulesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, NatRulesGetOptionalParams)

Retrieves the details of a nat ruleGet.

function get(resourceGroupName: string, gatewayName: string, natRuleName: string, options?: NatRulesGetOptionalParams): Promise<VpnGatewayNatRule>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

natRuleName

string

The name of the nat rule.

options

NatRulesGetOptionalParams

The options parameters.

Returns

Promise<VpnGatewayNatRule>

listByVpnGateway(string, string, NatRulesListByVpnGatewayOptionalParams)

Retrieves all nat rules for a particular virtual wan vpn gateway.

function listByVpnGateway(resourceGroupName: string, gatewayName: string, options?: NatRulesListByVpnGatewayOptionalParams): PagedAsyncIterableIterator<VpnGatewayNatRule, VpnGatewayNatRule[], PageSettings>

Parameters

resourceGroupName

string

The resource group name of the VpnGateway.

gatewayName

string

The name of the gateway.

options

NatRulesListByVpnGatewayOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VpnGatewayNatRule, VpnGatewayNatRule[], PageSettings>