通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

LoadBalancersOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:load_balancers> attribute.

Constructor

LoadBalancersOperations(*args, **kwargs)

Methods

begin_create_or_update

Creates or updates a load balancer.
begin_delete

Deletes the specified load balancer.
begin_list_inbound_nat_rule_port_mappings

List of inbound NAT rule port mappings.
begin_swap_public_ip_addresses

Swaps VIPs between two load balancers.
get

Gets the specified load balancer.
list

Gets all the load balancers in a resource group.
list_all

Gets all the load balancers in a subscription.
migrate_to_ip_based

Migrate load balancer to IP Based.
update_tags

Updates a load balancer tags.

begin_create_or_update

Creates or updates a load balancer.

begin_create_or_update(resource_group_name: str, load_balancer_name: str, parameters: _models.LoadBalancer, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.LoadBalancer]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
load_balancer_name
Required
str

The name of the load balancer. Required.
parameters
Required
LoadBalancer or IO[bytes]

Parameters supplied to the create or update load balancer operation. Is either a LoadBalancer type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[LoadBalancer]

An instance of LROPoller that returns either LoadBalancer or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes the specified load balancer.

begin_delete(resource_group_name: str, load_balancer_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
load_balancer_name
Required
str

The name of the load balancer. Required.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_list_inbound_nat_rule_port_mappings

List of inbound NAT rule port mappings.

begin_list_inbound_nat_rule_port_mappings(group_name: str, load_balancer_name: str, backend_pool_name: str, parameters: _models.QueryInboundNatRulePortMappingRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.BackendAddressInboundNatRulePortMappings]

Parameters

Name Description
group_name
Required
str

The name of the resource group. Required.
load_balancer_name
Required
str

The name of the load balancer. Required.
backend_pool_name
Required
str

The name of the load balancer backend address pool. Required.
parameters
Required
QueryInboundNatRulePortMappingRequest or IO[bytes]

Query inbound NAT rule port mapping request. Is either a QueryInboundNatRulePortMappingRequest type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[BackendAddressInboundNatRulePortMappings]

An instance of LROPoller that returns either BackendAddressInboundNatRulePortMappings or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_swap_public_ip_addresses

Swaps VIPs between two load balancers.

begin_swap_public_ip_addresses(location: str, parameters: _models.LoadBalancerVipSwapRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
location
Required
str

The region where load balancers are located at. Required.
parameters
Required
LoadBalancerVipSwapRequest or IO[bytes]

Parameters that define which VIPs should be swapped. Is either a LoadBalancerVipSwapRequest type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets the specified load balancer.

get(resource_group_name: str, load_balancer_name: str, *, expand: str | None = None, **kwargs: Any) -> LoadBalancer

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
load_balancer_name
Required
str

The name of the load balancer. Required.

Keyword-Only Parameters

Name Description
expand
str

Expands referenced resources. Default value is None.

Default value: None

Returns

Type Description
LoadBalancer

LoadBalancer or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Gets all the load balancers in a resource group.

list(resource_group_name: str, **kwargs: Any) -> Iterable[LoadBalancer]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.

Returns

Type Description
ItemPaged[LoadBalancer]

An iterator like instance of either LoadBalancer or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_all

Gets all the load balancers in a subscription.

list_all(**kwargs: Any) -> Iterable[LoadBalancer]

Returns

Type Description
ItemPaged[LoadBalancer]

An iterator like instance of either LoadBalancer or the result of cls(response)

Exceptions

Type Description
HttpResponseError

migrate_to_ip_based

Migrate load balancer to IP Based.

migrate_to_ip_based(group_name: str, load_balancer_name: str, parameters: _models.MigrateLoadBalancerToIpBasedRequest | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.MigratedPools

Parameters

Name Description
group_name
Required
str

The name of the resource group. Required.
load_balancer_name
Required
str

The name of the load balancer. Required.
parameters
MigrateLoadBalancerToIpBasedRequest or IO[bytes]

Parameters supplied to the migrateToIpBased Api. Is either a MigrateLoadBalancerToIpBasedRequest type or a IO[bytes] type. Default value is None.

Default value: None

Returns

Type Description
MigratedPools

MigratedPools or the result of cls(response)

Exceptions

Type Description
HttpResponseError

update_tags

Updates a load balancer tags.

update_tags(resource_group_name: str, load_balancer_name: str, parameters: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> _models.LoadBalancer

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
load_balancer_name
Required
str

The name of the load balancer. Required.
parameters
Required
TagsObject or IO[bytes]

Parameters supplied to update load balancer tags. Is either a TagsObject type or a IO[bytes] type. Required.

Returns

Type Description
LoadBalancer

LoadBalancer or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.network.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv177\\Lib\\site-packages\\azure\\mgmt\\network\\models\\__init__.py'>