azure_rm_publicipaddress

Manage Azure Public IP Addresses

Collection: azure.azcollection

Full Name: azure.azcollection.azure_rm_publicipaddress

Synopsis

Manage Azure Public IP Addresses

Parameters

Name	Type	Required	Default	Description
ad_user	string			Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url	string			Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
allocation_method	string		`dynamic`	Control whether the assigned Public IP remains permanently assigned to the object.
If not set to C(Static), the IP address may changed anytime an associated virtual machine is power cycled.
api_profile	string		`latest`	Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack.
append_tags	bool		`true`	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		`auto`	Controls the source of the credentials to use for authentication.
Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli).
When set to C(env), the credentials will be read from the environment variables.
When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6.
cert_validation_mode	string			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 C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable.
client_id	string			Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi).
Can also be set via the C(AZURE_CLIENT_ID) environment variable.
cloud_environment	string		`AzureCloud`	For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
disable_instance_discovery	bool		`false`	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 C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment variable.
domain_name	string			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.
idle_timeout	int			Idle timeout in minutes.
ip_tags	list			List of IpTag associated with the public IP address.
Each element should contain type:value pair.
location	string			Valid Azure location. Defaults to location of the resource group.
log_mode	string			Parent argument.
log_path	string			Parent argument.
name	string	yes		Name of the Public IP.
oidc_token	string			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 C(AZURE_FEDERATED_TOKEN) environment variable.
oidc_token_file_path	string			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 C(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.
public_ip_prefix	dict			The Public IP Prefix this Public IP Address should be allocated from.
Once set, it cannot be updated.
resource_group	string	yes		Name of resource group with which the Public IP is associated.
reverse_fqdn	string			The reverse FQDN.
A user-visible, fully qualified domain name that resolves to this public IP address.
If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.
secret	string			Azure client secret. Use when authenticating with a Service Principal.
sku	string			The public IP address SKU.
When I(version=ipv6), if I(sku=standard) then set I(allocation_method=static).
When I(version=ipv4), if I(sku=standard) then set I(allocation_method=static).
The I(sku=basic) will be retired on September 30, 2025.
New I(sku=basic) SKU resource cannot be deployed after March 31, 2025.
state	string		`present`	Assert the state of the Public IP. Use C(present) to create or update a and C(absent) to delete.
subscription_id	string			Your Azure subscription Id.
tags	dict			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.
Currently, Azure DNS zones and Traffic Manager services also don’t allow the use of spaces in the tag.
Azure Front Door doesn’t support the use of
Azure Automation and Azure CDN only support 15 tags on resources.
tenant	string			Azure tenant ID. Use when authenticating with a Service Principal.
thumbprint	string			The thumbprint of the private key specified in I(x509_certificate_path).
Use when authenticating with a Service Principal.
Required if I(x509_certificate_path) is defined.
version	string		`ipv4`	The public IP address version.
x509_certificate_path	string			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.
zones	list			A list of availability zones denoting the IP allocated for the resource needs to come from.

Example

yaml

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

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