azure_rm_publicipaddress – Manage Azure Public IP Addresses¶

Synopsis
Requirements
Parameters
Notes
See Also
Examples
Return Values
Status

Synopsis ¶

Create, update and delete a Public IP address.
Allows setting and updating the address allocation method and domain name label.
Use the azure_rm_networkinterface module to associate a Public IP with a network interface.

Requirements ¶

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

python >= 2.7
azure >= 2.0.0

Parameters ¶

Parameter		Choices/Defaults	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 2.6			Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
allocation_method -		Choices: dynamic ← static Static Dynamic	Control whether the assigned Public IP remains permanently assigned to the object. If not set to `Static`, the IP address my changed anytime an associated virtual machine is power cycled.
api_profile string added in 2.5		Default: "latest"	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.
append_tags boolean		Choices: no yes ←	Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata.
auth_source string added in 2.5		Choices: auto cli credential_file env msi	Controls the source of the credentials to use for authentication. If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to `auto` if variable is not defined. `auto` will follow the default precedence of module parameters -> environment variables -> default profile in credential file `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the default Azure CLI profile. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. 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.
cert_validation_mode string added in 2.5		Choices: ignore validate	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.
client_id string			Azure client ID. Use when authenticating with a Service Principal.
cloud_environment string added in 2.4		Default: "AzureCloud"	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.
domain_name -			The customizable portion of the FQDN assigned to public IP address. This is an explicit setting. If no value is provided, any existing value will be removed on an existing public IP. aliases: domain_name_label
idle_timeout integer added in 2.8			Idle timeout in minutes.
ip_tags - added in 2.8			List of IpTag associated with the public IP address. Each element should contain type:value pair.
	type -		Sets the ip_tags type.
	value -		Sets the ip_tags value.
location -			Valid Azure location. Defaults to location of the resource group.
name - / required			Name of the Public IP.
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 - / required			Name of resource group with which the Public IP is associated.
secret string			Azure client secret. Use when authenticating with a Service Principal.
sku - added in 2.6		Choices: basic standard Basic Standard	The public IP address SKU.
state -		Choices: absent present ←	Assert the state of the Public IP. Use `present` to create or update a and `absent` to delete.
subscription_id string			Your Azure subscription Id.
tags dictionary			Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.
tenant string			Azure tenant ID. Use when authenticating with a Service Principal.
version - added in 2.8		Choices: ipv4 ← ipv6	The public IP address version.

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 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.

Examples ¶

- name: Create a public ip address
  azure_rm_publicipaddress:
    resource_group: myResourceGroup
    name: my_public_ip
    allocation_method: static
    domain_name: foobar

- name: Delete public ip
  azure_rm_publicipaddress:
    resource_group: myResourceGroup
    name: my_public_ip
    state: absent

Return Values ¶

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

Key		Returned	Description
state complex		always	Facts about the current state of the object.
	dns_settings dictionary	always	The FQDN of the DNS record associated with the public IP address. Sample: {'domain_name_label': 'ansible-b57dc95985712e45eb8b9c2e', 'fqdn': 'ansible-b57dc95985712e45eb8b9c2e.eastus.cloudapp.azure.com', 'reverse_fqdn': None}
	etag string	always	A unique read-only string that changes whenever the resource is updated. Sample: W/'1905ee13-7623-45b1-bc6b-4a12b2fb9d15'
	idle_timeout_in_minutes integer	always	The idle timeout of the public IP address. Sample: 4
	ip_address string	always	The Public IP Prefix this Public IP Address should be allocated from. Sample: 52.160.103.93
	location string	always	Resource location.
	name string	always	Name of the Public IP Address.
	provisioning_state string	always	The provisioning state of the Public IP resource.
	public_ip_address_version string	always	The public IP address version. Sample: ipv4
	public_ip_allocation_method string	always	The public IP allocation method. Sample: static
	sku string	always	The public IP address SKU. Sample: Basic
	tags dictionary	always	The resource tags. Sample: {'delete': 'on-exit', 'testing': 'testing'}
	type string	always	Type of the resource. Sample: Microsoft.Network/publicIPAddresses

Status ¶

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors¶

Chris Houseknecht (@chouseknecht)
Matt Davis (@nitzmahone)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.