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

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
backendIPConfigurations	array	An array of references to IP addresses defined in network interfaces.
drainPeriodInSeconds	integer	Amount of seconds Load Balancer waits for before sending RESET to client and backend address.
etag	string	A unique read-only string that changes whenever the resource is updated.
inboundNatRules	array	An array of references to inbound NAT rules that use this backend address pool.
loadBalancerBackendAddresses	array	An array of backend addresses.
loadBalancingRules	array	An array of references to load balancing rules that use this backend address pool.
location	string	The location of the backend address pool.
outboundRule	object	Reference to another subresource.
outboundRules	array	An array of references to outbound rules that use this backend address pool.
provisioningState	string	The provisioning state of the backend address pool resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
syncMode	string	Backend address synchronous mode for the backend pool. Known values are: "Automatic" and "Manual". (Automatic, Manual)
tunnelInterfaces	array	An array of gateway load balancer tunnel interfaces.
type	string	Resource type.
virtualNetwork	object	Reference to another subresource.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
backendIPConfigurations	array	An array of references to IP addresses defined in network interfaces.
drainPeriodInSeconds	integer	Amount of seconds Load Balancer waits for before sending RESET to client and backend address.
etag	string	A unique read-only string that changes whenever the resource is updated.
inboundNatRules	array	An array of references to inbound NAT rules that use this backend address pool.
loadBalancerBackendAddresses	array	An array of backend addresses.
loadBalancingRules	array	An array of references to load balancing rules that use this backend address pool.
location	string	The location of the backend address pool.
outboundRule	object	Reference to another subresource.
outboundRules	array	An array of references to outbound rules that use this backend address pool.
provisioningState	string	The provisioning state of the backend address pool resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
syncMode	string	Backend address synchronous mode for the backend pool. Known values are: "Automatic" and "Manual". (Automatic, Manual)
tunnelInterfaces	array	An array of gateway load balancer tunnel interfaces.
type	string	Resource type.
virtualNetwork	object	Reference to another subresource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, load_balancer_name, backend_address_pool_name, subscription_id		Gets load balancer backend address pool.
list	select	resource_group_name, load_balancer_name, subscription_id		Gets all the load balancer backed address pools.
create_or_update	insert	resource_group_name, load_balancer_name, backend_address_pool_name, subscription_id		Creates or updates a load balancer backend address pool.
create_or_update	replace	resource_group_name, load_balancer_name, backend_address_pool_name, subscription_id		Creates or updates a load balancer backend address pool.
delete	delete	resource_group_name, load_balancer_name, backend_address_pool_name, subscription_id		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
backend_address_pool_name	string	The name of the backend address pool. Required.
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.
subscription_id	string

SELECT examples

get

Gets load balancer backend address pool.

SELECT
id,
name,
backendIPConfigurations,
drainPeriodInSeconds,
etag,
inboundNatRules,
loadBalancerBackendAddresses,
loadBalancingRules,
location,
outboundRule,
outboundRules,
provisioningState,
syncMode,
tunnelInterfaces,
type,
virtualNetwork
FROM azure.network.load_balancer_backend_address_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND load_balancer_name = '{{ load_balancer_name }}' -- required
AND backend_address_pool_name = '{{ backend_address_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all the load balancer backed address pools.

SELECT
id,
name,
backendIPConfigurations,
drainPeriodInSeconds,
etag,
inboundNatRules,
loadBalancerBackendAddresses,
loadBalancingRules,
location,
outboundRule,
outboundRules,
provisioningState,
syncMode,
tunnelInterfaces,
type,
virtualNetwork
FROM azure.network.load_balancer_backend_address_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND load_balancer_name = '{{ load_balancer_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a load balancer backend address pool.

