azure.azcollection.azure_rm_publicipaddress – Manage Azure Public IP Addresses¶
Note
This plugin is part of the azure.azcollection collection (version 1.5.0).
To install it use: ansible-galaxy collection install azure.azcollection
.
To use it in a playbook, specify: azure.azcollection.azure_rm_publicipaddress
.
New in version 0.1.0: of azure.azcollection
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¶
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.
See Also¶
See also
- Sign in with Azure CLI
How to authenticate using the
az login
command.
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
Authors¶
Chris Houseknecht (@chouseknecht)
Matt Davis (@nitzmahone)
There were some errors parsing the documentation for this plugin. Please file a bug with the collection.
The errors were:
Unable to normalize azure_rm_publicipaddress: return due to: 11 validation errors for PluginReturnSchema return -> state -> contains -> dns_settings -> returns extra fields not permitted (type=value_error.extra) return -> state -> contains -> etag -> returns extra fields not permitted (type=value_error.extra) return -> state -> contains -> idle_timeout_in_minutes -> returns extra fields not permitted (type=value_error.extra) return -> state -> contains -> ip_address -> returns extra fields not permitted (type=value_error.extra) return -> state -> contains -> location -> returns extra fields not permitted (type=value_error.extra) return -> state -> contains -> name -> returns extra fields not permitted (type=value_error.extra) return -> state -> contains -> provisioning_state -> returns extra fields not permitted (type=value_error.extra) return -> state -> contains -> public_ip_address_version -> returns extra fields not permitted (type=value_error.extra) return -> state -> contains -> public_ip_allocation_method -> returns extra fields not permitted (type=value_error.extra) return -> state -> contains -> tags -> returns extra fields not permitted (type=value_error.extra) return -> state -> contains -> type -> returns extra fields not permitted (type=value_error.extra)