Docs Packages
  1. Packages
  2. Azure Classic
  3. API Docs
  4. network
  5. PublicIp

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi
pulumi/pulumi-azure

azure.network.PublicIp

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi
pulumi/pulumi-azure

    Manages a Public IP Address.

    Note If this resource is to be associated with a resource that requires disassociation before destruction (such as azure.network.NetworkInterface) it is recommended to set the lifecycle argument create_before_destroy = true. Otherwise, it can fail to disassociate on destruction.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var examplePublicIp = new Azure.Network.PublicIp("examplePublicIp", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        AllocationMethod = "Static",
        Tags = 
        {
            { "environment", "Production" },
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = network.NewPublicIp(ctx, "examplePublicIp", &network.PublicIpArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
			AllocationMethod:  pulumi.String("Static"),
			Tags: pulumi.StringMap{
				"environment": pulumi.String("Production"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.PublicIp;
import com.pulumi.azure.network.PublicIpArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var examplePublicIp = new PublicIp("examplePublicIp", PublicIpArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .allocationMethod("Static")
            .tags(Map.of("environment", "Production"))
            .build());

    }
}

    import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_public_ip = azure.network.PublicIp("examplePublicIp",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    allocation_method="Static",
    tags={
        "environment": "Production",
    })

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    allocationMethod: "Static",
    tags: {
        environment: "Production",
    },
});

    resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  examplePublicIp:
    type: azure:network:PublicIp
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      allocationMethod: Static
      tags:
        environment: Production

    Create PublicIp Resource

    new PublicIp(name: string, args: PublicIpArgs, opts?: CustomResourceOptions);
    @overload
def PublicIp(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             allocation_method: Optional[str] = None,
             ddos_protection_mode: Optional[str] = None,
             ddos_protection_plan_id: Optional[str] = None,
             domain_name_label: Optional[str] = None,
             edge_zone: Optional[str] = None,
             idle_timeout_in_minutes: Optional[int] = None,
             ip_tags: Optional[Mapping[str, str]] = None,
             ip_version: Optional[str] = None,
             location: Optional[str] = None,
             name: Optional[str] = None,
             public_ip_prefix_id: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             reverse_fqdn: Optional[str] = None,
             sku: Optional[str] = None,
             sku_tier: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None,
             zones: Optional[Sequence[str]] = None)
@overload
def PublicIp(resource_name: str,
             args: PublicIpArgs,
             opts: Optional[ResourceOptions] = None)
    func NewPublicIp(ctx *Context, name string, args PublicIpArgs, opts ...ResourceOption) (*PublicIp, error)
    public PublicIp(string name, PublicIpArgs args, CustomResourceOptions? opts = null)
    public PublicIp(String name, PublicIpArgs args)
public PublicIp(String name, PublicIpArgs args, CustomResourceOptions options)

    type: azure:network:PublicIp
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PublicIpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PublicIpArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PublicIpArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PublicIpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PublicIpArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    PublicIp Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The PublicIp resource accepts the following input properties:

    AllocationMethod string

    Defines the allocation method for this IP address. Possible values are Static or Dynamic.

    Note Dynamic Public IP Addresses aren't allocated until they're assigned to a resource (such as a Virtual Machine or a Load Balancer) by design within Azure. See ip_address argument.

    ResourceGroupName string

    The name of the Resource Group where this Public IP should exist. Changing this forces a new Public IP to be created.

    DdosProtectionMode string

    The DDoS protection mode of the public IP. Possible values are Disabled, Enabled, and VirtualNetworkInherited. Defaults to VirtualNetworkInherited.

    DdosProtectionPlanId string

    The ID of DDoS protection plan associated with the public IP.

    Note: ddos_protection_plan_id can only be set when ddos_protection_mode is Enabled.

    DomainNameLabel string

    Label for the Domain Name. Will be used to make up the FQDN. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.

    EdgeZone string

    Specifies the Edge Zone within the Azure Region where this Public IP should exist. Changing this forces a new Public IP to be created.

    IdleTimeoutInMinutes int

    Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes.

    IpTags Dictionary<string, string>

    A mapping of IP tags to assign to the public IP. Changing this forces a new resource to be created.

    Note IP Tag RoutingPreference requires multiple zones and Standard SKU to be set.

    IpVersion string

    The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created.

    Note Only static IP address allocation is supported for IPv6.

    Location string

    Specifies the supported Azure location where the Public IP should exist. Changing this forces a new resource to be created.

    Name string

    Specifies the name of the Public IP. Changing this forces a new Public IP to be created.

    PublicIpPrefixId string

    If specified then public IP address allocated will be provided from the public IP prefix resource. Changing this forces a new resource to be created.

    ReverseFqdn string

    A fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.

    Sku string

    The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Basic. Changing this forces a new resource to be created.

    Note Public IP Standard SKUs require allocation_method to be set to Static.

    SkuTier string

    The SKU Tier that should be used for the Public IP. Possible values are Regional and Global. Defaults to Regional. Changing this forces a new resource to be created.

    Note When sku_tier is set to Global, sku must be set to Standard.

    Tags Dictionary<string, string>

    A mapping of tags to assign to the resource.

    Zones List<string>

    A collection containing the availability zone to allocate the Public IP in. Changing this forces a new resource to be created.

    Note: Availability Zones are only supported with a Standard SKU and in select regions at this time. Standard SKU Public IP Addresses that do not specify a zone are not zone-redundant by default.

    AllocationMethod string

    Defines the allocation method for this IP address. Possible values are Static or Dynamic.

    Note Dynamic Public IP Addresses aren't allocated until they're assigned to a resource (such as a Virtual Machine or a Load Balancer) by design within Azure. See ip_address argument.

    ResourceGroupName string

    The name of the Resource Group where this Public IP should exist. Changing this forces a new Public IP to be created.

    DdosProtectionMode string

    The DDoS protection mode of the public IP. Possible values are Disabled, Enabled, and VirtualNetworkInherited. Defaults to VirtualNetworkInherited.

    DdosProtectionPlanId string

    The ID of DDoS protection plan associated with the public IP.

    Note: ddos_protection_plan_id can only be set when ddos_protection_mode is Enabled.

    DomainNameLabel string

    Label for the Domain Name. Will be used to make up the FQDN. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.

    EdgeZone string

    Specifies the Edge Zone within the Azure Region where this Public IP should exist. Changing this forces a new Public IP to be created.

    IdleTimeoutInMinutes int

    Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes.

    IpTags map[string]string

    A mapping of IP tags to assign to the public IP. Changing this forces a new resource to be created.

    Note IP Tag RoutingPreference requires multiple zones and Standard SKU to be set.

    IpVersion string

    The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created.

    Note Only static IP address allocation is supported for IPv6.

    Location string

    Specifies the supported Azure location where the Public IP should exist. Changing this forces a new resource to be created.

    Name string

    Specifies the name of the Public IP. Changing this forces a new Public IP to be created.

    PublicIpPrefixId string

    If specified then public IP address allocated will be provided from the public IP prefix resource. Changing this forces a new resource to be created.

    ReverseFqdn string

    A fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.

    Sku string

    The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Basic. Changing this forces a new resource to be created.

    Note Public IP Standard SKUs require allocation_method to be set to Static.

    SkuTier string

    The SKU Tier that should be used for the Public IP. Possible values are Regional and Global. Defaults to Regional. Changing this forces a new resource to be created.

    Note When sku_tier is set to Global, sku must be set to Standard.

    Tags map[string]string

    A mapping of tags to assign to the resource.

    Zones []string

    A collection containing the availability zone to allocate the Public IP in. Changing this forces a new resource to be created.

    Note: Availability Zones are only supported with a Standard SKU and in select regions at this time. Standard SKU Public IP Addresses that do not specify a zone are not zone-redundant by default.

    allocationMethod String

    Defines the allocation method for this IP address. Possible values are Static or Dynamic.

    Note Dynamic Public IP Addresses aren't allocated until they're assigned to a resource (such as a Virtual Machine or a Load Balancer) by design within Azure. See ip_address argument.

    resourceGroupName String

    The name of the Resource Group where this Public IP should exist. Changing this forces a new Public IP to be created.

    ddosProtectionMode String

    The DDoS protection mode of the public IP. Possible values are Disabled, Enabled, and VirtualNetworkInherited. Defaults to VirtualNetworkInherited.

    ddosProtectionPlanId String

    The ID of DDoS protection plan associated with the public IP.

    Note: ddos_protection_plan_id can only be set when ddos_protection_mode is Enabled.

    domainNameLabel String

    Label for the Domain Name. Will be used to make up the FQDN. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.

    edgeZone String

    Specifies the Edge Zone within the Azure Region where this Public IP should exist. Changing this forces a new Public IP to be created.

    idleTimeoutInMinutes Integer

    Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes.

    ipTags Map<String,String>

    A mapping of IP tags to assign to the public IP. Changing this forces a new resource to be created.

    Note IP Tag RoutingPreference requires multiple zones and Standard SKU to be set.

    ipVersion String

    The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created.

    Note Only static IP address allocation is supported for IPv6.

    location String

    Specifies the supported Azure location where the Public IP should exist. Changing this forces a new resource to be created.

    name String

    Specifies the name of the Public IP. Changing this forces a new Public IP to be created.

    publicIpPrefixId String

    If specified then public IP address allocated will be provided from the public IP prefix resource. Changing this forces a new resource to be created.

    reverseFqdn String

    A fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.

    sku String

    The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Basic. Changing this forces a new resource to be created.

    Note Public IP Standard SKUs require allocation_method to be set to Static.

    skuTier String

    The SKU Tier that should be used for the Public IP. Possible values are Regional and Global. Defaults to Regional. Changing this forces a new resource to be created.

    Note When sku_tier is set to Global, sku must be set to Standard.

    tags Map<String,String>

    A mapping of tags to assign to the resource.

    zones List<String>

    A collection containing the availability zone to allocate the Public IP in. Changing this forces a new resource to be created.

    Note: Availability Zones are only supported with a Standard SKU and in select regions at this time. Standard SKU Public IP Addresses that do not specify a zone are not zone-redundant by default.

    allocationMethod string

    Defines the allocation method for this IP address. Possible values are Static or Dynamic.

    Note Dynamic Public IP Addresses aren't allocated until they're assigned to a resource (such as a Virtual Machine or a Load Balancer) by design within Azure. See ip_address argument.

    resourceGroupName string

    The name of the Resource Group where this Public IP should exist. Changing this forces a new Public IP to be created.

    ddosProtectionMode string

    The DDoS protection mode of the public IP. Possible values are Disabled, Enabled, and VirtualNetworkInherited. Defaults to VirtualNetworkInherited.

    ddosProtectionPlanId string

    The ID of DDoS protection plan associated with the public IP.

    Note: ddos_protection_plan_id can only be set when ddos_protection_mode is Enabled.

    domainNameLabel string

    Label for the Domain Name. Will be used to make up the FQDN. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.

    edgeZone string

    Specifies the Edge Zone within the Azure Region where this Public IP should exist. Changing this forces a new Public IP to be created.

    idleTimeoutInMinutes number

    Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes.

    ipTags {[key: string]: string}

    A mapping of IP tags to assign to the public IP. Changing this forces a new resource to be created.

    Note IP Tag RoutingPreference requires multiple zones and Standard SKU to be set.

    ipVersion string

    The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created.

    Note Only static IP address allocation is supported for IPv6.

    location string

    Specifies the supported Azure location where the Public IP should exist. Changing this forces a new resource to be created.

    name string

    Specifies the name of the Public IP. Changing this forces a new Public IP to be created.

    publicIpPrefixId string

    If specified then public IP address allocated will be provided from the public IP prefix resource. Changing this forces a new resource to be created.

    reverseFqdn string

    A fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.

    sku string

    The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Basic. Changing this forces a new resource to be created.

    Note Public IP Standard SKUs require allocation_method to be set to Static.

    skuTier string

    The SKU Tier that should be used for the Public IP. Possible values are Regional and Global. Defaults to Regional. Changing this forces a new resource to be created.

    Note When sku_tier is set to Global, sku must be set to Standard.

    tags {[key: string]: string}

    A mapping of tags to assign to the resource.

    zones string[]

    A collection containing the availability zone to allocate the Public IP in. Changing this forces a new resource to be created.

    Note: Availability Zones are only supported with a Standard SKU and in select regions at this time. Standard SKU Public IP Addresses that do not specify a zone are not zone-redundant by default.

    allocation_method str

    Defines the allocation method for this IP address. Possible values are Static or Dynamic.

    Note Dynamic Public IP Addresses aren't allocated until they're assigned to a resource (such as a Virtual Machine or a Load Balancer) by design within Azure. See ip_address argument.

    resource_group_name str

    The name of the Resource Group where this Public IP should exist. Changing this forces a new Public IP to be created.

    ddos_protection_mode str

    The DDoS protection mode of the public IP. Possible values are Disabled, Enabled, and VirtualNetworkInherited. Defaults to VirtualNetworkInherited.

    ddos_protection_plan_id str

    The ID of DDoS protection plan associated with the public IP.

    Note: ddos_protection_plan_id can only be set when ddos_protection_mode is Enabled.

    domain_name_label str

    Label for the Domain Name. Will be used to make up the FQDN. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.

    edge_zone str

    Specifies the Edge Zone within the Azure Region where this Public IP should exist. Changing this forces a new Public IP to be created.

    idle_timeout_in_minutes int

    Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes.

    ip_tags Mapping[str, str]

    A mapping of IP tags to assign to the public IP. Changing this forces a new resource to be created.

    Note IP Tag RoutingPreference requires multiple zones and Standard SKU to be set.

    ip_version str

    The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created.

    Note Only static IP address allocation is supported for IPv6.

    location str

    Specifies the supported Azure location where the Public IP should exist. Changing this forces a new resource to be created.

    name str

    Specifies the name of the Public IP. Changing this forces a new Public IP to be created.

    public_ip_prefix_id str

    If specified then public IP address allocated will be provided from the public IP prefix resource. Changing this forces a new resource to be created.

    reverse_fqdn str

    A fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.

    sku str

    The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Basic. Changing this forces a new resource to be created.

    Note Public IP Standard SKUs require allocation_method to be set to Static.

    sku_tier str

    The SKU Tier that should be used for the Public IP. Possible values are Regional and Global. Defaults to Regional. Changing this forces a new resource to be created.

    Note When sku_tier is set to Global, sku must be set to Standard.

    tags Mapping[str, str]

    A mapping of tags to assign to the resource.

    zones Sequence[str]

    A collection containing the availability zone to allocate the Public IP in. Changing this forces a new resource to be created.

    Note: Availability Zones are only supported with a Standard SKU and in select regions at this time. Standard SKU Public IP Addresses that do not specify a zone are not zone-redundant by default.

    allocationMethod String

    Defines the allocation method for this IP address. Possible values are Static or Dynamic.

    Note Dynamic Public IP Addresses aren't allocated until they're assigned to a resource (such as a Virtual Machine or a Load Balancer) by design within Azure. See ip_address argument.

    resourceGroupName String

    The name of the Resource Group where this Public IP should exist. Changing this forces a new Public IP to be created.

    ddosProtectionMode String

    The DDoS protection mode of the public IP. Possible values are Disabled, Enabled, and VirtualNetworkInherited. Defaults to VirtualNetworkInherited.

    ddosProtectionPlanId String

    The ID of DDoS protection plan associated with the public IP.

    Note: ddos_protection_plan_id can only be set when ddos_protection_mode is Enabled.

    domainNameLabel String

    Label for the Domain Name. Will be used to make up the FQDN. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.

    edgeZone String

    Specifies the Edge Zone within the Azure Region where this Public IP should exist. Changing this forces a new Public IP to be created.

    idleTimeoutInMinutes Number

    Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes.

    ipTags Map<String>

    A mapping of IP tags to assign to the public IP. Changing this forces a new resource to be created.

    Note IP Tag RoutingPreference requires multiple zones and Standard SKU to be set.

    ipVersion String

    The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created.

    Note Only static IP address allocation is supported for IPv6.

    location String

    Specifies the supported Azure location where the Public IP should exist. Changing this forces a new resource to be created.

    name String

    Specifies the name of the Public IP. Changing this forces a new Public IP to be created.

    publicIpPrefixId String

    If specified then public IP address allocated will be provided from the public IP prefix resource. Changing this forces a new resource to be created.

    reverseFqdn String

    A fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.

    sku String

    The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Basic. Changing this forces a new resource to be created.

    Note Public IP Standard SKUs require allocation_method to be set to Static.

    skuTier String

    The SKU Tier that should be used for the Public IP. Possible values are Regional and Global. Defaults to Regional. Changing this forces a new resource to be created.

    Note When sku_tier is set to Global, sku must be set to Standard.

    tags Map<String>

    A mapping of tags to assign to the resource.

    zones List<String>

    A collection containing the availability zone to allocate the Public IP in. Changing this forces a new resource to be created.

    Note: Availability Zones are only supported with a Standard SKU and in select regions at this time. Standard SKU Public IP Addresses that do not specify a zone are not zone-redundant by default.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PublicIp resource produces the following output properties:

    Fqdn string

    Fully qualified domain name of the A DNS record associated with the public IP. domain_name_label must be specified to get the fqdn. This is the concatenation of the domain_name_label and the regionalized DNS zone

    Id string

    The provider-assigned unique ID for this managed resource.

    IpAddress string

    The IP address value that was allocated.

    Fqdn string

    Fully qualified domain name of the A DNS record associated with the public IP. domain_name_label must be specified to get the fqdn. This is the concatenation of the domain_name_label and the regionalized DNS zone

    Id string

    The provider-assigned unique ID for this managed resource.

    IpAddress string

    The IP address value that was allocated.

    fqdn String

    Fully qualified domain name of the A DNS record associated with the public IP. domain_name_label must be specified to get the fqdn. This is the concatenation of the domain_name_label and the regionalized DNS zone

    id String

    The provider-assigned unique ID for this managed resource.

    ipAddress String

    The IP address value that was allocated.

    fqdn string

    Fully qualified domain name of the A DNS record associated with the public IP. domain_name_label must be specified to get the fqdn. This is the concatenation of the domain_name_label and the regionalized DNS zone

    id string

    The provider-assigned unique ID for this managed resource.

    ipAddress string

    The IP address value that was allocated.

    fqdn str

    Fully qualified domain name of the A DNS record associated with the public IP. domain_name_label must be specified to get the fqdn. This is the concatenation of the domain_name_label and the regionalized DNS zone

    id str

    The provider-assigned unique ID for this managed resource.

    ip_address str

    The IP address value that was allocated.

    fqdn String

    Fully qualified domain name of the A DNS record associated with the public IP. domain_name_label must be specified to get the fqdn. This is the concatenation of the domain_name_label and the regionalized DNS zone

    id String

    The provider-assigned unique ID for this managed resource.

    ipAddress String

    The IP address value that was allocated.

    Look up Existing PublicIp Resource

    Get an existing PublicIp resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PublicIpState, opts?: CustomResourceOptions): PublicIp
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocation_method: Optional[str] = None,
        ddos_protection_mode: Optional[str] = None,
        ddos_protection_plan_id: Optional[str] = None,
        domain_name_label: Optional[str] = None,
        edge_zone: Optional[str] = None,
        fqdn: Optional[str] = None,
        idle_timeout_in_minutes: Optional[int] = None,
        ip_address: Optional[str] = None,
        ip_tags: Optional[Mapping[str, str]] = None,
        ip_version: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        public_ip_prefix_id: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        reverse_fqdn: Optional[str] = None,
        sku: Optional[str] = None,
        sku_tier: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        zones: Optional[Sequence[str]] = None) -> PublicIp
    func GetPublicIp(ctx *Context, name string, id IDInput, state *PublicIpState, opts ...ResourceOption) (*PublicIp, error)
    public static PublicIp Get(string name, Input<string> id, PublicIpState? state, CustomResourceOptions? opts = null)
    public static PublicIp get(String name, Output<String> id, PublicIpState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllocationMethod string

    Defines the allocation method for this IP address. Possible values are Static or Dynamic.

    Note Dynamic Public IP Addresses aren't allocated until they're assigned to a resource (such as a Virtual Machine or a Load Balancer) by design within Azure. See ip_address argument.

    DdosProtectionMode string

    The DDoS protection mode of the public IP. Possible values are Disabled, Enabled, and VirtualNetworkInherited. Defaults to VirtualNetworkInherited.

    DdosProtectionPlanId string

    The ID of DDoS protection plan associated with the public IP.

    Note: ddos_protection_plan_id can only be set when ddos_protection_mode is Enabled.

    DomainNameLabel string

    Label for the Domain Name. Will be used to make up the FQDN. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.

    EdgeZone string

    Specifies the Edge Zone within the Azure Region where this Public IP should exist. Changing this forces a new Public IP to be created.

    Fqdn string

    Fully qualified domain name of the A DNS record associated with the public IP. domain_name_label must be specified to get the fqdn. This is the concatenation of the domain_name_label and the regionalized DNS zone

    IdleTimeoutInMinutes int

    Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes.

    IpAddress string

    The IP address value that was allocated.

    IpTags Dictionary<string, string>

    A mapping of IP tags to assign to the public IP. Changing this forces a new resource to be created.

    Note IP Tag RoutingPreference requires multiple zones and Standard SKU to be set.

    IpVersion string

    The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created.

    Note Only static IP address allocation is supported for IPv6.

    Location string

    Specifies the supported Azure location where the Public IP should exist. Changing this forces a new resource to be created.

    Name string

    Specifies the name of the Public IP. Changing this forces a new Public IP to be created.

    PublicIpPrefixId string

    If specified then public IP address allocated will be provided from the public IP prefix resource. Changing this forces a new resource to be created.

    ResourceGroupName string

    The name of the Resource Group where this Public IP should exist. Changing this forces a new Public IP to be created.

    ReverseFqdn string

    A fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.

    Sku string

    The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Basic. Changing this forces a new resource to be created.

    Note Public IP Standard SKUs require allocation_method to be set to Static.

    SkuTier string

    The SKU Tier that should be used for the Public IP. Possible values are Regional and Global. Defaults to Regional. Changing this forces a new resource to be created.

    Note When sku_tier is set to Global, sku must be set to Standard.

    Tags Dictionary<string, string>

    A mapping of tags to assign to the resource.

    Zones List<string>

    A collection containing the availability zone to allocate the Public IP in. Changing this forces a new resource to be created.

    Note: Availability Zones are only supported with a Standard SKU and in select regions at this time. Standard SKU Public IP Addresses that do not specify a zone are not zone-redundant by default.

    AllocationMethod string

    Defines the allocation method for this IP address. Possible values are Static or Dynamic.

    Note Dynamic Public IP Addresses aren't allocated until they're assigned to a resource (such as a Virtual Machine or a Load Balancer) by design within Azure. See ip_address argument.

    DdosProtectionMode string

    The DDoS protection mode of the public IP. Possible values are Disabled, Enabled, and VirtualNetworkInherited. Defaults to VirtualNetworkInherited.

    DdosProtectionPlanId string

    The ID of DDoS protection plan associated with the public IP.

    Note: ddos_protection_plan_id can only be set when ddos_protection_mode is Enabled.

    DomainNameLabel string

    Label for the Domain Name. Will be used to make up the FQDN. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.

    EdgeZone string

    Specifies the Edge Zone within the Azure Region where this Public IP should exist. Changing this forces a new Public IP to be created.

    Fqdn string

    Fully qualified domain name of the A DNS record associated with the public IP. domain_name_label must be specified to get the fqdn. This is the concatenation of the domain_name_label and the regionalized DNS zone

    IdleTimeoutInMinutes int

    Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes.

    IpAddress string

    The IP address value that was allocated.

    IpTags map[string]string

    A mapping of IP tags to assign to the public IP. Changing this forces a new resource to be created.

    Note IP Tag RoutingPreference requires multiple zones and Standard SKU to be set.

    IpVersion string

    The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created.

    Note Only static IP address allocation is supported for IPv6.

    Location string

    Specifies the supported Azure location where the Public IP should exist. Changing this forces a new resource to be created.

    Name string

    Specifies the name of the Public IP. Changing this forces a new Public IP to be created.

    PublicIpPrefixId string

    If specified then public IP address allocated will be provided from the public IP prefix resource. Changing this forces a new resource to be created.

    ResourceGroupName string

    The name of the Resource Group where this Public IP should exist. Changing this forces a new Public IP to be created.

    ReverseFqdn string

    A fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.

    Sku string

    The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Basic. Changing this forces a new resource to be created.

    Note Public IP Standard SKUs require allocation_method to be set to Static.

    SkuTier string

    The SKU Tier that should be used for the Public IP. Possible values are Regional and Global. Defaults to Regional. Changing this forces a new resource to be created.

    Note When sku_tier is set to Global, sku must be set to Standard.

    Tags map[string]string

    A mapping of tags to assign to the resource.

    Zones []string

    A collection containing the availability zone to allocate the Public IP in. Changing this forces a new resource to be created.

    Note: Availability Zones are only supported with a Standard SKU and in select regions at this time. Standard SKU Public IP Addresses that do not specify a zone are not zone-redundant by default.

    allocationMethod String

    Defines the allocation method for this IP address. Possible values are Static or Dynamic.

    Note Dynamic Public IP Addresses aren't allocated until they're assigned to a resource (such as a Virtual Machine or a Load Balancer) by design within Azure. See ip_address argument.

    ddosProtectionMode String

    The DDoS protection mode of the public IP. Possible values are Disabled, Enabled, and VirtualNetworkInherited. Defaults to VirtualNetworkInherited.

    ddosProtectionPlanId String

    The ID of DDoS protection plan associated with the public IP.

    Note: ddos_protection_plan_id can only be set when ddos_protection_mode is Enabled.

    domainNameLabel String

    Label for the Domain Name. Will be used to make up the FQDN. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.

    edgeZone String

    Specifies the Edge Zone within the Azure Region where this Public IP should exist. Changing this forces a new Public IP to be created.

    fqdn String

    Fully qualified domain name of the A DNS record associated with the public IP. domain_name_label must be specified to get the fqdn. This is the concatenation of the domain_name_label and the regionalized DNS zone

    idleTimeoutInMinutes Integer

    Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes.

    ipAddress String

    The IP address value that was allocated.

    ipTags Map<String,String>

    A mapping of IP tags to assign to the public IP. Changing this forces a new resource to be created.

    Note IP Tag RoutingPreference requires multiple zones and Standard SKU to be set.

    ipVersion String

    The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created.

    Note Only static IP address allocation is supported for IPv6.

    location String

    Specifies the supported Azure location where the Public IP should exist. Changing this forces a new resource to be created.

    name String

    Specifies the name of the Public IP. Changing this forces a new Public IP to be created.

    publicIpPrefixId String

    If specified then public IP address allocated will be provided from the public IP prefix resource. Changing this forces a new resource to be created.

    resourceGroupName String

    The name of the Resource Group where this Public IP should exist. Changing this forces a new Public IP to be created.

    reverseFqdn String

    A fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.

    sku String

    The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Basic. Changing this forces a new resource to be created.

    Note Public IP Standard SKUs require allocation_method to be set to Static.

    skuTier String

    The SKU Tier that should be used for the Public IP. Possible values are Regional and Global. Defaults to Regional. Changing this forces a new resource to be created.

    Note When sku_tier is set to Global, sku must be set to Standard.

    tags Map<String,String>

    A mapping of tags to assign to the resource.

    zones List<String>

    A collection containing the availability zone to allocate the Public IP in. Changing this forces a new resource to be created.

    Note: Availability Zones are only supported with a Standard SKU and in select regions at this time. Standard SKU Public IP Addresses that do not specify a zone are not zone-redundant by default.

    allocationMethod string

    Defines the allocation method for this IP address. Possible values are Static or Dynamic.

    Note Dynamic Public IP Addresses aren't allocated until they're assigned to a resource (such as a Virtual Machine or a Load Balancer) by design within Azure. See ip_address argument.

    ddosProtectionMode string

    The DDoS protection mode of the public IP. Possible values are Disabled, Enabled, and VirtualNetworkInherited. Defaults to VirtualNetworkInherited.

    ddosProtectionPlanId string

    The ID of DDoS protection plan associated with the public IP.

    Note: ddos_protection_plan_id can only be set when ddos_protection_mode is Enabled.

    domainNameLabel string

    Label for the Domain Name. Will be used to make up the FQDN. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.

    edgeZone string

    Specifies the Edge Zone within the Azure Region where this Public IP should exist. Changing this forces a new Public IP to be created.

    fqdn string

    Fully qualified domain name of the A DNS record associated with the public IP. domain_name_label must be specified to get the fqdn. This is the concatenation of the domain_name_label and the regionalized DNS zone

    idleTimeoutInMinutes number

    Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes.

    ipAddress string

    The IP address value that was allocated.

    ipTags {[key: string]: string}

    A mapping of IP tags to assign to the public IP. Changing this forces a new resource to be created.

    Note IP Tag RoutingPreference requires multiple zones and Standard SKU to be set.

    ipVersion string

    The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created.

    Note Only static IP address allocation is supported for IPv6.

    location string

    Specifies the supported Azure location where the Public IP should exist. Changing this forces a new resource to be created.

    name string

    Specifies the name of the Public IP. Changing this forces a new Public IP to be created.

    publicIpPrefixId string

    If specified then public IP address allocated will be provided from the public IP prefix resource. Changing this forces a new resource to be created.

    resourceGroupName string

    The name of the Resource Group where this Public IP should exist. Changing this forces a new Public IP to be created.

    reverseFqdn string

    A fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.

    sku string

    The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Basic. Changing this forces a new resource to be created.

    Note Public IP Standard SKUs require allocation_method to be set to Static.

    skuTier string

    The SKU Tier that should be used for the Public IP. Possible values are Regional and Global. Defaults to Regional. Changing this forces a new resource to be created.

    Note When sku_tier is set to Global, sku must be set to Standard.

    tags {[key: string]: string}

    A mapping of tags to assign to the resource.

    zones string[]

    A collection containing the availability zone to allocate the Public IP in. Changing this forces a new resource to be created.

    Note: Availability Zones are only supported with a Standard SKU and in select regions at this time. Standard SKU Public IP Addresses that do not specify a zone are not zone-redundant by default.

    allocation_method str

    Defines the allocation method for this IP address. Possible values are Static or Dynamic.

    Note Dynamic Public IP Addresses aren't allocated until they're assigned to a resource (such as a Virtual Machine or a Load Balancer) by design within Azure. See ip_address argument.

    ddos_protection_mode str

    The DDoS protection mode of the public IP. Possible values are Disabled, Enabled, and VirtualNetworkInherited. Defaults to VirtualNetworkInherited.

    ddos_protection_plan_id str

    The ID of DDoS protection plan associated with the public IP.

    Note: ddos_protection_plan_id can only be set when ddos_protection_mode is Enabled.

    domain_name_label str

    Label for the Domain Name. Will be used to make up the FQDN. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.

    edge_zone str

    Specifies the Edge Zone within the Azure Region where this Public IP should exist. Changing this forces a new Public IP to be created.

    fqdn str

    Fully qualified domain name of the A DNS record associated with the public IP. domain_name_label must be specified to get the fqdn. This is the concatenation of the domain_name_label and the regionalized DNS zone

    idle_timeout_in_minutes int

    Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes.

    ip_address str

    The IP address value that was allocated.

    ip_tags Mapping[str, str]

    A mapping of IP tags to assign to the public IP. Changing this forces a new resource to be created.

    Note IP Tag RoutingPreference requires multiple zones and Standard SKU to be set.

    ip_version str

    The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created.

    Note Only static IP address allocation is supported for IPv6.

    location str

    Specifies the supported Azure location where the Public IP should exist. Changing this forces a new resource to be created.

    name str

    Specifies the name of the Public IP. Changing this forces a new Public IP to be created.

    public_ip_prefix_id str

    If specified then public IP address allocated will be provided from the public IP prefix resource. Changing this forces a new resource to be created.

    resource_group_name str

    The name of the Resource Group where this Public IP should exist. Changing this forces a new Public IP to be created.

    reverse_fqdn str

    A fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.

    sku str

    The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Basic. Changing this forces a new resource to be created.

    Note Public IP Standard SKUs require allocation_method to be set to Static.

    sku_tier str

    The SKU Tier that should be used for the Public IP. Possible values are Regional and Global. Defaults to Regional. Changing this forces a new resource to be created.

    Note When sku_tier is set to Global, sku must be set to Standard.

    tags Mapping[str, str]

    A mapping of tags to assign to the resource.

    zones Sequence[str]

    A collection containing the availability zone to allocate the Public IP in. Changing this forces a new resource to be created.

    Note: Availability Zones are only supported with a Standard SKU and in select regions at this time. Standard SKU Public IP Addresses that do not specify a zone are not zone-redundant by default.

    allocationMethod String

    Defines the allocation method for this IP address. Possible values are Static or Dynamic.

    Note Dynamic Public IP Addresses aren't allocated until they're assigned to a resource (such as a Virtual Machine or a Load Balancer) by design within Azure. See ip_address argument.

    ddosProtectionMode String

    The DDoS protection mode of the public IP. Possible values are Disabled, Enabled, and VirtualNetworkInherited. Defaults to VirtualNetworkInherited.

    ddosProtectionPlanId String

    The ID of DDoS protection plan associated with the public IP.

    Note: ddos_protection_plan_id can only be set when ddos_protection_mode is Enabled.

    domainNameLabel String

    Label for the Domain Name. Will be used to make up the FQDN. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.

    edgeZone String

    Specifies the Edge Zone within the Azure Region where this Public IP should exist. Changing this forces a new Public IP to be created.

    fqdn String

    Fully qualified domain name of the A DNS record associated with the public IP. domain_name_label must be specified to get the fqdn. This is the concatenation of the domain_name_label and the regionalized DNS zone

    idleTimeoutInMinutes Number

    Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes.

    ipAddress String

    The IP address value that was allocated.

    ipTags Map<String>

    A mapping of IP tags to assign to the public IP. Changing this forces a new resource to be created.

    Note IP Tag RoutingPreference requires multiple zones and Standard SKU to be set.

    ipVersion String

    The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created.

    Note Only static IP address allocation is supported for IPv6.

    location String

    Specifies the supported Azure location where the Public IP should exist. Changing this forces a new resource to be created.

    name String

    Specifies the name of the Public IP. Changing this forces a new Public IP to be created.

    publicIpPrefixId String

    If specified then public IP address allocated will be provided from the public IP prefix resource. Changing this forces a new resource to be created.

    resourceGroupName String

    The name of the Resource Group where this Public IP should exist. Changing this forces a new Public IP to be created.

    reverseFqdn String

    A fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.

    sku String

    The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Basic. Changing this forces a new resource to be created.

    Note Public IP Standard SKUs require allocation_method to be set to Static.

    skuTier String

    The SKU Tier that should be used for the Public IP. Possible values are Regional and Global. Defaults to Regional. Changing this forces a new resource to be created.

    Note When sku_tier is set to Global, sku must be set to Standard.

    tags Map<String>

    A mapping of tags to assign to the resource.

    zones List<String>

    A collection containing the availability zone to allocate the Public IP in. Changing this forces a new resource to be created.

    Note: Availability Zones are only supported with a Standard SKU and in select regions at this time. Standard SKU Public IP Addresses that do not specify a zone are not zone-redundant by default.

    Import

    Public IPs can be imported using the resource id, e.g.

     $ pulumi import azure:network/publicIp:PublicIp myPublicIp /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/publicIPAddresses/myPublicIpAddress1

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the azurerm Terraform Provider.

    azure logo

    We recommend using Azure Native.

    Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi
    pulumi/pulumi-azure