LoadBalancersOperations interface

Package:
@azure/arm-network

Interface representing a LoadBalancers operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginListInboundNatRulePortMappings
beginListInboundNatRulePortMappingsAndWait
beginSwapPublicIpAddresses
beginSwapPublicIpAddressesAndWait
createOrUpdate

Creates or updates a load balancer.
delete

Deletes the specified load balancer.
get

Gets the specified load balancer.
list

Gets all the load balancers in a resource group.
listAll

Gets all the load balancers in a subscription.
listInboundNatRulePortMappings

List of inbound NAT rule port mappings.
migrateToIpBased

Migrate load balancer to IP Based
swapPublicIpAddresses

Swaps VIPs between two load balancers.
updateTags

Updates a load balancer tags.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginListInboundNatRulePortMappings

Warning

This API is now deprecated.

use listInboundNatRulePortMappings instead

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

Property Value

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

beginListInboundNatRulePortMappingsAndWait

Warning

This API is now deprecated.

use listInboundNatRulePortMappings instead

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

Property Value

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

beginSwapPublicIpAddresses

Warning

This API is now deprecated.

use swapPublicIpAddresses instead

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

Property Value

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

beginSwapPublicIpAddressesAndWait

Warning

This API is now deprecated.

use swapPublicIpAddresses instead

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

Property Value

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

createOrUpdate

Creates or updates a load balancer.

createOrUpdate: (resourceGroupName: string, loadBalancerName: string, parameters: LoadBalancer, options?: LoadBalancersCreateOrUpdateOptionalParams) => PollerLike<OperationState<LoadBalancer>, LoadBalancer>

Property Value

(resourceGroupName: string, loadBalancerName: string, parameters: LoadBalancer, options?: LoadBalancersCreateOrUpdateOptionalParams) => PollerLike<OperationState<LoadBalancer>, LoadBalancer>

delete

Deletes the specified load balancer.

delete: (resourceGroupName: string, loadBalancerName: string, options?: LoadBalancersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, loadBalancerName: string, options?: LoadBalancersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets the specified load balancer.

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

Property Value

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

list

Gets all the load balancers in a resource group.

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

Property Value

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

listAll

Gets all the load balancers in a subscription.

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

Property Value

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

listInboundNatRulePortMappings

List of inbound NAT rule port mappings.

listInboundNatRulePortMappings: (groupName: string, loadBalancerName: string, backendPoolName: string, parameters: QueryInboundNatRulePortMappingRequest, options?: LoadBalancersListInboundNatRulePortMappingsOptionalParams) => PollerLike<OperationState<BackendAddressInboundNatRulePortMappings>, BackendAddressInboundNatRulePortMappings>

Property Value

(groupName: string, loadBalancerName: string, backendPoolName: string, parameters: QueryInboundNatRulePortMappingRequest, options?: LoadBalancersListInboundNatRulePortMappingsOptionalParams) => PollerLike<OperationState<BackendAddressInboundNatRulePortMappings>, BackendAddressInboundNatRulePortMappings>

migrateToIpBased

Migrate load balancer to IP Based

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

Property Value

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

swapPublicIpAddresses

Swaps VIPs between two load balancers.

swapPublicIpAddresses: (location: string, parameters: LoadBalancerVipSwapRequest, options?: LoadBalancersSwapPublicIpAddressesOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(location: string, parameters: LoadBalancerVipSwapRequest, options?: LoadBalancersSwapPublicIpAddressesOptionalParams) => PollerLike<OperationState<void>, void>

updateTags

Updates a load balancer tags.

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

Property Value

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