ansible / ansible.builtin / v2.9.17 / module / azure_rm_publicipaddress Manage Azure Public IP Addresses | "added in version" 2.1 of ansible.builtin" Authors: Chris Houseknecht (@chouseknecht), Matt Davis (@nitzmahone) preview | supported by communityansible.builtin.azure_rm_publicipaddress (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
Create, update and delete a Public IP address.
Allows setting and updating the address allocation method and domain name label.
Use the M(azure_rm_networkinterface) module to associate a Public IP with a network interface.
- 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
sku: choices: - basic - standard - Basic - Standard description: - The public IP address SKU. version_added: '2.6' version_added_collection: ansible.builtin name: description: - Name of the Public IP. required: true tags: description: - 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. type: dict state: choices: - absent - present default: present description: - Assert the state of the Public IP. Use C(present) to create or update a and C(absent) to delete. secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str tenant: description: - Azure tenant ID. Use when authenticating with a Service Principal. type: str ad_user: description: - Active Directory username. Use when authenticating with an Active Directory user rather than service principal. type: str ip_tags: description: - List of IpTag associated with the public IP address. - Each element should contain type:value pair. suboptions: type: description: - Sets the ip_tags type. value: description: - Sets the ip_tags value. version_added: '2.8' version_added_collection: ansible.builtin profile: description: - Security profile found in ~/.azure/credentials file. type: str version: choices: - ipv4 - ipv6 default: ipv4 description: - The public IP address version. version_added: '2.8' version_added_collection: ansible.builtin location: description: - Valid Azure location. Defaults to location of the resource group. password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. type: str client_id: description: - Azure client ID. Use when authenticating with a Service Principal. type: str api_profile: default: latest description: - 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. type: str version_added: 0.0.1 version_added_collection: azure.azcollection append_tags: default: true description: - 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. type: bool auth_source: choices: - auto - cli - credential_file - env - msi default: auto description: - 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. type: str version_added: 0.0.1 version_added_collection: azure.azcollection domain_name: aliases: - domain_name_label description: - 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: description: - Idle timeout in minutes. type: int version_added: '2.8' version_added_collection: ansible.builtin resource_group: description: - Name of resource group with which the Public IP is associated. required: true subscription_id: description: - Your Azure subscription Id. type: str allocation_method: choices: - dynamic - static - Static - Dynamic default: dynamic description: - Control whether the assigned Public IP remains permanently assigned to the object. - If not set to C(Static), the IP address my changed anytime an associated virtual machine is power cycled. cloud_environment: default: AzureCloud description: - 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. type: str version_added: 0.0.1 version_added_collection: azure.azcollection adfs_authority_url: description: - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. type: str version_added: 0.0.1 version_added_collection: azure.azcollection cert_validation_mode: choices: - ignore - validate description: - 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. type: str version_added: 0.0.1 version_added_collection: azure.azcollection
state: contains: dns_settings: description: - The FQDN of the DNS record associated with the public IP address. returned: always sample: domain_name_label: ansible-b57dc95985712e45eb8b9c2e fqdn: ansible-b57dc95985712e45eb8b9c2e.eastus.cloudapp.azure.com reverse_fqdn: null type: dict etag: description: - A unique read-only string that changes whenever the resource is updated. returned: always sample: W/'1905ee13-7623-45b1-bc6b-4a12b2fb9d15' type: str idle_timeout_in_minutes: description: - The idle timeout of the public IP address. returned: always sample: 4 type: int ip_address: description: - The Public IP Prefix this Public IP Address should be allocated from. returned: always sample: 52.160.103.93 type: str location: description: - Resource location. example: eastus returned: always type: str name: description: - Name of the Public IP Address. example: publicip002 returned: always type: str provisioning_state: description: - The provisioning state of the Public IP resource. example: Succeeded returned: always type: str public_ip_address_version: description: - The public IP address version. returned: always sample: ipv4 type: str public_ip_allocation_method: description: - The public IP allocation method. returned: always sample: static type: str sku: description: - The public IP address SKU. returned: always sample: Basic type: str tags: description: - The resource tags. returned: always sample: delete: on-exit testing: testing type: dict type: description: - Type of the resource. returned: always sample: Microsoft.Network/publicIPAddresses type: str description: - Facts about the current state of the object. returned: always type: complex