3.1.5.5.2 backendAddressPools

A backendAddressPools resource represents the list of IPs that can receive network traffic that comes via the front-end IPs. The load Balancing MUX handles incoming traffic via the front-end IPs and distributes them to backend IPs based on load balancing configuration.

The URI for the resource is as follows.

 https://<url>/networking/v1/loadBalancers/{parentResourceId}/backendAddressPools/{resourceId}

url: The address or name of the REST server of the Network Controller.

parentResourceId: the identifier for the specific ancestor resource within the resource type. See section 2.2.3.3 for more details.

resourceId: the identifier for the specific descendant resource within the resource type. See section 2.2.3.4 for more details.

Note  The server MAY support additional versions, besides v1 in the URI.

The following HTTP methods can be performed on this resource.

HTTP method

Section

Description

PUT

3.1.5.5.2.1.1

Create a new backendAddressPools resource or update an existing backendAddressPools resource.

GET

3.1.5.5.2.1.2

Get one backendAddressPools resource.

GET ALL

3.1.5.5.2.1.3

List all backendAddressPools resources in the Network Controller.

DELETE

3.1.5.5.2.1.4

Delete a backendAddressPools resource.

The following property elements are valid.

Element name

Type

Description

etag

Read-only

Specified in Common JSON Elements, section 2.2.2.

provisioningState

Read-only

Specified in Common JSON Elements, section 2.2.2.

backendIPConfigurations

Read-only

Indicates an array of references to ipConfigurations resources. There is no restriction on having the same ipConfigurations in multiple backendAddressPools. An IP configuration can become a part of a backendAddressPool by setting a reference to a backendAddressPools resource in the loadBalancerBackendAddressPools array field on the ipConfigurations resource.

loadBalancingRules

Read-only

Indicates an array of references to the set of loadBalancingRules resources that use this backend address pool.

outboundNatRules

Read-only

Indicates an array of references to the set of outboundNatRules resources that use this backend address pool.