NatGateways interface

Package:

@azure/arm-network

Interface representing a NatGateways.

Methods

beginCreateOrUpdate(string, string, NatGateway, NatGatewaysCreateOrUpdateOptionalParams)	Creates or updates a nat gateway.
beginCreateOrUpdateAndWait(string, string, NatGateway, NatGatewaysCreateOrUpdateOptionalParams)	Creates or updates a nat gateway.
beginDelete(string, string, NatGatewaysDeleteOptionalParams)	Deletes the specified nat gateway.
beginDeleteAndWait(string, string, NatGatewaysDeleteOptionalParams)	Deletes the specified nat gateway.
get(string, string, NatGatewaysGetOptionalParams)	Gets the specified nat gateway in a specified resource group.
list(string, NatGatewaysListOptionalParams)	Gets all nat gateways in a resource group.
listAll(NatGatewaysListAllOptionalParams)	Gets all the Nat Gateways in a subscription.
updateTags(string, string, TagsObject, NatGatewaysUpdateTagsOptionalParams)	Updates nat gateway tags.

Method Details

beginCreateOrUpdate(string, string, NatGateway, NatGatewaysCreateOrUpdateOptionalParams)

Creates or updates a nat gateway.

function beginCreateOrUpdate(resourceGroupName: string, natGatewayName: string, parameters: NatGateway, options?: NatGatewaysCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NatGateway>, NatGateway>>

Parameters

resourceGroupName

string

The name of the resource group.

natGatewayName

string

The name of the nat gateway.

parameters

NatGateway

Parameters supplied to the create or update nat gateway operation.

options

NatGatewaysCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, NatGateway, NatGatewaysCreateOrUpdateOptionalParams)

Creates or updates a nat gateway.

function beginCreateOrUpdateAndWait(resourceGroupName: string, natGatewayName: string, parameters: NatGateway, options?: NatGatewaysCreateOrUpdateOptionalParams): Promise<NatGateway>

Parameters

resourceGroupName

string

The name of the resource group.

natGatewayName

string

The name of the nat gateway.

parameters

NatGateway

Parameters supplied to the create or update nat gateway operation.

options

NatGatewaysCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<NatGateway>

beginDelete(string, string, NatGatewaysDeleteOptionalParams)

Deletes the specified nat gateway.

function beginDelete(resourceGroupName: string, natGatewayName: string, options?: NatGatewaysDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

natGatewayName

string

The name of the nat gateway.

options

NatGatewaysDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, NatGatewaysDeleteOptionalParams)

Deletes the specified nat gateway.

function beginDeleteAndWait(resourceGroupName: string, natGatewayName: string, options?: NatGatewaysDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

natGatewayName

string

The name of the nat gateway.

options

NatGatewaysDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, NatGatewaysGetOptionalParams)

Gets the specified nat gateway in a specified resource group.

function get(resourceGroupName: string, natGatewayName: string, options?: NatGatewaysGetOptionalParams): Promise<NatGateway>

Parameters

resourceGroupName

string

The name of the resource group.

natGatewayName

string

The name of the nat gateway.

options

NatGatewaysGetOptionalParams

The options parameters.

Returns

Promise<NatGateway>

list(string, NatGatewaysListOptionalParams)

Gets all nat gateways in a resource group.

function list(resourceGroupName: string, options?: NatGatewaysListOptionalParams): PagedAsyncIterableIterator<NatGateway, NatGateway[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

options

NatGatewaysListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NatGateway, NatGateway[], PageSettings>

listAll(NatGatewaysListAllOptionalParams)

Gets all the Nat Gateways in a subscription.

function listAll(options?: NatGatewaysListAllOptionalParams): PagedAsyncIterableIterator<NatGateway, NatGateway[], PageSettings>

Parameters

options

NatGatewaysListAllOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NatGateway, NatGateway[], PageSettings>

updateTags(string, string, TagsObject, NatGatewaysUpdateTagsOptionalParams)

Updates nat gateway tags.

function updateTags(resourceGroupName: string, natGatewayName: string, parameters: TagsObject, options?: NatGatewaysUpdateTagsOptionalParams): Promise<NatGateway>

Parameters

resourceGroupName

string

The name of the resource group.

natGatewayName

string

The name of the nat gateway.

parameters

TagsObject

Parameters supplied to update nat gateway tags.

options

NatGatewaysUpdateTagsOptionalParams

The options parameters.

Returns

Promise<NatGateway>