Skip to content

Data Source: azurermPublicIps

Use this data source to access information about a set of existing Public IP Addresses.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
new azurerm.dataAzurermPublicIps.DataAzurermPublicIps(this, "example", {
  attachment_status: "Attached",
  resource_group_name: "pip-test",
});

Argument Reference

  • resourceGroupName - Specifies the name of the resource group.
  • attachmentStatus - (Optional) Filter to include IP Addresses which are attached to a device, such as a VM/LB (attached) or unattached (unattached).
  • namePrefix - (Optional) A prefix match used for the IP Addresses name field, case sensitive.
  • allocationType - (Optional) The Allocation Type for the Public IP Address. Possible values include static or dynamic.

Attributes Reference

  • publicIps - A List of publicIps blocks as defined below filtered by the criteria above.

A publicIps block contains:

  • id - The ID of the Public IP Address
  • domainNameLabel - The Domain Name Label of the Public IP Address
  • fqdn - The FQDN of the Public IP Address
  • name - The Name of the Public IP Address
  • ipAddress - The IP address of the Public IP Address

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • read - (Defaults to 5 minutes) Used when retrieving the Public IP Addresses.