LocalNetworkGateways interface

Package:

@azure/arm-network

Interface representing a LocalNetworkGateways.

Methods

beginCreateOrUpdate(string, string, LocalNetworkGateway, LocalNetworkGatewaysCreateOrUpdateOptionalParams)	Creates or updates a local network gateway in the specified resource group.
beginCreateOrUpdateAndWait(string, string, LocalNetworkGateway, LocalNetworkGatewaysCreateOrUpdateOptionalParams)	Creates or updates a local network gateway in the specified resource group.
beginDelete(string, string, LocalNetworkGatewaysDeleteOptionalParams)	Deletes the specified local network gateway.
beginDeleteAndWait(string, string, LocalNetworkGatewaysDeleteOptionalParams)	Deletes the specified local network gateway.
get(string, string, LocalNetworkGatewaysGetOptionalParams)	Gets the specified local network gateway in a resource group.
list(string, LocalNetworkGatewaysListOptionalParams)	Gets all the local network gateways in a resource group.
updateTags(string, string, TagsObject, LocalNetworkGatewaysUpdateTagsOptionalParams)	Updates a local network gateway tags.

Method Details

beginCreateOrUpdate(string, string, LocalNetworkGateway, LocalNetworkGatewaysCreateOrUpdateOptionalParams)

Creates or updates a local network gateway in the specified resource group.

function beginCreateOrUpdate(resourceGroupName: string, localNetworkGatewayName: string, parameters: LocalNetworkGateway, options?: LocalNetworkGatewaysCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<LocalNetworkGateway>, LocalNetworkGateway>>

Parameters

resourceGroupName

string

The name of the resource group.

localNetworkGatewayName

string

The name of the local network gateway.

parameters

LocalNetworkGateway

Parameters supplied to the create or update local network gateway operation.

options

LocalNetworkGatewaysCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, LocalNetworkGateway, LocalNetworkGatewaysCreateOrUpdateOptionalParams)

Creates or updates a local network gateway in the specified resource group.

function beginCreateOrUpdateAndWait(resourceGroupName: string, localNetworkGatewayName: string, parameters: LocalNetworkGateway, options?: LocalNetworkGatewaysCreateOrUpdateOptionalParams): Promise<LocalNetworkGateway>

Parameters

resourceGroupName

string

The name of the resource group.

localNetworkGatewayName

string

The name of the local network gateway.

parameters

LocalNetworkGateway

Parameters supplied to the create or update local network gateway operation.

options

LocalNetworkGatewaysCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<LocalNetworkGateway>

beginDelete(string, string, LocalNetworkGatewaysDeleteOptionalParams)

Deletes the specified local network gateway.

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

Parameters

resourceGroupName

string

The name of the resource group.

localNetworkGatewayName

string

The name of the local network gateway.

options

LocalNetworkGatewaysDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, LocalNetworkGatewaysDeleteOptionalParams)

Deletes the specified local network gateway.

function beginDeleteAndWait(resourceGroupName: string, localNetworkGatewayName: string, options?: LocalNetworkGatewaysDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

localNetworkGatewayName

string

The name of the local network gateway.

options

LocalNetworkGatewaysDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, LocalNetworkGatewaysGetOptionalParams)

Gets the specified local network gateway in a resource group.

function get(resourceGroupName: string, localNetworkGatewayName: string, options?: LocalNetworkGatewaysGetOptionalParams): Promise<LocalNetworkGateway>

Parameters

resourceGroupName

string

The name of the resource group.

localNetworkGatewayName

string

The name of the local network gateway.

options

LocalNetworkGatewaysGetOptionalParams

The options parameters.

Returns

Promise<LocalNetworkGateway>

list(string, LocalNetworkGatewaysListOptionalParams)

Gets all the local network gateways in a resource group.

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

Parameters

resourceGroupName

string

The name of the resource group.

options

LocalNetworkGatewaysListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<LocalNetworkGateway, LocalNetworkGateway[], PageSettings>

updateTags(string, string, TagsObject, LocalNetworkGatewaysUpdateTagsOptionalParams)

Updates a local network gateway tags.

function updateTags(resourceGroupName: string, localNetworkGatewayName: string, parameters: TagsObject, options?: LocalNetworkGatewaysUpdateTagsOptionalParams): Promise<LocalNetworkGateway>

Parameters

resourceGroupName

string

The name of the resource group.

localNetworkGatewayName

string

The name of the local network gateway.

parameters

TagsObject

Parameters supplied to update local network gateway tags.

options

LocalNetworkGatewaysUpdateTagsOptionalParams

The options parameters.

Returns

Promise<LocalNetworkGateway>