LoadBalancer interface

Package:

@azure/arm-containerservice

The configurations regarding multiple standard load balancers. If not supplied, single load balancer mode will be used. Multiple standard load balancers mode will be used if at lease one configuration is supplied. There has to be a configuration named kubernetes. The name field will be the name of the corresponding public load balancer. There will be an internal load balancer created if needed, and the name will be <name>-internal. The internal lb shares the same configurations as the external one. The internal lbs are not needed to be included in LoadBalancer list.

Extends

ProxyResource

Properties

allowServicePlacement	Whether to automatically place services on the load balancer. If not supplied, the default value is true. If set to false manually, both of the external and the internal load balancer will not be selected for services unless they explicitly target it.
nodeSelector	Nodes that match this selector will be possible members of this load balancer.
primaryAgentPoolName	Required field. A string value that must specify the ID of an existing agent pool. All nodes in the given pool will always be added to this load balancer. This agent pool must have at least one node and minCount>=1 for autoscaling operations. An agent pool can only be the primary pool for a single load balancer.
provisioningState	The current provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.
serviceLabelSelector	Only services that must match this selector can be placed on this load balancer.
serviceNamespaceSelector	Services created in namespaces that match the selector can be placed on this load balancer.

Inherited Properties

id	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

allowServicePlacement

Whether to automatically place services on the load balancer. If not supplied, the default value is true. If set to false manually, both of the external and the internal load balancer will not be selected for services unless they explicitly target it.

allowServicePlacement?: boolean

Property Value

boolean

nodeSelector

Nodes that match this selector will be possible members of this load balancer.

nodeSelector?: LabelSelector

Property Value

LabelSelector

primaryAgentPoolName

Required field. A string value that must specify the ID of an existing agent pool. All nodes in the given pool will always be added to this load balancer. This agent pool must have at least one node and minCount>=1 for autoscaling operations. An agent pool can only be the primary pool for a single load balancer.

primaryAgentPoolName?: string

Property Value

string

provisioningState

The current provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

serviceLabelSelector

Only services that must match this selector can be placed on this load balancer.

serviceLabelSelector?: LabelSelector

Property Value

LabelSelector

serviceNamespaceSelector

Services created in namespaces that match the selector can be placed on this load balancer.

serviceNamespaceSelector?: LabelSelector

Property Value

LabelSelector

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type