azure.azcollection.azure_rm_loadbalancerbackendaddresspool module – Manage a backend address pool of an Azure load balancer

Note

This module is part of the azure.azcollection collection (version 4.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install azure.azcollection. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: azure.azcollection.azure_rm_loadbalancerbackendaddresspool.

New in azure.azcollection 4.0.0

Synopsis

• Create, update or delete a single backend address pool on an existing Azure load balancer.

• The parent module azure.azcollection.azure_rm_loadbalancer only declares empty pool stubs by name.

• This module owns all pool-level properties and members.

Requirements

The below requirements are needed on the host that executes this module.

• python >= 2.7

• The host that executes this module must have the azure.azcollection collection installed via galaxy

• All python packages listed in collection’s requirements.txt must be installed via pip on the host that executes modules from azure.azcollection

• Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters

Parameter	Comments
ad_user string	Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url string added in azure.azcollection 0.0.1	Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string added in azure.azcollection 0.0.1	Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack. Default: "latest"
auth_source string added in azure.azcollection 0.0.1	Controls the source of the credentials to use for authentication. Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable. When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli. When set to env, the credentials will be read from the environment variables. When set to credential_file, it will read the profile from ~/.azure/credentials. When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used. When set to msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen. The msi was added in Ansible 2.6. Choices: "auto" ← (default) "cli" "credential_file" "env" "msi"
cert_validation_mode string added in azure.azcollection 0.0.1	Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable. Choices: "ignore" "validate"
client_id string	Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the AZURE_CLIENT_ID environment variable.
cloud_environment string added in azure.azcollection 0.0.1	For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable. Default: "AzureCloud"
disable_instance_discovery boolean added in azure.azcollection 2.3.0	Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. Set via credential file profile or the AZURE_DISABLE_INSTANCE_DISCOVERY environment variable. Choices: false ← (default) true
drain_period_in_seconds integer	Seconds the load balancer waits before sending RESET to client and backend address on connection close.
load_balancer_backend_addresses list / elements=dictionary	Backend addresses (IP-based or NIC-config-based) for the backend pool. Requires Standard SKU load balancer.
admin_state string	Administrative state which can override health probe results for this backend address. Choices: "None" "Up" "Down"
ip_address string	IP address belonging to the referenced virtual_network.
load_balancer_frontend_ip_configuration string	Resource ID of a regional load balancer frontend IP configuration. Used only when attaching a regional load balancer to a Global cross-region load balancer.
name string / required	Name of the backend address, unique within the pool.
network_interface_ip_configuration string	Resource ID of an existing NIC IP configuration to attach to the pool.
subnet string	Resource ID of the subnet the backend address belongs to.
virtual_network string	Resource ID of the virtual network the backend address belongs to.
load_balancer_name string / required	Name of the parent load balancer.
log_mode string	Parent argument.
log_path string	Parent argument.
name string / required	Name of the backend address pool.
oidc_token string added in azure.azcollection 3.17.0	Direct OpenID Connect (OIDC) token (JWT) used for workload identity authentication. This token is exchanged with Azure AD using OIDC federated identity. Useful in CI systems (for example GitHub Actions, Azure DevOps) where an OIDC token is provided directly by the platform. Can also be set via the AZURE_FEDERATED_TOKEN environment variable.
oidc_token_file_path path added in azure.azcollection 3.17.0	Path to a file containing an OpenID Connect (OIDC) token (JWT) used for workload identity authentication. The file must contain only raw token. This method is commonly used in platforms that materialize OIDC tokens as files Can also be set via the AZURE_FEDERATED_TOKEN_FILE environment variable.
password string	Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile string	Security profile found in ~/.azure/credentials file.
resource_group string / required	Name of the resource group that contains the load balancer.
secret string	Azure client secret. Use when authenticating with a Service Principal.
state string	Assert the state of the backend address pool. Use present to create or update, or absent to delete. Choices: "absent" "present" ← (default)
subscription_id string	Your Azure subscription Id.
sync_mode string	Backend address synchronous mode for the backend pool. Requires Standard SKU load balancer and virtual_network to be set. Choices: "Automatic" "Manual"
tenant string	Azure tenant ID. Use when authenticating with a Service Principal.
thumbprint string added in azure.azcollection 1.14.0	The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined.
tunnel_interfaces list / elements=dictionary	Gateway load balancer tunnel interfaces for the backend address pool.
identifier integer / required	Identifier of the gateway load balancer tunnel interface.
port integer / required	Port of the gateway load balancer tunnel interface.
protocol string / required	Protocol of the gateway load balancer tunnel interface. Choices: "None" "Native" "VXLAN"
type string / required	Traffic type of the gateway load balancer tunnel interface. Choices: "None" "Internal" "External"
virtual_network string	Resource ID of the virtual network the backend address pool is bound to. Required when sync_mode is set.
x509_certificate_path path added in azure.azcollection 1.14.0	Path to the X509 certificate used to create the service principal in PEM format. The certificate must be appended to the private key. Use when authenticating with a Service Principal.

Notes

Note

• For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.

• Authentication is also possible using a service principal or Active Directory user.

• To authenticate via OIDC, pass client_id, tenant and oidc_token or oidc_token_file_path, or set environment variables AZURE_CLIENT_ID, AZURE_TENANT and AZURE_FEDERATED_TOKEN or AZURE_FEDERATED_TOKEN_FILE.

• To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.

• To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.

• Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

See Also

See also

Sign in with Azure CLI

How to authenticate using the az login command.

Examples

- name: Create backend address pool with two IP-based members
  azure_rm_loadbalancerbackendaddresspool:
    resource_group: myResourceGroup
    load_balancer_name: myLoadBalancer
    name: bepool0
    load_balancer_backend_addresses:
      - name: address1
        ip_address: 10.0.0.10
        virtual_network: /subscriptions/xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet
      - name: address2
        ip_address: 10.0.0.11
        virtual_network: /subscriptions/xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet

- name: Attach an existing NIC IP configuration to a backend pool
  azure_rm_loadbalancerbackendaddresspool:
    resource_group: myResourceGroup
    load_balancer_name: myLoadBalancer
    name: bepool0
    load_balancer_backend_addresses:
      - name: web-server1-nic
        network_interface_ip_configuration: >-
          /subscriptions/xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/web1-nic/ipConfigurations/ipconfig1

- name: Delete backend address pool
  azure_rm_loadbalancerbackendaddresspool:
    resource_group: myResourceGroup
    load_balancer_name: myLoadBalancer
    name: bepool0
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
changed boolean	Whether or not the resource has changed. Returned: always
state complex	Current state of the backend address pool. Returned: always
drain_period_in_seconds integer	Drain period in seconds. Returned: when-used
id string	Resource ID of the backend address pool. Returned: always Sample: "/subscriptions/xxx/resourceGroups/myRG/providers/Microsoft.Network/loadBalancers/myLB/backendAddressPools/bepool0"
load_balancer_backend_addresses list / elements=string	List of backend addresses attached to the pool. Returned: always Sample: [{"admin_state": "None", "ip_address": "10.0.0.10", "name": "address1", "virtual_network": "/subscriptions/xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/myVnet"}]
name string	Name of the backend address pool. Returned: always Sample: "bepool0"
provisioning_state string	Provisioning state of the backend address pool. Returned: always Sample: "Succeeded"
sync_mode string	Backend address synchronous mode. Returned: when-used
tunnel_interfaces list / elements=string	Gateway load balancer tunnel interfaces. Returned: when-used
virtual_network string	Resource ID of the virtual network the pool is bound to. Returned: when-used

Authors

• Zun Yang (@zunyangc)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)