azure / azure.azcollection / 2.3.0 / module / azure_rm_publicipaddress_info Get public IP facts | "added in version" 0.1.2 of azure.azcollection" Authors: Chris Houseknecht (@chouseknecht), Matt Davis (@nitzmahone)azure.azcollection.azure_rm_publicipaddress_info (2.3.0) — module
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections: - name: azure.azcollection version: 2.3.0
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_info: resource_group: myResourceGroup name: publicip001
- name: Get facts for all Public IPs within a resource groups azure_rm_publicipaddress_info: resource_group: myResourceGroup tags: - key:value
name: description: - Only show results for a specific Public IP. type: str tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. elements: str type: list 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 or Managed Identity (msi). - Can also be set via the C(AZURE_CLIENT_ID) environment variable. 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. type: str 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 disable_instance_discovery: default: false description: - 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. type: bool version_added: 2.3.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 C(static) and C(dynamic). returned: always sample: static type: str 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 id: description: - Resource ID. returned: always sample: /subscriptions/xxx---xxxxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/publicIPAddresses/pipb57dc95224 type: str idle_timeout: 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: 40.121.144.14 type: str ip_tags: description: - The list of tags associated with the public IP address. returned: always sample: - type: FirstPartyUsage value: Storage type: list location: description: - Resource location. returned: always sample: eastus type: str name: description: - Name of the public IP address. returned: always sample: pipb57dc95224 type: str provisioning_state: description: - The provisioning state of the PublicIP resource. - Possible values is C(Succeeded). returned: always sample: Succeeded type: str sku: description: - The public IP address SKU. returned: always sample: Basic type: str tags: description: - Resource tags. returned: always sample: delete: on-exit testing: testing type: dict type: description: - Resource type. returned: always sample: Microsoft.Network/publicIPAddresses type: str version: description: - The public IP address version. - Possible values are C(ipv4) and C(ipv6). returned: always sample: ipv4 type: str zones: description: - A list of availability zones denoting the IP allocated for the resource needs to come from. returned: always sample: - '1' - '2' type: list 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