VirtualNetworkGatewayNatRules interface

Package:

@azure/arm-network

Interface representing a VirtualNetworkGatewayNatRules.

Methods

beginCreateOrUpdate(string, string, string, VirtualNetworkGatewayNatRule, VirtualNetworkGatewayNatRulesCreateOrUpdateOptionalParams)	Creates a nat rule to a scalable virtual network gateway if it doesn't exist else updates the existing nat rules.
beginCreateOrUpdateAndWait(string, string, string, VirtualNetworkGatewayNatRule, VirtualNetworkGatewayNatRulesCreateOrUpdateOptionalParams)	Creates a nat rule to a scalable virtual network gateway if it doesn't exist else updates the existing nat rules.
beginDelete(string, string, string, VirtualNetworkGatewayNatRulesDeleteOptionalParams)	Deletes a nat rule.
beginDeleteAndWait(string, string, string, VirtualNetworkGatewayNatRulesDeleteOptionalParams)	Deletes a nat rule.
get(string, string, string, VirtualNetworkGatewayNatRulesGetOptionalParams)	Retrieves the details of a nat rule.
listByVirtualNetworkGateway(string, string, VirtualNetworkGatewayNatRulesListByVirtualNetworkGatewayOptionalParams)	Retrieves all nat rules for a particular virtual network gateway.

Method Details

beginCreateOrUpdate(string, string, string, VirtualNetworkGatewayNatRule, VirtualNetworkGatewayNatRulesCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdate(resourceGroupName: string, virtualNetworkGatewayName: string, natRuleName: string, natRuleParameters: VirtualNetworkGatewayNatRule, options?: VirtualNetworkGatewayNatRulesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewayNatRule>, VirtualNetworkGatewayNatRule>>

Parameters

resourceGroupName

string

The resource group name of the Virtual Network Gateway.

virtualNetworkGatewayName

string

The name of the gateway.

natRuleName

string

The name of the nat rule.

natRuleParameters

VirtualNetworkGatewayNatRule

Parameters supplied to create or Update a Nat Rule.

options

VirtualNetworkGatewayNatRulesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, VirtualNetworkGatewayNatRule, VirtualNetworkGatewayNatRulesCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdateAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, natRuleName: string, natRuleParameters: VirtualNetworkGatewayNatRule, options?: VirtualNetworkGatewayNatRulesCreateOrUpdateOptionalParams): Promise<VirtualNetworkGatewayNatRule>

Parameters

resourceGroupName

string

The resource group name of the Virtual Network Gateway.

virtualNetworkGatewayName

string

The name of the gateway.

natRuleName

string

The name of the nat rule.

natRuleParameters

VirtualNetworkGatewayNatRule

Parameters supplied to create or Update a Nat Rule.

options

VirtualNetworkGatewayNatRulesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<VirtualNetworkGatewayNatRule>

beginDelete(string, string, string, VirtualNetworkGatewayNatRulesDeleteOptionalParams)

Deletes a nat rule.

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

Parameters

resourceGroupName

string

The resource group name of the Virtual Network Gateway.

virtualNetworkGatewayName

string

The name of the gateway.

natRuleName

string

The name of the nat rule.

options

VirtualNetworkGatewayNatRulesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, VirtualNetworkGatewayNatRulesDeleteOptionalParams)

Deletes a nat rule.

function beginDeleteAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, natRuleName: string, options?: VirtualNetworkGatewayNatRulesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name of the Virtual Network Gateway.

virtualNetworkGatewayName

string

The name of the gateway.

natRuleName

string

The name of the nat rule.

options

VirtualNetworkGatewayNatRulesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, VirtualNetworkGatewayNatRulesGetOptionalParams)

Retrieves the details of a nat rule.

function get(resourceGroupName: string, virtualNetworkGatewayName: string, natRuleName: string, options?: VirtualNetworkGatewayNatRulesGetOptionalParams): Promise<VirtualNetworkGatewayNatRule>

Parameters

resourceGroupName

string

The resource group name of the Virtual Network Gateway.

virtualNetworkGatewayName

string

The name of the gateway.

natRuleName

string

The name of the nat rule.

options

VirtualNetworkGatewayNatRulesGetOptionalParams

The options parameters.

Returns

Promise<VirtualNetworkGatewayNatRule>

listByVirtualNetworkGateway(string, string, VirtualNetworkGatewayNatRulesListByVirtualNetworkGatewayOptionalParams)

Retrieves all nat rules for a particular virtual network gateway.

function listByVirtualNetworkGateway(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewayNatRulesListByVirtualNetworkGatewayOptionalParams): PagedAsyncIterableIterator<VirtualNetworkGatewayNatRule, VirtualNetworkGatewayNatRule[], PageSettings>

Parameters

resourceGroupName

string

The resource group name of the virtual network gateway.

virtualNetworkGatewayName

string

The name of the gateway.

options

VirtualNetworkGatewayNatRulesListByVirtualNetworkGatewayOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualNetworkGatewayNatRule, VirtualNetworkGatewayNatRule[], PageSettings>