Try SpotterGet public IP prefix facts
| "added in version" 2.2.0 of azure.azcollection"
Authors: xuzhang3 (@xuzhang3), Fred-sun (@Fred-sun)
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections:
- name: azure.azcollection
version: 2.3.0Get facts for a specific public IP prefix.
Get all facts for a specific public IP prefixes within a resource group.
- name: Get facts for one Public IP Prefix
azure_rm_publicipprefix_info:
resource_group: myResourceGroup
name: publicipprefix
- name: Get facts for all Public IPs within a resource groups
azure_rm_publicipprefix_info:
resource_group: myResourceGroup
tags:
- key:value
name:
description:
- The name of the public IP prefix.
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
publicipprefix:
contains:
custom_ip_prefix:
description:
- The customIpPrefix that this prefix is associated with.
returned: always
sample: {}
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
extended_location:
description:
- The extended location of the public ip address.
returned: always
sample: eastus2
type: str
id:
description:
- Resource ID.
returned: always
sample: /subscriptions/xxx---xxxxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/publicIPPrefixes/pipb57dc95224
type: str
ip_prefix:
description:
- The allocated Prefix.
sample: 20.199.95.80/29
type: str
ip_tags:
description:
- The list of tags associated with the public IP prefixes.
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 prefix.
returned: always
sample: prefix57dc95224
type: str
prefix_length:
description:
- The Length of the Public IP Prefix.
returned: always
sample: 29
type: int
provisioning_state:
description:
- The provisioning state of the PublicIP Prefix resource.
- Possible values is C(Succeeded).
returned: always
sample: Succeeded
type: str
public_ip_address_version:
description:
- The public IP address version.
- Possible values are C(IPv4) and C(IPv6).
returned: always
sample: IPv4
type: str
public_ip_addresses:
description:
- The list of all referenced PublicIPAddresses.
sample: []
type: list
resource_guid:
description:
- The resource GUID property of the public IP prefix resource.
sample: 47cafa04-851d-4579-894d-74ad6afe3233
type: str
sku:
description:
- The public IP prefix SKU.
returned: always
sample:
name: standard
tier: Regional
type: dict
tags:
description:
- Resource tags.
returned: always
sample:
delete: on-exit
testing: testing
type: dict
type:
description:
- Resource type.
returned: always
sample: Microsoft.Network/publicIPPrefixes
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 public IP prefixes dicts.
returned: always
type: complex