load_balancers

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

Overview

Name	load_balancers
Type	Resource
Id	azure.container_orchestrator_runtime.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}. # pylint: disable=line-too-long
name	string	The name of the resource.
addresses	array	IP Range. Required.
advertiseMode	string	Advertise Mode. Required. Known values are: "ARP", "BGP", and "Both". (ARP, BGP, Both)
bgpPeers	array	The list of BGP peers it should advertise to. Null or empty means to advertise to all peers.
provisioningState	string	Resource provision state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
serviceSelector	object	A dynamic label mapping to select related services. For instance, if you want to create a load balancer only for services with label "a=b", then please specify {"a": "b"} in the field.
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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
addresses	array	IP Range. Required.
advertiseMode	string	Advertise Mode. Required. Known values are: "ARP", "BGP", and "Both". (ARP, BGP, Both)
bgpPeers	array	The list of BGP peers it should advertise to. Null or empty means to advertise to all peers.
provisioningState	string	Resource provision state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
serviceSelector	object	A dynamic label mapping to select related services. For instance, if you want to create a load balancer only for services with label "a=b", then please specify {"a": "b"} in the field.
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_uri, load_balancer_name		Get a LoadBalancer.
list	select	resource_uri		List LoadBalancer resources by parent.
create_or_update	insert	resource_uri, load_balancer_name		Create a LoadBalancer.
create_or_update	replace	resource_uri, load_balancer_name		Create a LoadBalancer.
delete	delete	resource_uri, load_balancer_name		Delete a LoadBalancer.

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 LoadBalancer. Required.
resource_uri	string	The fully qualified Azure Resource manager identifier of the resource. Required.

SELECT examples

get

Get a LoadBalancer.

SELECT
id,
name,
addresses,
advertiseMode,
bgpPeers,
provisioningState,
serviceSelector,
systemData,
type
FROM azure.container_orchestrator_runtime.load_balancers
WHERE resource_uri = '{{ resource_uri }}' -- required
AND load_balancer_name = '{{ load_balancer_name }}' -- required
;

list

List LoadBalancer resources by parent.

SELECT
id,
name,
addresses,
advertiseMode,
bgpPeers,
provisioningState,
serviceSelector,
systemData,
type
FROM azure.container_orchestrator_runtime.load_balancers
WHERE resource_uri = '{{ resource_uri }}' -- required
;

INSERT examples

create_or_update

Create a LoadBalancer.

INSERT INTO azure.container_orchestrator_runtime.load_balancers (
properties,
resource_uri,
load_balancer_name
)
SELECT 
'{{ properties }}',
'{{ resource_uri }}',
'{{ load_balancer_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: load_balancers
props:
  - name: resource_uri
    value: "{{ resource_uri }}"
    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: properties
    description: |
      The resource-specific properties for this resource.
    value:
      addresses:
        - "{{ addresses }}"
      serviceSelector: "{{ serviceSelector }}"
      advertiseMode: "{{ advertiseMode }}"
      bgpPeers:
        - "{{ bgpPeers }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Create a LoadBalancer.

REPLACE azure.container_orchestrator_runtime.load_balancers
SET 
properties = '{{ properties }}'
WHERE 
resource_uri = '{{ resource_uri }}' --required
AND load_balancer_name = '{{ load_balancer_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a LoadBalancer.

DELETE FROM azure.container_orchestrator_runtime.load_balancers
WHERE resource_uri = '{{ resource_uri }}' --required
AND load_balancer_name = '{{ load_balancer_name }}' --required
;