1. Docs
  2. Reference
  3. API
  4. Azure
  5. network
  6. GetPublicIPs

GetPublicIPs

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

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.Network.GetPublicIPs.InvokeAsync(new Azure.Network.GetPublicIPsArgs
        {
            Attached = false,
            ResourceGroupName = "pip-test",
        }));
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/network"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        opt0 := false
        _, err := network.GetPublicIPs(ctx, &network.GetPublicIPsArgs{
            Attached:          &opt0,
            ResourceGroupName: "pip-test",
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_azure as azure

example = azure.network.get_public_i_ps(attached=False,
    resource_group_name="pip-test")
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = pulumi.output(azure.network.getPublicIPs({
    attached: false,
    resourceGroupName: "pip-test",
}, { async: true }));

Using GetPublicIPs

function getPublicIPs(args: GetPublicIPsArgs, opts?: InvokeOptions): Promise<GetPublicIPsResult>
function  get_public_i_ps(allocation_type=None, attached=None, name_prefix=None, resource_group_name=None, opts=None)
func GetPublicIPs(ctx *Context, args *GetPublicIPsArgs, opts ...InvokeOption) (*GetPublicIPsResult, error)
public static class GetPublicIPs {
    public static Task<GetPublicIPsResult> InvokeAsync(GetPublicIPsArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ResourceGroupName string

Specifies the name of the resource group.

AllocationType string

The Allocation Type for the Public IP Address. Possible values include Static or Dynamic.

Attached bool

Filter to include IP Addresses which are attached to a device, such as a VM/LB (true) or unattached (false).

NamePrefix string

A prefix match used for the IP Addresses name field, case sensitive.

ResourceGroupName string

Specifies the name of the resource group.

AllocationType string

The Allocation Type for the Public IP Address. Possible values include Static or Dynamic.

Attached bool

Filter to include IP Addresses which are attached to a device, such as a VM/LB (true) or unattached (false).

NamePrefix string

A prefix match used for the IP Addresses name field, case sensitive.

resourceGroupName string

Specifies the name of the resource group.

allocationType string

The Allocation Type for the Public IP Address. Possible values include Static or Dynamic.

attached boolean

Filter to include IP Addresses which are attached to a device, such as a VM/LB (true) or unattached (false).

namePrefix string

A prefix match used for the IP Addresses name field, case sensitive.

resource_group_name str

Specifies the name of the resource group.

allocation_type str

The Allocation Type for the Public IP Address. Possible values include Static or Dynamic.

attached bool

Filter to include IP Addresses which are attached to a device, such as a VM/LB (true) or unattached (false).

name_prefix str

A prefix match used for the IP Addresses name field, case sensitive.

GetPublicIPs Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

PublicIps List<GetPublicIPsPublicIp>

A List of public_ips blocks as defined below filtered by the criteria above.

ResourceGroupName string
AllocationType string
Attached bool
NamePrefix string
Id string

The provider-assigned unique ID for this managed resource.

PublicIps []GetPublicIPsPublicIp

A List of public_ips blocks as defined below filtered by the criteria above.

ResourceGroupName string
AllocationType string
Attached bool
NamePrefix string
id string

The provider-assigned unique ID for this managed resource.

publicIps GetPublicIPsPublicIp[]

A List of public_ips blocks as defined below filtered by the criteria above.

resourceGroupName string
allocationType string
attached boolean
namePrefix string
id str

The provider-assigned unique ID for this managed resource.

public_ips List[GetPublicIPsPublicIp]

A List of public_ips blocks as defined below filtered by the criteria above.

resource_group_name str
allocation_type str
attached bool
name_prefix str

Supporting Types

GetPublicIPsPublicIp

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

DomainNameLabel string

The Domain Name Label of the Public IP Address

Fqdn string

The FQDN of the Public IP Address

Id string

The ID of the Public IP Address

IpAddress string
Name string

The Name of the Public IP Address

DomainNameLabel string

The Domain Name Label of the Public IP Address

Fqdn string

The FQDN of the Public IP Address

Id string

The ID of the Public IP Address

IpAddress string
Name string

The Name of the Public IP Address

domainNameLabel string

The Domain Name Label of the Public IP Address

fqdn string

The FQDN of the Public IP Address

id string

The ID of the Public IP Address

ipAddress string
name string

The Name of the Public IP Address

domain_name_label str

The Domain Name Label of the Public IP Address

fqdn str

The FQDN of the Public IP Address

id str

The ID of the Public IP Address

ip_address str
name str

The Name of the Public IP Address

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.