exec.azurerm.network.load_balancer

Azure Resource Manager (ARM) Network Load Balancer Execution Module

New in version 1.0.0.

Changed in version 4.0.0.

maintainer:

<devops@eitr.tech>
configuration:

This module requires Azure Resource Manager credentials to be passed as keyword arguments to every function or via acct in order to work properly.

Required provider parameters:

if using username and password:
  • subscription_id
  • username
  • password
if using a service principal:
  • subscription_id
  • tenant
  • client_id
  • secret

Optional provider parameters:

cloud_environment: Used to point the cloud driver to different API endpoints, such as Azure GovCloud. Possible values:

  • AZURE_PUBLIC_CLOUD (default)
  • AZURE_CHINA_CLOUD
  • AZURE_US_GOV_CLOUD
  • AZURE_GERMAN_CLOUD
idem_azurerm.exec.azurerm.network.load_balancer.create_or_update(hub, ctx, name, resource_group, **kwargs)

New in version 1.0.0.

Create or update a load balancer within a specified resource group.

Parameters:
  • name – The name of the load balancer to create.
  • resource_group – The resource group name assigned to the load balancer.

CLI Example:

azurerm.network.load_balancer.create_or_update test_name test_group
idem_azurerm.exec.azurerm.network.load_balancer.delete(hub, ctx, name, resource_group, **kwargs)

New in version 1.0.0.

Deletes the specified load balancer.

Parameters:
  • name – The name of the load balancer to delete.
  • resource_group – The resource group name assigned to the load balancer.

CLI Example:

azurerm.network.load_balancer.delete test_name test_group
idem_azurerm.exec.azurerm.network.load_balancer.get(hub, ctx, name, resource_group, **kwargs)

New in version 1.0.0.

Get details about a specific load balancer.

Parameters:
  • name – The name of the load balancer to query.
  • resource_group – The resource group name assigned to the load balancer.

CLI Example:

azurerm.network.load_balancer.get test_name test_group
idem_azurerm.exec.azurerm.network.load_balancer.list_(hub, ctx, resource_group=None, **kwargs)

New in version 1.0.0.

Changed in version 4.0.0.

List all load balancers within a subscription.

Parameters:resource_group – The name of the resource group to limit the results.

CLI Example:

azurerm.network.load_balancer.list
idem_azurerm.exec.azurerm.network.load_balancer.update_tags(hub, ctx, name, resource_group, tags=None, **kwargs)

New in version 4.0.0.

Updates a load balancer tags.

Parameters:
  • name – The name of the load balancer.
  • resource_group – The resource group of the load balancer.
  • tags – The resource tags to update.

CLI Example:

azurerm.network.load_balancer.update_tags test_name test_group test_tags