ansible / ansible.builtin / v2.8.19 / module / azure_rm_publicipaddress_facts Get public IP facts. | "added in version" 2.1 of ansible.builtin" Authors: Chris Houseknecht (@chouseknecht), Matt Davis (@nitzmahone) preview | supported by communityansible.builtin.azure_rm_publicipaddress_facts (v2.8.19) — module
pip
Install with pip install ansible==2.8.19
Get facts for a specific public IP or all public IPs within a resource group.
- name: Get facts for one Public IP azure_rm_publicipaddress_facts: resource_group: myResourceGroup name: publicip001
- name: Get facts for all Public IPs within a resource groups azure_rm_publicipaddress_facts: resource_group: myResourceGroup
name: description: - Only show results for a specific Public IP. tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. 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 profile: description: - Security profile found in ~/.azure/credentials file. type: str log_mode: description: - Parent argument. type: str log_path: description: - Parent argument. type: str 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 thumbprint: description: - 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. type: str version_added: 1.14.0 version_added_collection: azure.azcollection 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 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 resource_group: description: - Limit results by resource group. Required when using name parameter. subscription_id: description: - Your Azure subscription Id. type: str 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 x509_certificate_path: description: - 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. type: path version_added: 1.14.0 version_added_collection: azure.azcollection
azure_publicipaddresses: description: - List of public IP address dicts. - Please note that this option will be deprecated in 2.10 when curated format will become the only supported format. example: - etag: W/"a31a6d7d-cb18-40a5-b16d-9f4a36c1b18a" id: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/pip2001 location: eastus2 name: pip2001 properties: idleTimeoutInMinutes: 4 provisioningState: Succeeded publicIPAllocationMethod: Dynamic resourceGuid: 29de82f4-a7da-440e-bd3d-9cabb79af95a type: Microsoft.Network/publicIPAddresses returned: always type: list publicipaddresses: contains: allocation_method: description: - The public IP allocation method. - Possible values are 'static' and 'dynamic'. returned: always type: str dns_settings: description: - The FQDN of the DNS record associated with the public IP address. returned: always type: complex etag: description: - A unique read-only string that changes whenever the resource is updated. returned: always type: str id: description: - Resource ID. returned: always type: str idle_timeout: description: - The idle timeout of the public IP address. returned: always type: int ip_address: description: - The Public IP Prefix this Public IP Address should be allocated from. returned: always type: str ip_tags: description: - The list of tags associated with the public IP address. returned: always type: complex location: description: - Resource location. returned: always type: str name: description: - Name of the public ip address. returned: always type: str provisioning_state: description: - he provisioning state of the PublicIP resource. - Possible values are 'Updating', 'Deleting', and 'Failed'. returned: always type: str sku: description: - The public IP address SKU. returned: always type: str tags: description: - Resource tags. returned: always type: complex type: description: - Resource type. returned: always type: str version: description: - The public IP address version. - Possible values are 'ipv4' and 'ipv6'. returned: always type: str description: - List of publicipaddress - Contains the detail which matches azure_rm_publicipaddress parameters. - Returned when the format parameter set to curated. returned: always type: complex