load_balancers

Creates, updates, deletes, gets or lists a load_balancers resource.

Overview

Name	load_balancers
Type	Resource
Id	azure.container_service.load_balancers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
allowServicePlacement	boolean	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	object	Nodes that match this selector will be possible members of this load balancer.
primaryAgentPoolName	string	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. Required.
provisioningState	string	The current provisioning state.
serviceLabelSelector	object	Only services that must match this selector can be placed on this load balancer.
serviceNamespaceSelector	object	Services created in namespaces that match the selector can be placed on this load balancer.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_managed_cluster

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
allowServicePlacement	boolean	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	object	Nodes that match this selector will be possible members of this load balancer.
primaryAgentPoolName	string	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. Required.
provisioningState	string	The current provisioning state.
serviceLabelSelector	object	Only services that must match this selector can be placed on this load balancer.
serviceNamespaceSelector	object	Services created in namespaces that match the selector can be placed on this load balancer.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_name, load_balancer_name, subscription_id		Gets the specified load balancer.
list_by_managed_cluster	select	resource_group_name, resource_name, subscription_id		Gets a list of load balancers in the specified managed cluster.
create_or_update	insert	resource_group_name, resource_name, load_balancer_name, subscription_id		Creates or updates a load balancer in the specified managed cluster.
create_or_update	replace	resource_group_name, resource_name, load_balancer_name, subscription_id		Creates or updates a load balancer in the specified managed cluster.
delete	delete	resource_group_name, resource_name, load_balancer_name, subscription_id		Deletes a load balancer in the specified managed cluster.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
load_balancer_name	string	The name of the load balancer. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the managed cluster resource. Required.
subscription_id	string

SELECT examples

get

Gets the specified load balancer.

SELECT
id,
name,
allowServicePlacement,
nodeSelector,
primaryAgentPoolName,
provisioningState,
serviceLabelSelector,
serviceNamespaceSelector,
systemData,
type
FROM azure.container_service.load_balancers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND load_balancer_name = '{{ load_balancer_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_managed_cluster

Gets a list of load balancers in the specified managed cluster.

SELECT
id,
name,
allowServicePlacement,
nodeSelector,
primaryAgentPoolName,
provisioningState,
serviceLabelSelector,
serviceNamespaceSelector,
systemData,
type
FROM azure.container_service.load_balancers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a load balancer in the specified managed cluster.

INSERT INTO azure.container_service.load_balancers (
properties,
resource_group_name,
resource_name,
load_balancer_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ load_balancer_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: load_balancers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the load_balancers resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the load_balancers resource.
  - name: load_balancer_name
    value: "{{ load_balancer_name }}"
    description: Required parameter for the load_balancers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the load_balancers resource.
  - name: properties
    description: |
      The properties of the load balancer.
    value:
      primaryAgentPoolName: "{{ primaryAgentPoolName }}"
      allowServicePlacement: {{ allowServicePlacement }}
      serviceLabelSelector:
        matchLabels:
          - "{{ matchLabels }}"
        matchExpressions:
          - key: "{{ key }}"
            operator: "{{ operator }}"
            values: "{{ values }}"
      serviceNamespaceSelector:
        matchLabels:
          - "{{ matchLabels }}"
        matchExpressions:
          - key: "{{ key }}"
            operator: "{{ operator }}"
            values: "{{ values }}"
      nodeSelector:
        matchLabels:
          - "{{ matchLabels }}"
        matchExpressions:
          - key: "{{ key }}"
            operator: "{{ operator }}"
            values: "{{ values }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates or updates a load balancer in the specified managed cluster.

REPLACE azure.container_service.load_balancers
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND load_balancer_name = '{{ load_balancer_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a load balancer in the specified managed cluster.

DELETE FROM azure.container_service.load_balancers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND load_balancer_name = '{{ load_balancer_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;