LoadBalancers interface

Package:

@azure/arm-network

Interface representing a LoadBalancers.

Methods

beginCreateOrUpdate(string, string, LoadBalancer, LoadBalancersCreateOrUpdateOptionalParams)	Creates or updates a load balancer.
beginCreateOrUpdateAndWait(string, string, LoadBalancer, LoadBalancersCreateOrUpdateOptionalParams)	Creates or updates a load balancer.
beginDelete(string, string, LoadBalancersDeleteOptionalParams)	Deletes the specified load balancer.
beginDeleteAndWait(string, string, LoadBalancersDeleteOptionalParams)	Deletes the specified load balancer.
beginListInboundNatRulePortMappings(string, string, string, QueryInboundNatRulePortMappingRequest, LoadBalancersListInboundNatRulePortMappingsOptionalParams)	List of inbound NAT rule port mappings.
beginListInboundNatRulePortMappingsAndWait(string, string, string, QueryInboundNatRulePortMappingRequest, LoadBalancersListInboundNatRulePortMappingsOptionalParams)	List of inbound NAT rule port mappings.
beginSwapPublicIpAddresses(string, LoadBalancerVipSwapRequest, LoadBalancersSwapPublicIpAddressesOptionalParams)	Swaps VIPs between two load balancers.
beginSwapPublicIpAddressesAndWait(string, LoadBalancerVipSwapRequest, LoadBalancersSwapPublicIpAddressesOptionalParams)	Swaps VIPs between two load balancers.
get(string, string, LoadBalancersGetOptionalParams)	Gets the specified load balancer.
list(string, LoadBalancersListOptionalParams)	Gets all the load balancers in a resource group.
listAll(LoadBalancersListAllOptionalParams)	Gets all the load balancers in a subscription.
migrateToIpBased(string, string, LoadBalancersMigrateToIpBasedOptionalParams)	Migrate load balancer to IP Based
updateTags(string, string, TagsObject, LoadBalancersUpdateTagsOptionalParams)	Updates a load balancer tags.

Method Details

beginCreateOrUpdate(string, string, LoadBalancer, LoadBalancersCreateOrUpdateOptionalParams)

Creates or updates a load balancer.

function beginCreateOrUpdate(resourceGroupName: string, loadBalancerName: string, parameters: LoadBalancer, options?: LoadBalancersCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<LoadBalancer>, LoadBalancer>>

Parameters

resourceGroupName

string

The name of the resource group.

loadBalancerName

string

The name of the load balancer.

parameters

LoadBalancer

Parameters supplied to the create or update load balancer operation.

options

LoadBalancersCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, LoadBalancer, LoadBalancersCreateOrUpdateOptionalParams)

Creates or updates a load balancer.

function beginCreateOrUpdateAndWait(resourceGroupName: string, loadBalancerName: string, parameters: LoadBalancer, options?: LoadBalancersCreateOrUpdateOptionalParams): Promise<LoadBalancer>

Parameters

resourceGroupName

string

The name of the resource group.

loadBalancerName

string

The name of the load balancer.

parameters

LoadBalancer

Parameters supplied to the create or update load balancer operation.

options

LoadBalancersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<LoadBalancer>

beginDelete(string, string, LoadBalancersDeleteOptionalParams)

Deletes the specified load balancer.

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

Parameters

resourceGroupName

string

The name of the resource group.

loadBalancerName

string

The name of the load balancer.

options

LoadBalancersDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, LoadBalancersDeleteOptionalParams)

Deletes the specified load balancer.

