load_balancers

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

Overview

Name	load_balancers
Type	Resource
Id	azure.network.load_balancers

Fields

The following fields are returned by SELECT queries:

list_inbound_nat_rule_port_mappings

Successful request for query inbound NAT rule port mapping.

Name	Datatype	Description
inboundNatRulePortMappings	array	Collection of inbound NAT rule port mappings.

get

Request successful. The operation returns the resulting LoadBalancer resource.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the load balancer.
properties	object	Properties of load balancer.
sku	object	The load balancer SKU.
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

Request successful. The operation returns a list of LoadBalancer resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the load balancer.
properties	object	Properties of load balancer.
sku	object	The load balancer SKU.
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_all

Request successful. The operation returns a list of LoadBalancer resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the load balancer.
properties	object	Properties of load balancer.
sku	object	The load balancer SKU.
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
list_inbound_nat_rule_port_mappings	select	groupName, loadBalancerName, backendPoolName, subscriptionId		List of inbound NAT rule port mappings.
get	select	resourceGroupName, loadBalancerName, subscriptionId	$expand	Gets the specified load balancer.
list	select	resourceGroupName, subscriptionId		Gets all the load balancers in a resource group.
list_all	select	subscriptionId		Gets all the load balancers in a subscription.
create_or_update	insert	resourceGroupName, loadBalancerName, subscriptionId		Creates or updates a load balancer.
delete	delete	resourceGroupName, loadBalancerName, subscriptionId		Deletes the specified load balancer.
update_tags	exec	resourceGroupName, loadBalancerName, subscriptionId		Updates a load balancer tags.
swap_public_ip_addresses	exec	location, subscriptionId		Swaps VIPs between two load balancers.
migrate_to_ip_based	exec	groupName, loadBalancerName, subscriptionId		Migrate load balancer to IP Based

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
backendPoolName	string	The name of the load balancer backend address pool.
groupName	string	The name of the resource group.
loadBalancerName	string	The name of the load balancer.
location	string	The region where load balancers are located at.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$expand	string	Expands referenced resources.

SELECT examples

list_inbound_nat_rule_port_mappings

List of inbound NAT rule port mappings.

SELECT
inboundNatRulePortMappings
FROM azure.network.load_balancers
WHERE groupName = '{{ groupName }}' -- required
AND loadBalancerName = '{{ loadBalancerName }}' -- required
AND backendPoolName = '{{ backendPoolName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

get

Gets the specified load balancer.

SELECT
id,
name,
etag,
extendedLocation,
properties,
sku,
systemData,
type
FROM azure.network.load_balancers
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND loadBalancerName = '{{ loadBalancerName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list

Gets all the load balancers in a resource group.

SELECT
id,
name,
etag,
extendedLocation,
properties,
sku,
systemData,
type
FROM azure.network.load_balancers
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_all

Gets all the load balancers in a subscription.

SELECT
id,
name,
etag,
extendedLocation,
properties,
sku,
systemData,
type
FROM azure.network.load_balancers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a load balancer.

INSERT INTO azure.network.load_balancers (
data__extendedLocation,
data__sku,
data__properties,
resourceGroupName,
loadBalancerName,
subscriptionId
)
SELECT 
'{{ extendedLocation }}',
'{{ sku }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ loadBalancerName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
extendedLocation,
properties,
sku,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: load_balancers
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the load_balancers resource.
    - name: loadBalancerName
      value: string
      description: Required parameter for the load_balancers resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the load_balancers resource.
    - name: extendedLocation
      value: object
      description: |
        The extended location of the load balancer.
    - name: sku
      value: object
      description: |
        The load balancer SKU.
    - name: properties
      value: object
      description: |
        Properties of load balancer.

DELETE examples

delete

Deletes the specified load balancer.

DELETE FROM azure.network.load_balancers
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND loadBalancerName = '{{ loadBalancerName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

update_tags

Updates a load balancer tags.

EXEC azure.network.load_balancers.update_tags 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@loadBalancerName='{{ loadBalancerName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;

swap_public_ip_addresses

Swaps VIPs between two load balancers.

EXEC azure.network.load_balancers.swap_public_ip_addresses 
@location='{{ location }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"frontendIPConfigurations": "{{ frontendIPConfigurations }}"
}'
;

migrate_to_ip_based

Migrate load balancer to IP Based

EXEC azure.network.load_balancers.migrate_to_ip_based 
@groupName='{{ groupName }}' --required, 
@loadBalancerName='{{ loadBalancerName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"pools": "{{ pools }}"
}'
;