states.azurerm.network.public_ip_prefix

Azure Resource Manager (ARM) Network Public IP Prefix State Module

New in version 4.0.0.

maintainer:

<devops@eitr.tech>

configuration:

This module requires Azure Resource Manager credentials to be passed via acct. Note that the authentication parameters are case sensitive.

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

Example acct setup for Azure Resource Manager authentication:

azurerm:
    default:
        subscription_id: 3287abc8-f98a-c678-3bde-326766fd3617
        tenant: ABCDEFAB-1234-ABCD-1234-ABCDEFABCDEF
        client_id: ABCDEFAB-1234-ABCD-1234-ABCDEFABCDEF
        secret: XXXXXXXXXXXXXXXXXXXXXXXX
        cloud_environment: AZURE_PUBLIC_CLOUD
    user_pass_auth:
        subscription_id: 3287abc8-f98a-c678-3bde-326766fd3617
        username: fletch
        password: 123pass

The authentication parameters can also be passed as a dictionary of keyword arguments to the connection_auth parameter of each state, but this is not preferred and could be deprecated in the future.

idem_azurerm.states.azurerm.network.public_ip_prefix.absent(hub, ctx, name, resource_group, connection_auth=None, **kwargs)

New in version 4.0.0.

Ensure a public IP prefix does not exist in the resource group.

Parameters:
  • name – The name of the public IP prefix.
  • resource_group – The resource group assigned to the public IP prefix.
  • connection_auth – A dict with subscription and authentication parameters to be used in connecting to the Azure Resource Manager API.

Example usage:

Ensure public ip prefix absent:
    azurerm.network.public_ip_prefix.absent:
      - name: test_lb
      - resource_group: test_group
idem_azurerm.states.azurerm.network.public_ip_prefix.present(hub, ctx, name, resource_group, prefix_length=None, sku='standard', public_ip_address_version='IPv4', zones=None, tags=None, connection_auth=None, **kwargs)

New in version 4.0.0.

Ensure a public IP prefix exists.

Parameters:
  • name – The name of the public IP prefix.
  • resource_group – The resource group of the public IP prefix.
  • prefix_length – An integer representing the length of the Public IP Prefix. This value is immutable once set. If the value of the public_ip_address_version parameter is “IPv4”, then possible values include 28, 29, 30, 31. If the value of the public_ip_address_version parameter is “IPv6”, then possible values include 124, 125, 126, 127.
  • sku – The name of a public IP prefix SKU. Possible values include: “standard”. Defaults to “standard”.
  • public_ip_address_version – The public IP address version. Possible values include: “IPv4” and “IPv6”. Defaults to “IPv4”.
  • zones – A list of availability zones that denotes where the IP allocated for the resource needs to come from.
  • tags – A dictionary of strings can be passed as tag metadata to the public IP prefix object.
  • connection_auth – A dict with subscription and authentication parameters to be used in connecting to the Azure Resource Manager API.

Example usage:

Ensure public IP prefix exists:
    azurerm.network.public_ip_prefix.present:
        - name: test_prefix
        - resource_group: test_group
        - prefix_length: 28
        - sku: "standard"
        - public_ip_version: "IPv4"
        - tags:
            contact_name: Elmer Fudd Gantry