function beginDeleteAndWait(resourceGroupName: string, loadBalancerName: string, options?: LoadBalancersDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

loadBalancerName

string

The name of the load balancer.

options

LoadBalancersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginListInboundNatRulePortMappings(string, string, string, QueryInboundNatRulePortMappingRequest, LoadBalancersListInboundNatRulePortMappingsOptionalParams)

List of inbound NAT rule port mappings.

function beginListInboundNatRulePortMappings(groupName: string, loadBalancerName: string, backendPoolName: string, parameters: QueryInboundNatRulePortMappingRequest, options?: LoadBalancersListInboundNatRulePortMappingsOptionalParams): Promise<SimplePollerLike<OperationState<BackendAddressInboundNatRulePortMappings>, BackendAddressInboundNatRulePortMappings>>

Parameters

groupName

string

The name of the resource group.

loadBalancerName

string

The name of the load balancer.

backendPoolName

string

The name of the load balancer backend address pool.

parameters

QueryInboundNatRulePortMappingRequest

Query inbound NAT rule port mapping request.

options

LoadBalancersListInboundNatRulePortMappingsOptionalParams

The options parameters.

Returns

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

beginListInboundNatRulePortMappingsAndWait(string, string, string, QueryInboundNatRulePortMappingRequest, LoadBalancersListInboundNatRulePortMappingsOptionalParams)

List of inbound NAT rule port mappings.

function beginListInboundNatRulePortMappingsAndWait(groupName: string, loadBalancerName: string, backendPoolName: string, parameters: QueryInboundNatRulePortMappingRequest, options?: LoadBalancersListInboundNatRulePortMappingsOptionalParams): Promise<BackendAddressInboundNatRulePortMappings>

Parameters

groupName

string

The name of the resource group.

loadBalancerName

string

The name of the load balancer.

backendPoolName

string

The name of the load balancer backend address pool.

parameters

QueryInboundNatRulePortMappingRequest

Query inbound NAT rule port mapping request.

options

LoadBalancersListInboundNatRulePortMappingsOptionalParams

The options parameters.

Returns

Promise<BackendAddressInboundNatRulePortMappings>

beginSwapPublicIpAddresses(string, LoadBalancerVipSwapRequest, LoadBalancersSwapPublicIpAddressesOptionalParams)

Swaps VIPs between two load balancers.

function beginSwapPublicIpAddresses(location: string, parameters: LoadBalancerVipSwapRequest, options?: LoadBalancersSwapPublicIpAddressesOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

location

string

The region where load balancers are located at.

parameters

LoadBalancerVipSwapRequest

Parameters that define which VIPs should be swapped.

options

LoadBalancersSwapPublicIpAddressesOptionalParams

The options parameters.

Returns

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

beginSwapPublicIpAddressesAndWait(string, LoadBalancerVipSwapRequest, LoadBalancersSwapPublicIpAddressesOptionalParams)

Swaps VIPs between two load balancers.

function beginSwapPublicIpAddressesAndWait(location: string, parameters: LoadBalancerVipSwapRequest, options?: LoadBalancersSwapPublicIpAddressesOptionalParams): Promise<void>

Parameters

location

string

The region where load balancers are located at.

parameters

LoadBalancerVipSwapRequest

Parameters that define which VIPs should be swapped.

options

LoadBalancersSwapPublicIpAddressesOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, LoadBalancersGetOptionalParams)

Gets the specified load balancer.

function get(resourceGroupName: string, loadBalancerName: string, options?: LoadBalancersGetOptionalParams): Promise<LoadBalancer>

Parameters

resourceGroupName

string

The name of the resource group.

loadBalancerName

string

The name of the load balancer.

options

LoadBalancersGetOptionalParams

The options parameters.

Returns

Promise<LoadBalancer>

list(string, LoadBalancersListOptionalParams)

Gets all the load balancers in a resource group.

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

Parameters

resourceGroupName

string

The name of the resource group.

options

LoadBalancersListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<LoadBalancer, LoadBalancer[], PageSettings>

listAll(LoadBalancersListAllOptionalParams)

Gets all the load balancers in a subscription.

function listAll(options?: LoadBalancersListAllOptionalParams): PagedAsyncIterableIterator<LoadBalancer, LoadBalancer[], PageSettings>

Parameters

options

LoadBalancersListAllOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<LoadBalancer, LoadBalancer[], PageSettings>

migrateToIpBased(string, string, LoadBalancersMigrateToIpBasedOptionalParams)

Migrate load balancer to IP Based

function migrateToIpBased(groupName: string, loadBalancerName: string, options?: LoadBalancersMigrateToIpBasedOptionalParams): Promise<MigratedPools>

Parameters

groupName

string

The name of the resource group.

loadBalancerName

string

The name of the load balancer.

options

LoadBalancersMigrateToIpBasedOptionalParams

The options parameters.

Returns

Promise<MigratedPools>

updateTags(string, string, TagsObject, LoadBalancersUpdateTagsOptionalParams)

Updates a load balancer tags.

function updateTags(resourceGroupName: string, loadBalancerName: string, parameters: TagsObject, options?: LoadBalancersUpdateTagsOptionalParams): Promise<LoadBalancer>

Parameters

resourceGroupName

string

The name of the resource group.

loadBalancerName

string

The name of the load balancer.

parameters

TagsObject

Parameters supplied to update load balancer tags.

options

LoadBalancersUpdateTagsOptionalParams

The options parameters.

Returns

Promise<LoadBalancer>