We recommend using Azure Native.
azure.network.PublicIp
Explore with Pulumi AI
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 thelifecycleargumentcreate_before_destroy = true. Otherwise, it can fail to disassociate on destruction.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const examplePublicIp = new azure.network.PublicIp("example", {
    name: "acceptanceTestPublicIp1",
    resourceGroupName: example.name,
    location: example.location,
    allocationMethod: "Static",
    tags: {
        environment: "Production",
    },
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_public_ip = azure.network.PublicIp("example",
    name="acceptanceTestPublicIp1",
    resource_group_name=example.name,
    location=example.location,
    allocation_method="Static",
    tags={
        "environment": "Production",
    })
package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = network.NewPublicIp(ctx, "example", &network.PublicIpArgs{
			Name:              pulumi.String("acceptanceTestPublicIp1"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			AllocationMethod:  pulumi.String("Static"),
			Tags: pulumi.StringMap{
				"environment": pulumi.String("Production"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });
    var examplePublicIp = new Azure.Network.PublicIp("example", new()
    {
        Name = "acceptanceTestPublicIp1",
        ResourceGroupName = example.Name,
        Location = example.Location,
        AllocationMethod = "Static",
        Tags = 
        {
            { "environment", "Production" },
        },
    });
});
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());
        var examplePublicIp = new PublicIp("examplePublicIp", PublicIpArgs.builder()
            .name("acceptanceTestPublicIp1")
            .resourceGroupName(example.name())
            .location(example.location())
            .allocationMethod("Static")
            .tags(Map.of("environment", "Production"))
            .build());
    }
}
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  examplePublicIp:
    type: azure:network:PublicIp
    name: example
    properties:
      name: acceptanceTestPublicIp1
      resourceGroupName: ${example.name}
      location: ${example.location}
      allocationMethod: Static
      tags:
        environment: Production
Create PublicIp Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PublicIp(name: string, args: PublicIpArgs, opts?: CustomResourceOptions);@overload
def PublicIp(resource_name: str,
             args: PublicIpArgs,
             opts: Optional[ResourceOptions] = None)
@overload
def PublicIp(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             allocation_method: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             domain_name_label_scope: Optional[str] = None,
             location: Optional[str] = None,
             ddos_protection_plan_id: 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,
             domain_name_label: Optional[str] = None,
             name: Optional[str] = None,
             public_ip_prefix_id: Optional[str] = None,
             ddos_protection_mode: 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)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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var publicIpResource = new Azure.Network.PublicIp("publicIpResource", new()
{
    AllocationMethod = "string",
    ResourceGroupName = "string",
    DomainNameLabelScope = "string",
    Location = "string",
    DdosProtectionPlanId = "string",
    EdgeZone = "string",
    IdleTimeoutInMinutes = 0,
    IpTags = 
    {
        { "string", "string" },
    },
    IpVersion = "string",
    DomainNameLabel = "string",
    Name = "string",
    PublicIpPrefixId = "string",
    DdosProtectionMode = "string",
    ReverseFqdn = "string",
    Sku = "string",
    SkuTier = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Zones = new[]
    {
        "string",
    },
});
example, err := network.NewPublicIp(ctx, "publicIpResource", &network.PublicIpArgs{
	AllocationMethod:     pulumi.String("string"),
	ResourceGroupName:    pulumi.String("string"),
	DomainNameLabelScope: pulumi.String("string"),
	Location:             pulumi.String("string"),
	DdosProtectionPlanId: pulumi.String("string"),
	EdgeZone:             pulumi.String("string"),
	IdleTimeoutInMinutes: pulumi.Int(0),
	IpTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IpVersion:          pulumi.String("string"),
	DomainNameLabel:    pulumi.String("string"),
	Name:               pulumi.String("string"),
	PublicIpPrefixId:   pulumi.String("string"),
	DdosProtectionMode: pulumi.String("string"),
	ReverseFqdn:        pulumi.String("string"),
	Sku:                pulumi.String("string"),
	SkuTier:            pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Zones: pulumi.StringArray{
		pulumi.String("string"),
	},
})
var publicIpResource = new PublicIp("publicIpResource", PublicIpArgs.builder()
    .allocationMethod("string")
    .resourceGroupName("string")
    .domainNameLabelScope("string")
    .location("string")
    .ddosProtectionPlanId("string")
    .edgeZone("string")
    .idleTimeoutInMinutes(0)
    .ipTags(Map.of("string", "string"))
    .ipVersion("string")
    .domainNameLabel("string")
    .name("string")
    .publicIpPrefixId("string")
    .ddosProtectionMode("string")
    .reverseFqdn("string")
    .sku("string")
    .skuTier("string")
    .tags(Map.of("string", "string"))
    .zones("string")
    .build());
