LoadBalancers interface

  • Reference
Package:
@azure/arm-network-profile-2020-09-01-hybrid

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.
beginUpdateTags(string, string, TagsObject, LoadBalancersUpdateTagsOptionalParams)

Updates a load balancer tags.
beginUpdateTagsAndWait(string, string, TagsObject, LoadBalancersUpdateTagsOptionalParams)

Updates a load balancer tags.
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.

Method Details

beginCreateOrUpdate(string, string, LoadBalancer, LoadBalancersCreateOrUpdateOptionalParams)

Creates or updates a load balancer.

function beginCreateOrUpdate(resourceGroupName: string, loadBalancerName: string, parameters: LoadBalancer, options?: LoadBalancersCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<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<PollerLike<@azure/core-lro.PollOperationState<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<PollerLike<PollOperationState<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<PollerLike<@azure/core-lro.PollOperationState<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>

beginUpdateTags(string, string, TagsObject, LoadBalancersUpdateTagsOptionalParams)

Updates a load balancer tags.

function beginUpdateTags(resourceGroupName: string, loadBalancerName: string, parameters: TagsObject, options?: LoadBalancersUpdateTagsOptionalParams): Promise<PollerLike<PollOperationState<LoadBalancer>, 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<PollerLike<@azure/core-lro.PollOperationState<LoadBalancer>, LoadBalancer>>

beginUpdateTagsAndWait(string, string, TagsObject, LoadBalancersUpdateTagsOptionalParams)

Updates a load balancer tags.

function beginUpdateTagsAndWait(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>

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>