load_balancer_backend_address_pools

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

Overview

Name	load_balancer_backend_address_pools
Type	Resource
Id	azure.network.load_balancer_backend_address_pools

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns LoadBalancer BackendAddressPool resource.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of load balancer backend address pool.
type	string	Type of the resource.

list

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

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of load balancer backend address pool.
type	string	Type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, loadBalancerName, backendAddressPoolName, subscriptionId		Gets load balancer backend address pool.
list	select	resourceGroupName, loadBalancerName, subscriptionId		Gets all the load balancer backed address pools.
create_or_update	insert	resourceGroupName, loadBalancerName, backendAddressPoolName, subscriptionId		Creates or updates a load balancer backend address pool.
delete	delete	resourceGroupName, loadBalancerName, backendAddressPoolName, subscriptionId		Deletes the specified load balancer backend address pool.

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
backendAddressPoolName	string	The name of the backend address pool.
loadBalancerName	string	The name of the load balancer.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets load balancer backend address pool.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.load_balancer_backend_address_pools
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND loadBalancerName = '{{ loadBalancerName }}' -- required
AND backendAddressPoolName = '{{ backendAddressPoolName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Gets all the load balancer backed address pools.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.load_balancer_backend_address_pools
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND loadBalancerName = '{{ loadBalancerName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a load balancer backend address pool.

INSERT INTO azure.network.load_balancer_backend_address_pools (
data__properties,
data__name,
data__id,
resourceGroupName,
loadBalancerName,
backendAddressPoolName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ id }}',
'{{ resourceGroupName }}',
'{{ loadBalancerName }}',
'{{ backendAddressPoolName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: load_balancer_backend_address_pools
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the load_balancer_backend_address_pools resource.
    - name: loadBalancerName
      value: string
      description: Required parameter for the load_balancer_backend_address_pools resource.
    - name: backendAddressPoolName
      value: string
      description: Required parameter for the load_balancer_backend_address_pools resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the load_balancer_backend_address_pools resource.
    - name: properties
      value: object
      description: |
        Properties of load balancer backend address pool.
    - name: name
      value: string
      description: |
        The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource.
    - name: id
      value: string
      description: |
        Resource ID.

DELETE examples

delete

Deletes the specified load balancer backend address pool.

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