public_ip_resource = azure.network.PublicIp("publicIpResource",
    allocation_method="string",
    resource_group_name="string",
    domain_name_label_scope="string",
    location="string",
    ddos_protection_plan_id="string",
    edge_zone="string",
    idle_timeout_in_minutes=0,
    ip_tags={
        "string": "string",
    },
    ip_version="string",
    domain_name_label="string",
    name="string",
    public_ip_prefix_id="string",
    ddos_protection_mode="string",
    reverse_fqdn="string",
    sku="string",
    sku_tier="string",
    tags={
        "string": "string",
    },
    zones=["string"])
const publicIpResource = new azure.network.PublicIp("publicIpResource", {
    allocationMethod: "string",
    resourceGroupName: "string",
    domainNameLabelScope: "string",
    location: "string",
    ddosProtectionPlanId: "string",
    edgeZone: "string",
    idleTimeoutInMinutes: 0,
    ipTags: {
        string: "string",
    },
    ipVersion: "string",
    domainNameLabel: "string",
    name: "string",
    publicIpPrefixId: "string",
    ddosProtectionMode: "string",
    reverseFqdn: "string",
    sku: "string",
    skuTier: "string",
    tags: {
        string: "string",
    },
    zones: ["string"],
});
type: azure:network:PublicIp
properties:
    allocationMethod: string
    ddosProtectionMode: string
    ddosProtectionPlanId: string
    domainNameLabel: string
    domainNameLabelScope: string
    edgeZone: string
    idleTimeoutInMinutes: 0
    ipTags:
        string: string
    ipVersion: string
    location: string
    name: string
    publicIpPrefixId: string
    resourceGroupName: string
    reverseFqdn: string
    sku: string
    skuTier: string
    tags:
        string: string
    zones:
        - string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The PublicIp resource accepts the following input properties:
