exec.azurerm.network.public_ip_prefix

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

New 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.public_ip_prefix.create_or_update(hub, ctx, name, resource_group, prefix_length, sku='standard', public_ip_address_version='IPv4', zones=None, **kwargs)

New in version 4.0.0.

Creates or updates a static or dynamic public IP prefix.

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.

CLI Example:

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

New in version 4.0.0.

Deletes the specified public IP prefix.

Parameters:
  • name – The name of the public IP prefix to delete.
  • resource_group – The resource group of the public IP prefix.

CLI Example:

azurerm.network.public_ip_prefix.delete test_name test_group
idem_azurerm.exec.azurerm.network.public_ip_prefix.get(hub, ctx, name, resource_group, expand=None, **kwargs)

New in version 4.0.0.

Gets the specified public IP prefix in a specified resource group.

Parameters:
  • name – The name of the public IP prefix to query.
  • resource_group – The resource group of the public IP prefix.
  • expand – Expands referenced resources.

CLI Example:

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

New in version 4.0.0.

Gets all the public IP prefixes in a subscription.

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

CLI Example:

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

New in version 4.0.0.

Updates public IP prefix tags.

Parameters:
  • name – The name of the public IP prefix.
  • resource_group – The resource group of the public IP prefix.
  • tags – The resource tags to update.

CLI Example:

azurerm.network.public_ip_prefix.update_tags test_name test_group test_tags