INSERT INTO azure.network.load_balancer_backend_address_pools (
id,
name,
properties,
resource_group_name,
load_balancer_name,
backend_address_pool_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ name }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ load_balancer_name }}',
'{{ backend_address_pool_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: load_balancer_backend_address_pools
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the load_balancer_backend_address_pools resource.
  - name: load_balancer_name
    value: "{{ load_balancer_name }}"
    description: Required parameter for the load_balancer_backend_address_pools resource.
  - name: backend_address_pool_name
    value: "{{ backend_address_pool_name }}"
    description: Required parameter for the load_balancer_backend_address_pools resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the load_balancer_backend_address_pools resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource.
  - name: properties
    description: |
      Properties of load balancer backend address pool.
    value:
      location: "{{ location }}"
      tunnelInterfaces:
        - port: {{ port }}
          identifier: {{ identifier }}
          protocol: "{{ protocol }}"
          type: "{{ type }}"
      loadBalancerBackendAddresses:
        - properties:
            virtualNetwork:
              id: "{{ id }}"
            subnet:
              id: "{{ id }}"
            ipAddress: "{{ ipAddress }}"
            networkInterfaceIPConfiguration:
              id: "{{ id }}"
            loadBalancerFrontendIPConfiguration:
              id: "{{ id }}"
            inboundNatRulesPortMapping:
              - inboundNatRuleName: "{{ inboundNatRuleName }}"
                frontendPort: {{ frontendPort }}
                backendPort: {{ backendPort }}
            adminState: "{{ adminState }}"
          name: "{{ name }}"
      backendIPConfigurations:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            gatewayLoadBalancer:
              id: "{{ id }}"
            virtualNetworkTaps:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                location: "{{ location }}"
                tags: "{{ tags }}"
                properties:
                  networkInterfaceTapConfigurations: "{{ networkInterfaceTapConfigurations }}"
                  resourceGuid: "{{ resourceGuid }}"
                  provisioningState: "{{ provisioningState }}"
                  destinationNetworkInterfaceIPConfiguration: "{{ destinationNetworkInterfaceIPConfiguration }}"
                  destinationLoadBalancerFrontEndIPConfiguration: "{{ destinationLoadBalancerFrontEndIPConfiguration }}"
                  destinationPort: {{ destinationPort }}
                etag: "{{ etag }}"
            applicationGatewayBackendAddressPools:
              - id: "{{ id }}"
                properties:
                  backendIPConfigurations: "{{ backendIPConfigurations }}"
                  backendAddresses: "{{ backendAddresses }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
                type: "{{ type }}"
            loadBalancerBackendAddressPools:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                properties:
                  location: "{{ location }}"
                  tunnelInterfaces: "{{ tunnelInterfaces }}"
                  loadBalancerBackendAddresses: "{{ loadBalancerBackendAddresses }}"
                  backendIPConfigurations: "{{ backendIPConfigurations }}"
                  loadBalancingRules: "{{ loadBalancingRules }}"
                  outboundRule: "{{ outboundRule }}"
                  outboundRules: "{{ outboundRules }}"
                  inboundNatRules: "{{ inboundNatRules }}"
                  provisioningState: "{{ provisioningState }}"
                  drainPeriodInSeconds: {{ drainPeriodInSeconds }}
                  virtualNetwork: "{{ virtualNetwork }}"
                  syncMode: "{{ syncMode }}"
                etag: "{{ etag }}"
            loadBalancerInboundNatRules:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                properties:
                  frontendIPConfiguration: "{{ frontendIPConfiguration }}"
                  backendIPConfiguration: "{{ backendIPConfiguration }}"
                  protocol: "{{ protocol }}"
                  frontendPort: {{ frontendPort }}
                  backendPort: {{ backendPort }}
                  idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
                  enableFloatingIP: {{ enableFloatingIP }}
                  enableTcpReset: {{ enableTcpReset }}
                  frontendPortRangeStart: {{ frontendPortRangeStart }}
                  frontendPortRangeEnd: {{ frontendPortRangeEnd }}
                  backendAddressPool: "{{ backendAddressPool }}"
                  provisioningState: "{{ provisioningState }}"
                etag: "{{ etag }}"
            privateIPAddress: "{{ privateIPAddress }}"
            privateIPAddressPrefixLength: {{ privateIPAddressPrefixLength }}
            privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
            privateIPAddressVersion: "{{ privateIPAddressVersion }}"
            subnet:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              properties:
                addressPrefix: "{{ addressPrefix }}"
                addressPrefixes: "{{ addressPrefixes }}"
                networkSecurityGroup: "{{ networkSecurityGroup }}"
                routeTable: "{{ routeTable }}"
                natGateway: "{{ natGateway }}"
                serviceEndpoints: "{{ serviceEndpoints }}"
                serviceEndpointPolicies: "{{ serviceEndpointPolicies }}"
                privateEndpoints: "{{ privateEndpoints }}"
                ipConfigurations: "{{ ipConfigurations }}"
                ipConfigurationProfiles: "{{ ipConfigurationProfiles }}"
                ipAllocations: "{{ ipAllocations }}"
                resourceNavigationLinks: "{{ resourceNavigationLinks }}"
                serviceAssociationLinks: "{{ serviceAssociationLinks }}"
                delegations: "{{ delegations }}"
                purpose: "{{ purpose }}"
                provisioningState: "{{ provisioningState }}"
                privateEndpointNetworkPolicies: "{{ privateEndpointNetworkPolicies }}"
                privateLinkServiceNetworkPolicies: "{{ privateLinkServiceNetworkPolicies }}"
                applicationGatewayIPConfigurations: "{{ applicationGatewayIPConfigurations }}"
                sharingScope: "{{ sharingScope }}"
                defaultOutboundAccess: {{ defaultOutboundAccess }}
                ipamPoolPrefixAllocations: "{{ ipamPoolPrefixAllocations }}"
                serviceGateway: "{{ serviceGateway }}"
              etag: "{{ etag }}"
            primary: {{ primary }}
            publicIPAddress:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                publicIPAllocationMethod: "{{ publicIPAllocationMethod }}"
                publicIPAddressVersion: "{{ publicIPAddressVersion }}"
                ipConfiguration: "{{ ipConfiguration }}"
                dnsSettings: "{{ dnsSettings }}"
                ddosSettings: "{{ ddosSettings }}"
                ipTags: "{{ ipTags }}"
                ipAddress: "{{ ipAddress }}"
                publicIPPrefix: "{{ publicIPPrefix }}"
                idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
                resourceGuid: "{{ resourceGuid }}"
                provisioningState: "{{ provisioningState }}"
                servicePublicIPAddress: "{{ servicePublicIPAddress }}"
                natGateway: "{{ natGateway }}"
                migrationPhase: "{{ migrationPhase }}"
                linkedPublicIPAddress: "{{ linkedPublicIPAddress }}"
                deleteOption: "{{ deleteOption }}"
              extendedLocation:
                name: "{{ name }}"
                type: "{{ type }}"
              sku:
                name: "{{ name }}"
                tier: "{{ tier }}"
              etag: "{{ etag }}"
              zones:
                - "{{ zones }}"
            applicationSecurityGroups:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                location: "{{ location }}"
                tags: "{{ tags }}"
                properties:
                  resourceGuid: "{{ resourceGuid }}"
                  provisioningState: "{{ provisioningState }}"
                etag: "{{ etag }}"
            provisioningState: "{{ provisioningState }}"
            privateLinkConnectionProperties:
              groupId: "{{ groupId }}"
              requiredMemberName: "{{ requiredMemberName }}"
              fqdns:
                - "{{ fqdns }}"
          etag: "{{ etag }}"
      loadBalancingRules:
        - id: "{{ id }}"
      outboundRule:
        id: "{{ id }}"
      outboundRules:
        - id: "{{ id }}"
      inboundNatRules:
        - id: "{{ id }}"
      provisioningState: "{{ provisioningState }}"
      drainPeriodInSeconds: {{ drainPeriodInSeconds }}
      virtualNetwork:
        id: "{{ id }}"
      syncMode: "{{ syncMode }}"

REPLACE examples

create_or_update

Creates or updates a load balancer backend address pool.

REPLACE azure.network.load_balancer_backend_address_pools
SET 
id = '{{ id }}',
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND load_balancer_name = '{{ load_balancer_name }}' --required
AND backend_address_pool_name = '{{ backend_address_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete

Deletes the specified load balancer backend address pool.

DELETE FROM azure.network.load_balancer_backend_address_pools
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND load_balancer_name = '{{ load_balancer_name }}' --required
AND backend_address_pool_name = '{{ backend_address_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;