- AllocationMethod string
- Defines the allocation method for this IP address. Possible values are - Staticor- Dynamic.- Note - DynamicPublic 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_addressargument.
- ResourceGroup stringName 
- The name of the Resource Group where this Public IP should exist. Changing this forces a new Public IP to be created.
- DdosProtection stringMode 
- The DDoS protection mode of the public IP. Possible values are Disabled,Enabled, andVirtualNetworkInherited. Defaults toVirtualNetworkInherited.
- DdosProtection stringPlan Id 
- The ID of DDoS protection plan associated with the public IP. - Note: - ddos_protection_plan_idcan only be set when- ddos_protection_modeis- Enabled.
- DomainName stringLabel 
- 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.
- DomainName stringLabel Scope 
- Scope for the domain name label. If a domain name label scope is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. Possible values are NoReuse,ResourceGroupReuse,SubscriptionReuseandTenantReuse. Changing this forces a new Public IP to be created.
- 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.
- IdleTimeout intIn Minutes 
- Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes.
- 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 - RoutingPreferencerequires multiple- zonesand- StandardSKU to be set.
- IpVersion string
- The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created. Defaults to - IPv4.- Note Only - staticIP 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.
- PublicIp stringPrefix Id 
- 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 - Basicand- Standard. Defaults to- Standard. Changing this forces a new resource to be created.- Note Public IP Standard SKUs require - allocation_methodto be set to- Static.
- SkuTier string
- The SKU Tier that should be used for the Public IP. Possible values are - Regionaland- Global. Defaults to- Regional. Changing this forces a new resource to be created.- Note When - sku_tieris set to- Global,- skumust be set to- Standard.
- 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 - Staticor- Dynamic.- Note - DynamicPublic 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_addressargument.
- ResourceGroup stringName 
- The name of the Resource Group where this Public IP should exist. Changing this forces a new Public IP to be created.
- DdosProtection stringMode 
- The DDoS protection mode of the public IP. Possible values are Disabled,Enabled, andVirtualNetworkInherited. Defaults toVirtualNetworkInherited.
- DdosProtection stringPlan Id 
- The ID of DDoS protection plan associated with the public IP. - Note: - ddos_protection_plan_idcan only be set when- ddos_protection_modeis- Enabled.
- DomainName stringLabel 
- 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.
- DomainName stringLabel Scope 
- Scope for the domain name label. If a domain name label scope is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. Possible values are NoReuse,ResourceGroupReuse,SubscriptionReuseandTenantReuse. Changing this forces a new Public IP to be created.
- 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.
- IdleTimeout intIn Minutes 
- Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes.
- 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 - RoutingPreferencerequires multiple- zonesand- StandardSKU to be set.
- IpVersion string
- The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created. Defaults to - IPv4.- Note Only - staticIP 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.
- PublicIp stringPrefix Id 
- 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 - Basicand- Standard. Defaults to- Standard. Changing this forces a new resource to be created.- Note Public IP Standard SKUs require - allocation_methodto be set to- Static.
- SkuTier string
- The SKU Tier that should be used for the Public IP. Possible values are - Regionaland- Global. Defaults to- Regional. Changing this forces a new resource to be created.- Note When - sku_tieris set to- Global,- skumust be set to- Standard.
- 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 - Staticor- Dynamic.- Note - DynamicPublic 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_addressargument.
- resourceGroup StringName 
- The name of the Resource Group where this Public IP should exist. Changing this forces a new Public IP to be created.
- ddosProtection StringMode 
- The DDoS protection mode of the public IP. Possible values are Disabled,Enabled, andVirtualNetworkInherited. Defaults toVirtualNetworkInherited.
- ddosProtection StringPlan Id 
- The ID of DDoS protection plan associated with the public IP. - Note: - ddos_protection_plan_idcan only be set when- ddos_protection_modeis- Enabled.
- domainName StringLabel 
- 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.
- domainName StringLabel Scope 
- Scope for the domain name label. If a domain name label scope is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. Possible values are NoReuse,ResourceGroupReuse,SubscriptionReuseandTenantReuse. Changing this forces a new Public IP to be created.
- 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.
- idleTimeout IntegerIn Minutes 
- Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes.
- 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 - RoutingPreferencerequires multiple- zonesand- StandardSKU to be set.
- ipVersion String
- The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created. Defaults to - IPv4.- Note Only - staticIP 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.
- publicIp StringPrefix Id 
- 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 - Basicand- Standard. Defaults to- Standard. Changing this forces a new resource to be created.- Note Public IP Standard SKUs require - allocation_methodto be set to- Static.
- skuTier String
- The SKU Tier that should be used for the Public IP. Possible values are - Regionaland- Global. Defaults to- Regional. Changing this forces a new resource to be created.- Note When - sku_tieris set to- Global,- skumust be set to- Standard.
- 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 - Staticor- Dynamic.- Note - DynamicPublic 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_addressargument.
- resourceGroup stringName 
- The name of the Resource Group where this Public IP should exist. Changing this forces a new Public IP to be created.
- ddosProtection stringMode 
- The DDoS protection mode of the public IP. Possible values are Disabled,Enabled, andVirtualNetworkInherited. Defaults toVirtualNetworkInherited.
- ddosProtection stringPlan Id 
- The ID of DDoS protection plan associated with the public IP. - Note: - ddos_protection_plan_idcan only be set when- ddos_protection_modeis- Enabled.
- domainName stringLabel 
- 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.
- domainName stringLabel Scope 
- Scope for the domain name label. If a domain name label scope is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. Possible values are NoReuse,ResourceGroupReuse,SubscriptionReuseandTenantReuse. Changing this forces a new Public IP to be created.
- 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.
- idleTimeout numberIn Minutes 
- Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes.
- {[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 - RoutingPreferencerequires multiple- zonesand- StandardSKU to be set.
- ipVersion string
- The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created. Defaults to - IPv4.- Note Only - staticIP 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.
- publicIp stringPrefix Id 
- 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 - Basicand- Standard. Defaults to- Standard. Changing this forces a new resource to be created.- Note Public IP Standard SKUs require - allocation_methodto be set to- Static.
- skuTier string
- The SKU Tier that should be used for the Public IP. Possible values are - Regionaland- Global. Defaults to- Regional. Changing this forces a new resource to be created.- Note When - sku_tieris set to- Global,- skumust be set to- Standard.
- {[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 - Staticor- Dynamic.- Note - DynamicPublic 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_addressargument.
- resource_group_ strname 
- The name of the Resource Group where this Public IP should exist. Changing this forces a new Public IP to be created.
- ddos_protection_ strmode 
- The DDoS protection mode of the public IP. Possible values are Disabled,Enabled, andVirtualNetworkInherited. Defaults toVirtualNetworkInherited.
- ddos_protection_ strplan_ id 
- The ID of DDoS protection plan associated with the public IP. - Note: - ddos_protection_plan_idcan only be set when- ddos_protection_modeis- Enabled.
- domain_name_ strlabel 
- 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.
- domain_name_ strlabel_ scope 
- Scope for the domain name label. If a domain name label scope is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. Possible values are NoReuse,ResourceGroupReuse,SubscriptionReuseandTenantReuse. Changing this forces a new Public IP to be created.
- 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_ intin_ minutes 
- Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes.
- 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 - RoutingPreferencerequires multiple- zonesand- StandardSKU to be set.
- ip_version str
- The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created. Defaults to - IPv4.- Note Only - staticIP 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_ strprefix_ id 
- 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 - Basicand- Standard. Defaults to- Standard. Changing this forces a new resource to be created.- Note Public IP Standard SKUs require - allocation_methodto be set to- Static.
- sku_tier str
- The SKU Tier that should be used for the Public IP. Possible values are - Regionaland- Global. Defaults to- Regional. Changing this forces a new resource to be created.- Note When - sku_tieris set to- Global,- skumust be set to- Standard.
- 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 - Staticor- Dynamic.- Note - DynamicPublic 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_addressargument.
- resourceGroup StringName 
- The name of the Resource Group where this Public IP should exist. Changing this forces a new Public IP to be created.
- ddosProtection StringMode 
- The DDoS protection mode of the public IP. Possible values are Disabled,Enabled, andVirtualNetworkInherited. Defaults toVirtualNetworkInherited.
- ddosProtection StringPlan Id 
- The ID of DDoS protection plan associated with the public IP. - Note: - ddos_protection_plan_idcan only be set when- ddos_protection_modeis- Enabled.
- domainName StringLabel 
- 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.
- domainName StringLabel Scope 
- Scope for the domain name label. If a domain name label scope is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. Possible values are NoReuse,ResourceGroupReuse,SubscriptionReuseandTenantReuse. Changing this forces a new Public IP to be created.
- 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.
- idleTimeout NumberIn Minutes 
- Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes.
- 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 - RoutingPreferencerequires multiple- zonesand- StandardSKU to be set.
- ipVersion String
- The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created. Defaults to - IPv4.- Note Only - staticIP 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.
- publicIp StringPrefix Id 
- 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 - Basicand- Standard. Defaults to- Standard. Changing this forces a new resource to be created.- Note Public IP Standard SKUs require - allocation_methodto be set to- Static.
- skuTier String
- The SKU Tier that should be used for the Public IP. Possible values are - Regionaland- Global. Defaults to- Regional. Changing this forces a new resource to be created.- Note When - sku_tieris set to- Global,- skumust be set to- Standard.
- 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_labelmust be specified to get thefqdn. This is the concatenation of thedomain_name_labeland 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_labelmust be specified to get thefqdn. This is the concatenation of thedomain_name_labeland 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_labelmust be specified to get thefqdn. This is the concatenation of thedomain_name_labeland 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_labelmust be specified to get thefqdn. This is the concatenation of thedomain_name_labeland 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_labelmust be specified to get thefqdn. This is the concatenation of thedomain_name_labeland 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_labelmust be specified to get thefqdn. This is the concatenation of thedomain_name_labeland 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,
        domain_name_label_scope: 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) -> PublicIpfunc 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)resources:  _:    type: azure:network:PublicIp    get:      id: ${id}- 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.
- AllocationMethod string
- Defines the allocation method for this IP address. Possible values are - Staticor- Dynamic.- Note - DynamicPublic 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_addressargument.
- DdosProtection stringMode 
- The DDoS protection mode of the public IP. Possible values are Disabled,Enabled, andVirtualNetworkInherited. Defaults toVirtualNetworkInherited.
- DdosProtection stringPlan Id 
- The ID of DDoS protection plan associated with the public IP. - Note: - ddos_protection_plan_idcan only be set when- ddos_protection_modeis- Enabled.
- DomainName stringLabel 
- 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.
- DomainName stringLabel Scope 
- Scope for the domain name label. If a domain name label scope is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. Possible values are NoReuse,ResourceGroupReuse,SubscriptionReuseandTenantReuse. Changing this forces a new Public IP to be created.
- 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_labelmust be specified to get thefqdn. This is the concatenation of thedomain_name_labeland the regionalized DNS zone
- IdleTimeout intIn Minutes 
- 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.
- 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 - RoutingPreferencerequires multiple- zonesand- StandardSKU to be set.
- IpVersion string
- The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created. Defaults to - IPv4.- Note Only - staticIP 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.
- PublicIp stringPrefix Id 
- 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.
- ResourceGroup stringName 
- 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 - Basicand- Standard. Defaults to- Standard. Changing this forces a new resource to be created.- Note Public IP Standard SKUs require - allocation_methodto be set to- Static.
- SkuTier string
- The SKU Tier that should be used for the Public IP. Possible values are - Regionaland- Global. Defaults to- Regional. Changing this forces a new resource to be created.- Note When - sku_tieris set to- Global,- skumust be set to- Standard.
- 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 - Staticor- Dynamic.- Note - DynamicPublic 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_addressargument.
- DdosProtection stringMode 
- The DDoS protection mode of the public IP. Possible values are Disabled,Enabled, andVirtualNetworkInherited. Defaults toVirtualNetworkInherited.
- DdosProtection stringPlan Id 
- The ID of DDoS protection plan associated with the public IP. - Note: - ddos_protection_plan_idcan only be set when- ddos_protection_modeis- Enabled.
- DomainName stringLabel 
- 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.
- DomainName stringLabel Scope 
- Scope for the domain name label. If a domain name label scope is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. Possible values are NoReuse,ResourceGroupReuse,SubscriptionReuseandTenantReuse. Changing this forces a new Public IP to be created.
- 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_labelmust be specified to get thefqdn. This is the concatenation of thedomain_name_labeland the regionalized DNS zone
- IdleTimeout intIn Minutes 
- 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.
- 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 - RoutingPreferencerequires multiple- zonesand- StandardSKU to be set.
- IpVersion string
- The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created. Defaults to - IPv4.- Note Only - staticIP 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.
- PublicIp stringPrefix Id 
- 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.
- ResourceGroup stringName 
- 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 - Basicand- Standard. Defaults to- Standard. Changing this forces a new resource to be created.- Note Public IP Standard SKUs require - allocation_methodto be set to- Static.
- SkuTier string
- The SKU Tier that should be used for the Public IP. Possible values are - Regionaland- Global. Defaults to- Regional. Changing this forces a new resource to be created.- Note When - sku_tieris set to- Global,- skumust be set to- Standard.
- 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 - Staticor- Dynamic.- Note - DynamicPublic 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_addressargument.
- ddosProtection StringMode 
- The DDoS protection mode of the public IP. Possible values are Disabled,Enabled, andVirtualNetworkInherited. Defaults toVirtualNetworkInherited.
- ddosProtection StringPlan Id 
- The ID of DDoS protection plan associated with the public IP. - Note: - ddos_protection_plan_idcan only be set when- ddos_protection_modeis- Enabled.
- domainName StringLabel 
- 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.
- domainName StringLabel Scope 
- Scope for the domain name label. If a domain name label scope is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. Possible values are NoReuse,ResourceGroupReuse,SubscriptionReuseandTenantReuse. Changing this forces a new Public IP to be created.
- 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_labelmust be specified to get thefqdn. This is the concatenation of thedomain_name_labeland the regionalized DNS zone
- idleTimeout IntegerIn Minutes 
- 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.
- 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 - RoutingPreferencerequires multiple- zonesand- StandardSKU to be set.
- ipVersion String
- The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created. Defaults to - IPv4.- Note Only - staticIP 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.
- publicIp StringPrefix Id 
- 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.
- resourceGroup StringName 
- 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 - Basicand- Standard. Defaults to- Standard. Changing this forces a new resource to be created.- Note Public IP Standard SKUs require - allocation_methodto be set to- Static.
- skuTier String
- The SKU Tier that should be used for the Public IP. Possible values are - Regionaland- Global. Defaults to- Regional. Changing this forces a new resource to be created.- Note When - sku_tieris set to- Global,- skumust be set to- Standard.
- 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 - Staticor- Dynamic.- Note - DynamicPublic 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_addressargument.
- ddosProtection stringMode 
- The DDoS protection mode of the public IP. Possible values are Disabled,Enabled, andVirtualNetworkInherited. Defaults toVirtualNetworkInherited.
- ddosProtection stringPlan Id 
- The ID of DDoS protection plan associated with the public IP. - Note: - ddos_protection_plan_idcan only be set when- ddos_protection_modeis- Enabled.
- domainName stringLabel 
- 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.
- domainName stringLabel Scope 
- Scope for the domain name label. If a domain name label scope is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. Possible values are NoReuse,ResourceGroupReuse,SubscriptionReuseandTenantReuse. Changing this forces a new Public IP to be created.
- 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_labelmust be specified to get thefqdn. This is the concatenation of thedomain_name_labeland the regionalized DNS zone
- idleTimeout numberIn Minutes 
- 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.
- {[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 - RoutingPreferencerequires multiple- zonesand- StandardSKU to be set.
- ipVersion string
- The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created. Defaults to - IPv4.- Note Only - staticIP 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.
- publicIp stringPrefix Id 
- 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.
- resourceGroup stringName 
- 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 - Basicand- Standard. Defaults to- Standard. Changing this forces a new resource to be created.- Note Public IP Standard SKUs require - allocation_methodto be set to- Static.
- skuTier string
- The SKU Tier that should be used for the Public IP. Possible values are - Regionaland- Global. Defaults to- Regional. Changing this forces a new resource to be created.- Note When - sku_tieris set to- Global,- skumust be set to- Standard.
- {[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 - Staticor- Dynamic.- Note - DynamicPublic 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_addressargument.
- ddos_protection_ strmode 
- The DDoS protection mode of the public IP. Possible values are Disabled,Enabled, andVirtualNetworkInherited. Defaults toVirtualNetworkInherited.
- ddos_protection_ strplan_ id 
- The ID of DDoS protection plan associated with the public IP. - Note: - ddos_protection_plan_idcan only be set when- ddos_protection_modeis- Enabled.
- domain_name_ strlabel 
- 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.
- domain_name_ strlabel_ scope 
- Scope for the domain name label. If a domain name label scope is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. Possible values are NoReuse,ResourceGroupReuse,SubscriptionReuseandTenantReuse. Changing this forces a new Public IP to be created.
- 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_labelmust be specified to get thefqdn. This is the concatenation of thedomain_name_labeland the regionalized DNS zone
- idle_timeout_ intin_ minutes 
- 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.
- 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 - RoutingPreferencerequires multiple- zonesand- StandardSKU to be set.
- ip_version str
- The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created. Defaults to - IPv4.- Note Only - staticIP 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_ strprefix_ id 
- 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_ strname 
- 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 - Basicand- Standard. Defaults to- Standard. Changing this forces a new resource to be created.- Note Public IP Standard SKUs require - allocation_methodto be set to- Static.
- sku_tier str
- The SKU Tier that should be used for the Public IP. Possible values are - Regionaland- Global. Defaults to- Regional. Changing this forces a new resource to be created.- Note When - sku_tieris set to- Global,- skumust be set to- Standard.
- 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 - Staticor- Dynamic.- Note - DynamicPublic 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_addressargument.
- ddosProtection StringMode 
- The DDoS protection mode of the public IP. Possible values are Disabled,Enabled, andVirtualNetworkInherited. Defaults toVirtualNetworkInherited.
- ddosProtection StringPlan Id 
- The ID of DDoS protection plan associated with the public IP. - Note: - ddos_protection_plan_idcan only be set when- ddos_protection_modeis- Enabled.
- domainName StringLabel 
- 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.
- domainName StringLabel Scope 
- Scope for the domain name label. If a domain name label scope is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. Possible values are NoReuse,ResourceGroupReuse,SubscriptionReuseandTenantReuse. Changing this forces a new Public IP to be created.
- 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_labelmust be specified to get thefqdn. This is the concatenation of thedomain_name_labeland the regionalized DNS zone
- idleTimeout NumberIn Minutes 
- 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.
- 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 - RoutingPreferencerequires multiple- zonesand- StandardSKU to be set.
- ipVersion String
- The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created. Defaults to - IPv4.- Note Only - staticIP 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.
- publicIp StringPrefix Id 
- 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.
- resourceGroup StringName 
- 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 - Basicand- Standard. Defaults to- Standard. Changing this forces a new resource to be created.- Note Public IP Standard SKUs require - allocation_methodto be set to- Static.
- skuTier String
- The SKU Tier that should be used for the Public IP. Possible values are - Regionaland- Global. Defaults to- Regional. Changing this forces a new resource to be created.- Note When - sku_tieris set to- Global,- skumust be set to- Standard.
- 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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the azurermTerraform Provider.