Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. PublicIPPrefix
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.5.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.PublicIPPrefix

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.5.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-azure-native

    Public IP prefix resource.

    Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01.

    Other available API versions: 2018-07-01, 2018-08-01, 2018-10-01, 2018-11-01, 2018-12-01, 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the version guide for details.

    Example Usage

    Create public IP prefix allocation method

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

return await Deployment.RunAsync(() => 
{
    var publicIPPrefix = new AzureNative.Network.PublicIPPrefix("publicIPPrefix", new()
    {
        Location = "westus",
        PrefixLength = 30,
        PublicIPAddressVersion = AzureNative.Network.IPVersion.IPv4,
        PublicIpPrefixName = "test-ipprefix",
        ResourceGroupName = "rg1",
        Sku = new AzureNative.Network.Inputs.PublicIPPrefixSkuArgs
        {
            Name = AzureNative.Network.PublicIPPrefixSkuName.Standard,
            Tier = AzureNative.Network.PublicIPPrefixSkuTier.Regional,
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewPublicIPPrefix(ctx, "publicIPPrefix", &network.PublicIPPrefixArgs{
			Location:               pulumi.String("westus"),
			PrefixLength:           pulumi.Int(30),
			PublicIPAddressVersion: pulumi.String(network.IPVersionIPv4),
			PublicIpPrefixName:     pulumi.String("test-ipprefix"),
			ResourceGroupName:      pulumi.String("rg1"),
			Sku: &network.PublicIPPrefixSkuArgs{
				Name: pulumi.String(network.PublicIPPrefixSkuNameStandard),
				Tier: pulumi.String(network.PublicIPPrefixSkuTierRegional),
			},
		})
		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.azurenative.network.PublicIPPrefix;
import com.pulumi.azurenative.network.PublicIPPrefixArgs;
import com.pulumi.azurenative.network.inputs.PublicIPPrefixSkuArgs;
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 publicIPPrefix = new PublicIPPrefix("publicIPPrefix", PublicIPPrefixArgs.builder()
            .location("westus")
            .prefixLength(30)
            .publicIPAddressVersion("IPv4")
            .publicIpPrefixName("test-ipprefix")
            .resourceGroupName("rg1")
            .sku(PublicIPPrefixSkuArgs.builder()
                .name("Standard")
                .tier("Regional")
                .build())
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const publicIPPrefix = new azure_native.network.PublicIPPrefix("publicIPPrefix", {
    location: "westus",
    prefixLength: 30,
    publicIPAddressVersion: azure_native.network.IPVersion.IPv4,
    publicIpPrefixName: "test-ipprefix",
    resourceGroupName: "rg1",
    sku: {
        name: azure_native.network.PublicIPPrefixSkuName.Standard,
        tier: azure_native.network.PublicIPPrefixSkuTier.Regional,
    },
});

    import pulumi
import pulumi_azure_native as azure_native

public_ip_prefix = azure_native.network.PublicIPPrefix("publicIPPrefix",
    location="westus",
    prefix_length=30,
    public_ip_address_version=azure_native.network.IPVersion.I_PV4,
    public_ip_prefix_name="test-ipprefix",
    resource_group_name="rg1",
    sku={
        "name": azure_native.network.PublicIPPrefixSkuName.STANDARD,
        "tier": azure_native.network.PublicIPPrefixSkuTier.REGIONAL,
    })

    resources:
  publicIPPrefix:
    type: azure-native:network:PublicIPPrefix
    properties:
      location: westus
      prefixLength: 30
      publicIPAddressVersion: IPv4
      publicIpPrefixName: test-ipprefix
      resourceGroupName: rg1
      sku:
        name: Standard
        tier: Regional

    Create public IP prefix defaults

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

return await Deployment.RunAsync(() => 
{
    var publicIPPrefix = new AzureNative.Network.PublicIPPrefix("publicIPPrefix", new()
    {
        Location = "westus",
        PrefixLength = 30,
        PublicIpPrefixName = "test-ipprefix",
        ResourceGroupName = "rg1",
        Sku = new AzureNative.Network.Inputs.PublicIPPrefixSkuArgs
        {
            Name = AzureNative.Network.PublicIPPrefixSkuName.Standard,
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewPublicIPPrefix(ctx, "publicIPPrefix", &network.PublicIPPrefixArgs{
			Location:           pulumi.String("westus"),
			PrefixLength:       pulumi.Int(30),
			PublicIpPrefixName: pulumi.String("test-ipprefix"),
			ResourceGroupName:  pulumi.String("rg1"),
			Sku: &network.PublicIPPrefixSkuArgs{
				Name: pulumi.String(network.PublicIPPrefixSkuNameStandard),
			},
		})
		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.azurenative.network.PublicIPPrefix;
import com.pulumi.azurenative.network.PublicIPPrefixArgs;
import com.pulumi.azurenative.network.inputs.PublicIPPrefixSkuArgs;
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 publicIPPrefix = new PublicIPPrefix("publicIPPrefix", PublicIPPrefixArgs.builder()
            .location("westus")
            .prefixLength(30)
            .publicIpPrefixName("test-ipprefix")
            .resourceGroupName("rg1")
            .sku(PublicIPPrefixSkuArgs.builder()
                .name("Standard")
                .build())
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const publicIPPrefix = new azure_native.network.PublicIPPrefix("publicIPPrefix", {
    location: "westus",
    prefixLength: 30,
    publicIpPrefixName: "test-ipprefix",
    resourceGroupName: "rg1",
    sku: {
        name: azure_native.network.PublicIPPrefixSkuName.Standard,
    },
});

    import pulumi
import pulumi_azure_native as azure_native

public_ip_prefix = azure_native.network.PublicIPPrefix("publicIPPrefix",
    location="westus",
    prefix_length=30,
    public_ip_prefix_name="test-ipprefix",
    resource_group_name="rg1",
    sku={
        "name": azure_native.network.PublicIPPrefixSkuName.STANDARD,
    })

    resources:
  publicIPPrefix:
    type: azure-native:network:PublicIPPrefix
    properties:
      location: westus
      prefixLength: 30
      publicIpPrefixName: test-ipprefix
      resourceGroupName: rg1
      sku:
        name: Standard

    Create PublicIPPrefix Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PublicIPPrefix(name: string, args: PublicIPPrefixArgs, opts?: CustomResourceOptions);
    @overload
def PublicIPPrefix(resource_name: str,
                   args: PublicIPPrefixArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def PublicIPPrefix(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   resource_group_name: Optional[str] = None,
                   ip_tags: Optional[Sequence[IpTagArgs]] = None,
                   id: Optional[str] = None,
                   custom_ip_prefix: Optional[SubResourceArgs] = None,
                   location: Optional[str] = None,
                   nat_gateway: Optional[NatGatewayArgs] = None,
                   prefix_length: Optional[int] = None,
                   public_ip_address_version: Optional[Union[str, IPVersion]] = None,
                   public_ip_prefix_name: Optional[str] = None,
                   extended_location: Optional[ExtendedLocationArgs] = None,
                   sku: Optional[PublicIPPrefixSkuArgs] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   zones: Optional[Sequence[str]] = None)
    func NewPublicIPPrefix(ctx *Context, name string, args PublicIPPrefixArgs, opts ...ResourceOption) (*PublicIPPrefix, error)
    public PublicIPPrefix(string name, PublicIPPrefixArgs args, CustomResourceOptions? opts = null)
    public PublicIPPrefix(String name, PublicIPPrefixArgs args)
public PublicIPPrefix(String name, PublicIPPrefixArgs args, CustomResourceOptions options)

    type: azure-native:network:PublicIPPrefix
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 PublicIPPrefixArgs
    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 PublicIPPrefixArgs
    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 PublicIPPrefixArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PublicIPPrefixArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PublicIPPrefixArgs
    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 publicIPPrefixResource = new AzureNative.Network.PublicIPPrefix("publicIPPrefixResource", new()
{
    ResourceGroupName = "string",
    IpTags = new[]
    {
        new AzureNative.Network.Inputs.IpTagArgs
        {
            IpTagType = "string",
            Tag = "string",
        },
    },
    Id = "string",
    CustomIPPrefix = new AzureNative.Network.Inputs.SubResourceArgs
    {
        Id = "string",
    },
    Location = "string",
    NatGateway = new AzureNative.Network.Inputs.NatGatewayArgs
    {
        Id = "string",
        IdleTimeoutInMinutes = 0,
        Location = "string",
        PublicIpAddresses = new[]
        {
            new AzureNative.Network.Inputs.SubResourceArgs
            {
                Id = "string",
            },
        },
        PublicIpPrefixes = new[]
        {
            new AzureNative.Network.Inputs.SubResourceArgs
            {
                Id = "string",
            },
        },
        Sku = new AzureNative.Network.Inputs.NatGatewaySkuArgs
        {
            Name = "string",
        },
        Tags = 
        {
            { "string", "string" },
        },
        Zones = new[]
        {
            "string",
        },
    },
    PrefixLength = 0,
    PublicIPAddressVersion = "string",
    PublicIpPrefixName = "string",
    ExtendedLocation = new AzureNative.Network.Inputs.ExtendedLocationArgs
    {
        Name = "string",
        Type = "string",
    },
    Sku = new AzureNative.Network.Inputs.PublicIPPrefixSkuArgs
    {
        Name = "string",
        Tier = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
    Zones = new[]
    {
        "string",
    },
});

    example, err := network.NewPublicIPPrefix(ctx, "publicIPPrefixResource", &network.PublicIPPrefixArgs{
	ResourceGroupName: pulumi.String("string"),
	IpTags: network.IpTagArray{
		&network.IpTagArgs{
			IpTagType: pulumi.String("string"),
			Tag:       pulumi.String("string"),
		},
	},
	Id: pulumi.String("string"),
	CustomIPPrefix: &network.SubResourceArgs{
		Id: pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	NatGateway: &network.NatGatewayTypeArgs{
		Id:                   pulumi.String("string"),
		IdleTimeoutInMinutes: pulumi.Int(0),
		Location:             pulumi.String("string"),
		PublicIpAddresses: network.SubResourceArray{
			&network.SubResourceArgs{
				Id: pulumi.String("string"),
			},
		},
		PublicIpPrefixes: network.SubResourceArray{
			&network.SubResourceArgs{
				Id: pulumi.String("string"),
			},
		},
		Sku: &network.NatGatewaySkuArgs{
			Name: pulumi.String("string"),
		},
		Tags: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		Zones: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	PrefixLength:           pulumi.Int(0),
	PublicIPAddressVersion: pulumi.String("string"),
	PublicIpPrefixName:     pulumi.String("string"),
	ExtendedLocation: &network.ExtendedLocationArgs{
		Name: pulumi.String("string"),
		Type: pulumi.String("string"),
	},
	Sku: &network.PublicIPPrefixSkuArgs{
		Name: pulumi.String("string"),
		Tier: pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Zones: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var publicIPPrefixResource = new PublicIPPrefix("publicIPPrefixResource", PublicIPPrefixArgs.builder()
    .resourceGroupName("string")
    .ipTags(IpTagArgs.builder()
        .ipTagType("string")
        .tag("string")
        .build())
    .id("string")
    .customIPPrefix(SubResourceArgs.builder()
        .id("string")
        .build())
    .location("string")
    .natGateway(NatGatewayArgs.builder()
        .id("string")
        .idleTimeoutInMinutes(0)
        .location("string")
        .publicIpAddresses(SubResourceArgs.builder()
            .id("string")
            .build())
        .publicIpPrefixes(SubResourceArgs.builder()
            .id("string")
            .build())
        .sku(NatGatewaySkuArgs.builder()
            .name("string")
            .build())
        .tags(Map.of("string", "string"))
        .zones("string")
        .build())
    .prefixLength(0)
    .publicIPAddressVersion("string")
    .publicIpPrefixName("string")
    .extendedLocation(ExtendedLocationArgs.builder()
        .name("string")
        .type("string")
        .build())
    .sku(PublicIPPrefixSkuArgs.builder()
        .name("string")
        .tier("string")
        .build())
    .tags(Map.of("string", "string"))
    .zones("string")
    .build());

    public_ip_prefix_resource = azure_native.network.PublicIPPrefix("publicIPPrefixResource",
    resource_group_name="string",
    ip_tags=[{
        "ip_tag_type": "string",
        "tag": "string",
    }],
    id="string",
    custom_ip_prefix={
        "id": "string",
    },
    location="string",
    nat_gateway={
        "id": "string",
        "idle_timeout_in_minutes": 0,
        "location": "string",
        "public_ip_addresses": [{
            "id": "string",
        }],
        "public_ip_prefixes": [{
            "id": "string",
        }],
        "sku": {
            "name": "string",
        },
        "tags": {
            "string": "string",
        },
        "zones": ["string"],
    },
    prefix_length=0,
    public_ip_address_version="string",
    public_ip_prefix_name="string",
    extended_location={
        "name": "string",
        "type": "string",
    },
    sku={
        "name": "string",
        "tier": "string",
    },
    tags={
        "string": "string",
    },
    zones=["string"])

    const publicIPPrefixResource = new azure_native.network.PublicIPPrefix("publicIPPrefixResource", {
    resourceGroupName: "string",
    ipTags: [{
        ipTagType: "string",
        tag: "string",
    }],
    id: "string",
    customIPPrefix: {
        id: "string",
    },
    location: "string",
    natGateway: {
        id: "string",
        idleTimeoutInMinutes: 0,
        location: "string",
        publicIpAddresses: [{
            id: "string",
        }],
        publicIpPrefixes: [{
            id: "string",
        }],
        sku: {
            name: "string",
        },
        tags: {
            string: "string",
        },
        zones: ["string"],
    },
    prefixLength: 0,
    publicIPAddressVersion: "string",
    publicIpPrefixName: "string",
    extendedLocation: {
        name: "string",
        type: "string",
    },
    sku: {
        name: "string",
        tier: "string",
    },
    tags: {
        string: "string",
    },
    zones: ["string"],
});

    type: azure-native:network:PublicIPPrefix
properties:
    customIPPrefix:
        id: string
    extendedLocation:
        name: string
        type: string
    id: string
    ipTags:
        - ipTagType: string
          tag: string
    location: string
    natGateway:
        id: string
        idleTimeoutInMinutes: 0
        location: string
        publicIpAddresses:
            - id: string
        publicIpPrefixes:
            - id: string
        sku:
            name: string
        tags:
            string: string
        zones:
            - string
    prefixLength: 0
    publicIPAddressVersion: string
    publicIpPrefixName: string
    resourceGroupName: string
    sku:
        name: string
        tier: string
    tags:
        string: string
    zones:
        - string

    PublicIPPrefix 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 PublicIPPrefix resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group.
    CustomIPPrefix Pulumi.AzureNative.Network.Inputs.SubResource
    The customIpPrefix that this prefix is associated with.
    ExtendedLocation Pulumi.AzureNative.Network.Inputs.ExtendedLocation
    The extended location of the public ip address.
    Id string
    Resource ID.
    IpTags List<Pulumi.AzureNative.Network.Inputs.IpTag>
    The list of tags associated with the public IP prefix.
    Location string
    Resource location.
    NatGateway Pulumi.AzureNative.Network.Inputs.NatGateway
    NatGateway of Public IP Prefix.
    PrefixLength int
    The Length of the Public IP Prefix.
    PublicIPAddressVersion string | Pulumi.AzureNative.Network.IPVersion
    The public IP address version.
    PublicIpPrefixName string
    The name of the public IP prefix.
    Sku Pulumi.AzureNative.Network.Inputs.PublicIPPrefixSku
    The public IP prefix SKU.
    Tags Dictionary<string, string>
    Resource tags.
    Zones List<string>
    A list of availability zones denoting the IP allocated for the resource needs to come from.
    ResourceGroupName string
    The name of the resource group.
    CustomIPPrefix SubResourceArgs
    The customIpPrefix that this prefix is associated with.
    ExtendedLocation ExtendedLocationArgs
    The extended location of the public ip address.
    Id string
    Resource ID.
    IpTags []IpTagArgs
    The list of tags associated with the public IP prefix.
    Location string
    Resource location.
    NatGateway NatGatewayTypeArgs
    NatGateway of Public IP Prefix.
    PrefixLength int
    The Length of the Public IP Prefix.
    PublicIPAddressVersion string | IPVersion
    The public IP address version.
    PublicIpPrefixName string
    The name of the public IP prefix.
    Sku PublicIPPrefixSkuArgs
    The public IP prefix SKU.
    Tags map[string]string
    Resource tags.
    Zones []string
    A list of availability zones denoting the IP allocated for the resource needs to come from.
    resourceGroupName String
    The name of the resource group.
    customIPPrefix SubResource
    The customIpPrefix that this prefix is associated with.
    extendedLocation ExtendedLocation
    The extended location of the public ip address.
    id String
    Resource ID.
    ipTags List<IpTag>
    The list of tags associated with the public IP prefix.
    location String
    Resource location.
    natGateway NatGateway
    NatGateway of Public IP Prefix.
    prefixLength Integer
    The Length of the Public IP Prefix.
    publicIPAddressVersion String | IPVersion
    The public IP address version.
    publicIpPrefixName String
    The name of the public IP prefix.
    sku PublicIPPrefixSku
    The public IP prefix SKU.
    tags Map<String,String>
    Resource tags.
    zones List<String>
    A list of availability zones denoting the IP allocated for the resource needs to come from.
    resourceGroupName string
    The name of the resource group.
    customIPPrefix SubResource
    The customIpPrefix that this prefix is associated with.
    extendedLocation ExtendedLocation
    The extended location of the public ip address.
    id string
    Resource ID.
    ipTags IpTag[]
    The list of tags associated with the public IP prefix.
    location string
    Resource location.
    natGateway NatGateway
    NatGateway of Public IP Prefix.
    prefixLength number
    The Length of the Public IP Prefix.
    publicIPAddressVersion string | IPVersion
    The public IP address version.
    publicIpPrefixName string
    The name of the public IP prefix.
    sku PublicIPPrefixSku
    The public IP prefix SKU.
    tags {[key: string]: string}
    Resource tags.
    zones string[]
    A list of availability zones denoting the IP allocated for the resource needs to come from.
    resource_group_name str
    The name of the resource group.
    custom_ip_prefix SubResourceArgs
    The customIpPrefix that this prefix is associated with.
    extended_location ExtendedLocationArgs
    The extended location of the public ip address.
    id str
    Resource ID.
    ip_tags Sequence[IpTagArgs]
    The list of tags associated with the public IP prefix.
    location str
    Resource location.
    nat_gateway NatGatewayArgs
    NatGateway of Public IP Prefix.
    prefix_length int
    The Length of the Public IP Prefix.
    public_ip_address_version str | IPVersion
    The public IP address version.
    public_ip_prefix_name str
    The name of the public IP prefix.
    sku PublicIPPrefixSkuArgs
    The public IP prefix SKU.
    tags Mapping[str, str]
    Resource tags.
    zones Sequence[str]
    A list of availability zones denoting the IP allocated for the resource needs to come from.
    resourceGroupName String
    The name of the resource group.
    customIPPrefix Property Map
    The customIpPrefix that this prefix is associated with.
    extendedLocation Property Map
    The extended location of the public ip address.
    id String
    Resource ID.
    ipTags List<Property Map>
    The list of tags associated with the public IP prefix.
    location String
    Resource location.
    natGateway Property Map
    NatGateway of Public IP Prefix.
    prefixLength Number
    The Length of the Public IP Prefix.
    publicIPAddressVersion String | "IPv4" | "IPv6"
    The public IP address version.
    publicIpPrefixName String
    The name of the public IP prefix.
    sku Property Map
    The public IP prefix SKU.
    tags Map<String>
    Resource tags.
    zones List<String>
    A list of availability zones denoting the IP allocated for the resource needs to come from.

    Outputs

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

    AzureApiVersion string
    The Azure API version of the resource.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpPrefix string
    The allocated Prefix.
    LoadBalancerFrontendIpConfiguration Pulumi.AzureNative.Network.Outputs.SubResourceResponse
    The reference to load balancer frontend IP configuration associated with the public IP prefix.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the public IP prefix resource.
    PublicIPAddresses List<Pulumi.AzureNative.Network.Outputs.ReferencedPublicIpAddressResponse>
    The list of all referenced PublicIPAddresses.
    ResourceGuid string
    The resource GUID property of the public IP prefix resource.
    Type string
    Resource type.
    AzureApiVersion string
    The Azure API version of the resource.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpPrefix string
    The allocated Prefix.
    LoadBalancerFrontendIpConfiguration SubResourceResponse
    The reference to load balancer frontend IP configuration associated with the public IP prefix.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the public IP prefix resource.
    PublicIPAddresses []ReferencedPublicIpAddressResponse
    The list of all referenced PublicIPAddresses.
    ResourceGuid string
    The resource GUID property of the public IP prefix resource.
    Type string
    Resource type.
    azureApiVersion String
    The Azure API version of the resource.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    The provider-assigned unique ID for this managed resource.
    ipPrefix String
    The allocated Prefix.
    loadBalancerFrontendIpConfiguration SubResourceResponse
    The reference to load balancer frontend IP configuration associated with the public IP prefix.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the public IP prefix resource.
    publicIPAddresses List<ReferencedPublicIpAddressResponse>
    The list of all referenced PublicIPAddresses.
    resourceGuid String
    The resource GUID property of the public IP prefix resource.
    type String
    Resource type.
    azureApiVersion string
    The Azure API version of the resource.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    id string
    The provider-assigned unique ID for this managed resource.
    ipPrefix string
    The allocated Prefix.
    loadBalancerFrontendIpConfiguration SubResourceResponse
    The reference to load balancer frontend IP configuration associated with the public IP prefix.
    name string
    Resource name.
    provisioningState string
    The provisioning state of the public IP prefix resource.
    publicIPAddresses ReferencedPublicIpAddressResponse[]
    The list of all referenced PublicIPAddresses.
    resourceGuid string
    The resource GUID property of the public IP prefix resource.
    type string
    Resource type.
    azure_api_version str
    The Azure API version of the resource.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    id str
    The provider-assigned unique ID for this managed resource.
    ip_prefix str
    The allocated Prefix.
    load_balancer_frontend_ip_configuration SubResourceResponse
    The reference to load balancer frontend IP configuration associated with the public IP prefix.
    name str
    Resource name.
    provisioning_state str
    The provisioning state of the public IP prefix resource.
    public_ip_addresses Sequence[ReferencedPublicIpAddressResponse]
    The list of all referenced PublicIPAddresses.
    resource_guid str
    The resource GUID property of the public IP prefix resource.
    type str
    Resource type.
    azureApiVersion String
    The Azure API version of the resource.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    The provider-assigned unique ID for this managed resource.
    ipPrefix String
    The allocated Prefix.
    loadBalancerFrontendIpConfiguration Property Map
    The reference to load balancer frontend IP configuration associated with the public IP prefix.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the public IP prefix resource.
    publicIPAddresses List<Property Map>
    The list of all referenced PublicIPAddresses.
    resourceGuid String
    The resource GUID property of the public IP prefix resource.
    type String
    Resource type.

    Supporting Types

    ExtendedLocation, ExtendedLocationArgs

    Name string
    The name of the extended location.
    Type string | Pulumi.AzureNative.Network.ExtendedLocationTypes
    The type of the extended location.
    Name string
    The name of the extended location.
    Type string | ExtendedLocationTypes
    The type of the extended location.
    name String
    The name of the extended location.
    type String | ExtendedLocationTypes
    The type of the extended location.
    name string
    The name of the extended location.
    type string | ExtendedLocationTypes
    The type of the extended location.
    name str
    The name of the extended location.
    type str | ExtendedLocationTypes
    The type of the extended location.
    name String
    The name of the extended location.
    type String | "EdgeZone"
    The type of the extended location.

    ExtendedLocationResponse, ExtendedLocationResponseArgs

    Name string
    The name of the extended location.
    Type string
    The type of the extended location.
    Name string
    The name of the extended location.
    Type string
    The type of the extended location.
    name String
    The name of the extended location.
    type String
    The type of the extended location.
    name string
    The name of the extended location.
    type string
    The type of the extended location.
    name str
    The name of the extended location.
    type str
    The type of the extended location.
    name String
    The name of the extended location.
    type String
    The type of the extended location.

    ExtendedLocationTypes, ExtendedLocationTypesArgs

    EdgeZone
    EdgeZone
    ExtendedLocationTypesEdgeZone
    EdgeZone
    EdgeZone
    EdgeZone
    EdgeZone
    EdgeZone
    EDGE_ZONE
    EdgeZone
    "EdgeZone"
    EdgeZone

    IPVersion, IPVersionArgs

    IPv4
    IPv4
    IPv6
    IPv6
    IPVersionIPv4
    IPv4
    IPVersionIPv6
    IPv6
    IPv4
    IPv4
    IPv6
    IPv6
    IPv4
    IPv4
    IPv6
    IPv6
    I_PV4
    IPv4
    I_PV6
    IPv6
    "IPv4"
    IPv4
    "IPv6"
    IPv6

    IpTag, IpTagArgs

    IpTagType string
    The IP tag type. Example: FirstPartyUsage.
    Tag string
    The value of the IP tag associated with the public IP. Example: SQL.
    IpTagType string
    The IP tag type. Example: FirstPartyUsage.
    Tag string
    The value of the IP tag associated with the public IP. Example: SQL.
    ipTagType String
    The IP tag type. Example: FirstPartyUsage.
    tag String
    The value of the IP tag associated with the public IP. Example: SQL.
    ipTagType string
    The IP tag type. Example: FirstPartyUsage.
    tag string
    The value of the IP tag associated with the public IP. Example: SQL.
    ip_tag_type str
    The IP tag type. Example: FirstPartyUsage.
    tag str
    The value of the IP tag associated with the public IP. Example: SQL.
    ipTagType String
    The IP tag type. Example: FirstPartyUsage.
    tag String
    The value of the IP tag associated with the public IP. Example: SQL.

    IpTagResponse, IpTagResponseArgs

    IpTagType string
    The IP tag type. Example: FirstPartyUsage.
    Tag string
    The value of the IP tag associated with the public IP. Example: SQL.
    IpTagType string
    The IP tag type. Example: FirstPartyUsage.
    Tag string
    The value of the IP tag associated with the public IP. Example: SQL.
    ipTagType String
    The IP tag type. Example: FirstPartyUsage.
    tag String
    The value of the IP tag associated with the public IP. Example: SQL.
    ipTagType string
    The IP tag type. Example: FirstPartyUsage.
    tag string
    The value of the IP tag associated with the public IP. Example: SQL.
    ip_tag_type str
    The IP tag type. Example: FirstPartyUsage.
    tag str
    The value of the IP tag associated with the public IP. Example: SQL.
    ipTagType String
    The IP tag type. Example: FirstPartyUsage.
    tag String
    The value of the IP tag associated with the public IP. Example: SQL.

    NatGateway, NatGatewayArgs

    Id string
    Resource ID.
    IdleTimeoutInMinutes int
    The idle timeout of the nat gateway.
    Location string
    Resource location.
    PublicIpAddresses List<Pulumi.AzureNative.Network.Inputs.SubResource>
    An array of public ip addresses associated with the nat gateway resource.
    PublicIpPrefixes List<Pulumi.AzureNative.Network.Inputs.SubResource>
    An array of public ip prefixes associated with the nat gateway resource.
    Sku Pulumi.AzureNative.Network.Inputs.NatGatewaySku
    The nat gateway SKU.
    Tags Dictionary<string, string>
    Resource tags.
    Zones List<string>
    A list of availability zones denoting the zone in which Nat Gateway should be deployed.
    Id string
    Resource ID.
    IdleTimeoutInMinutes int
    The idle timeout of the nat gateway.
    Location string
    Resource location.
    PublicIpAddresses []SubResource
    An array of public ip addresses associated with the nat gateway resource.
    PublicIpPrefixes []SubResource
    An array of public ip prefixes associated with the nat gateway resource.
    Sku NatGatewaySku
    The nat gateway SKU.
    Tags map[string]string
    Resource tags.
    Zones []string
    A list of availability zones denoting the zone in which Nat Gateway should be deployed.
    id String
    Resource ID.
    idleTimeoutInMinutes Integer
    The idle timeout of the nat gateway.
    location String
    Resource location.
    publicIpAddresses List<SubResource>
    An array of public ip addresses associated with the nat gateway resource.
    publicIpPrefixes List<SubResource>
    An array of public ip prefixes associated with the nat gateway resource.
    sku NatGatewaySku
    The nat gateway SKU.
    tags Map<String,String>
    Resource tags.
    zones List<String>
    A list of availability zones denoting the zone in which Nat Gateway should be deployed.
    id string
    Resource ID.
    idleTimeoutInMinutes number
    The idle timeout of the nat gateway.
    location string
    Resource location.
    publicIpAddresses SubResource[]
    An array of public ip addresses associated with the nat gateway resource.
    publicIpPrefixes SubResource[]
    An array of public ip prefixes associated with the nat gateway resource.
    sku NatGatewaySku
    The nat gateway SKU.
    tags {[key: string]: string}
    Resource tags.
    zones string[]
    A list of availability zones denoting the zone in which Nat Gateway should be deployed.
    id str
    Resource ID.
    idle_timeout_in_minutes int
    The idle timeout of the nat gateway.
    location str
    Resource location.
    public_ip_addresses Sequence[SubResource]
    An array of public ip addresses associated with the nat gateway resource.
    public_ip_prefixes Sequence[SubResource]
    An array of public ip prefixes associated with the nat gateway resource.
    sku NatGatewaySku
    The nat gateway SKU.
    tags Mapping[str, str]
    Resource tags.
    zones Sequence[str]
    A list of availability zones denoting the zone in which Nat Gateway should be deployed.
    id String
    Resource ID.
    idleTimeoutInMinutes Number
    The idle timeout of the nat gateway.
    location String
    Resource location.
    publicIpAddresses List<Property Map>
    An array of public ip addresses associated with the nat gateway resource.
    publicIpPrefixes List<Property Map>
    An array of public ip prefixes associated with the nat gateway resource.
    sku Property Map
    The nat gateway SKU.
    tags Map<String>
    Resource tags.
    zones List<String>
    A list of availability zones denoting the zone in which Nat Gateway should be deployed.

    NatGatewayResponse, NatGatewayResponseArgs

    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the NAT gateway resource.
    ResourceGuid string
    The resource GUID property of the NAT gateway resource.
    Subnets List<Pulumi.AzureNative.Network.Inputs.SubResourceResponse>
    An array of references to the subnets using this nat gateway resource.
    Type string
    Resource type.
    Id string
    Resource ID.
    IdleTimeoutInMinutes int
    The idle timeout of the nat gateway.
    Location string
    Resource location.
    PublicIpAddresses List<Pulumi.AzureNative.Network.Inputs.SubResourceResponse>
    An array of public ip addresses associated with the nat gateway resource.
    PublicIpPrefixes List<Pulumi.AzureNative.Network.Inputs.SubResourceResponse>
    An array of public ip prefixes associated with the nat gateway resource.
    Sku Pulumi.AzureNative.Network.Inputs.NatGatewaySkuResponse
    The nat gateway SKU.
    Tags Dictionary<string, string>
    Resource tags.
    Zones List<string>
    A list of availability zones denoting the zone in which Nat Gateway should be deployed.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the NAT gateway resource.
    ResourceGuid string
    The resource GUID property of the NAT gateway resource.
    Subnets []SubResourceResponse
    An array of references to the subnets using this nat gateway resource.
    Type string
    Resource type.
    Id string
    Resource ID.
    IdleTimeoutInMinutes int
    The idle timeout of the nat gateway.
    Location string
    Resource location.
    PublicIpAddresses []SubResourceResponse
    An array of public ip addresses associated with the nat gateway resource.
    PublicIpPrefixes []SubResourceResponse
    An array of public ip prefixes associated with the nat gateway resource.
    Sku NatGatewaySkuResponse
    The nat gateway SKU.
    Tags map[string]string
    Resource tags.
    Zones []string
    A list of availability zones denoting the zone in which Nat Gateway should be deployed.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the NAT gateway resource.
    resourceGuid String
    The resource GUID property of the NAT gateway resource.
    subnets List<SubResourceResponse>
    An array of references to the subnets using this nat gateway resource.
    type String
    Resource type.
    id String
    Resource ID.
    idleTimeoutInMinutes Integer
    The idle timeout of the nat gateway.
    location String
    Resource location.
    publicIpAddresses List<SubResourceResponse>
    An array of public ip addresses associated with the nat gateway resource.
    publicIpPrefixes List<SubResourceResponse>
    An array of public ip prefixes associated with the nat gateway resource.
    sku NatGatewaySkuResponse
    The nat gateway SKU.
    tags Map<String,String>
    Resource tags.
    zones List<String>
    A list of availability zones denoting the zone in which Nat Gateway should be deployed.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    name string
    Resource name.
    provisioningState string
    The provisioning state of the NAT gateway resource.
    resourceGuid string
    The resource GUID property of the NAT gateway resource.
    subnets SubResourceResponse[]
    An array of references to the subnets using this nat gateway resource.
    type string
    Resource type.
    id string
    Resource ID.
    idleTimeoutInMinutes number
    The idle timeout of the nat gateway.
    location string
    Resource location.
    publicIpAddresses SubResourceResponse[]
    An array of public ip addresses associated with the nat gateway resource.
    publicIpPrefixes SubResourceResponse[]
    An array of public ip prefixes associated with the nat gateway resource.
    sku NatGatewaySkuResponse
    The nat gateway SKU.
    tags {[key: string]: string}
    Resource tags.
    zones string[]
    A list of availability zones denoting the zone in which Nat Gateway should be deployed.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    name str
    Resource name.
    provisioning_state str
    The provisioning state of the NAT gateway resource.
    resource_guid str
    The resource GUID property of the NAT gateway resource.
    subnets Sequence[SubResourceResponse]
    An array of references to the subnets using this nat gateway resource.
    type str
    Resource type.
    id str
    Resource ID.
    idle_timeout_in_minutes int
    The idle timeout of the nat gateway.
    location str
    Resource location.
    public_ip_addresses Sequence[SubResourceResponse]
    An array of public ip addresses associated with the nat gateway resource.
    public_ip_prefixes Sequence[SubResourceResponse]
    An array of public ip prefixes associated with the nat gateway resource.
    sku NatGatewaySkuResponse
    The nat gateway SKU.
    tags Mapping[str, str]
    Resource tags.
    zones Sequence[str]
    A list of availability zones denoting the zone in which Nat Gateway should be deployed.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the NAT gateway resource.
    resourceGuid String
    The resource GUID property of the NAT gateway resource.
    subnets List<Property Map>
    An array of references to the subnets using this nat gateway resource.
    type String
    Resource type.
    id String
    Resource ID.
    idleTimeoutInMinutes Number
    The idle timeout of the nat gateway.
    location String
    Resource location.
    publicIpAddresses List<Property Map>
    An array of public ip addresses associated with the nat gateway resource.
    publicIpPrefixes List<Property Map>
    An array of public ip prefixes associated with the nat gateway resource.
    sku Property Map
    The nat gateway SKU.
    tags Map<String>
    Resource tags.
    zones List<String>
    A list of availability zones denoting the zone in which Nat Gateway should be deployed.

    NatGatewaySku, NatGatewaySkuArgs

    Name string | Pulumi.AzureNative.Network.NatGatewaySkuName
    Name of Nat Gateway SKU.
    Name string | NatGatewaySkuName
    Name of Nat Gateway SKU.
    name String | NatGatewaySkuName
    Name of Nat Gateway SKU.
    name string | NatGatewaySkuName
    Name of Nat Gateway SKU.
    name str | NatGatewaySkuName
    Name of Nat Gateway SKU.
    name String | "Standard"
    Name of Nat Gateway SKU.

    NatGatewaySkuName, NatGatewaySkuNameArgs

    Standard
    Standard
    NatGatewaySkuNameStandard
    Standard
    Standard
    Standard
    Standard
    Standard
    STANDARD
    Standard
    "Standard"
    Standard

    NatGatewaySkuResponse, NatGatewaySkuResponseArgs

    Name string
    Name of Nat Gateway SKU.
    Name string
    Name of Nat Gateway SKU.
    name String
    Name of Nat Gateway SKU.
    name string
    Name of Nat Gateway SKU.
    name str
    Name of Nat Gateway SKU.
    name String
    Name of Nat Gateway SKU.

    PublicIPPrefixSku, PublicIPPrefixSkuArgs

    Name string | Pulumi.AzureNative.Network.PublicIPPrefixSkuName
    Name of a public IP prefix SKU.
    Tier string | Pulumi.AzureNative.Network.PublicIPPrefixSkuTier
    Tier of a public IP prefix SKU.
    Name string | PublicIPPrefixSkuName
    Name of a public IP prefix SKU.
    Tier string | PublicIPPrefixSkuTier
    Tier of a public IP prefix SKU.
    name String | PublicIPPrefixSkuName
    Name of a public IP prefix SKU.
    tier String | PublicIPPrefixSkuTier
    Tier of a public IP prefix SKU.
    name string | PublicIPPrefixSkuName
    Name of a public IP prefix SKU.
    tier string | PublicIPPrefixSkuTier
    Tier of a public IP prefix SKU.
    name str | PublicIPPrefixSkuName
    Name of a public IP prefix SKU.
    tier str | PublicIPPrefixSkuTier
    Tier of a public IP prefix SKU.
    name String | "Standard"
    Name of a public IP prefix SKU.
    tier String | "Regional" | "Global"
    Tier of a public IP prefix SKU.

    PublicIPPrefixSkuName, PublicIPPrefixSkuNameArgs

    Standard
    Standard
    PublicIPPrefixSkuNameStandard
    Standard
    Standard
    Standard
    Standard
    Standard
    STANDARD
    Standard
    "Standard"
    Standard

    PublicIPPrefixSkuResponse, PublicIPPrefixSkuResponseArgs

    Name string
    Name of a public IP prefix SKU.
    Tier string
    Tier of a public IP prefix SKU.
    Name string
    Name of a public IP prefix SKU.
    Tier string
    Tier of a public IP prefix SKU.
    name String
    Name of a public IP prefix SKU.
    tier String
    Tier of a public IP prefix SKU.
    name string
    Name of a public IP prefix SKU.
    tier string
    Tier of a public IP prefix SKU.
    name str
    Name of a public IP prefix SKU.
    tier str
    Tier of a public IP prefix SKU.
    name String
    Name of a public IP prefix SKU.
    tier String
    Tier of a public IP prefix SKU.

    PublicIPPrefixSkuTier, PublicIPPrefixSkuTierArgs

    Regional
    Regional
    Global
    Global
    PublicIPPrefixSkuTierRegional
    Regional
    PublicIPPrefixSkuTierGlobal
    Global
    Regional
    Regional
    Global
    Global
    Regional
    Regional
    Global
    Global
    REGIONAL
    Regional
    GLOBAL_
    Global
    "Regional"
    Regional
    "Global"
    Global

    ReferencedPublicIpAddressResponse, ReferencedPublicIpAddressResponseArgs

    Id string
    The PublicIPAddress Reference.
    Id string
    The PublicIPAddress Reference.
    id String
    The PublicIPAddress Reference.
    id string
    The PublicIPAddress Reference.
    id str
    The PublicIPAddress Reference.
    id String
    The PublicIPAddress Reference.

    SubResource, SubResourceArgs

    Id string
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    Id string
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id String
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id string
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id str
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id String
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.

    SubResourceResponse, SubResourceResponseArgs

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:network:PublicIPPrefix test-ipprefix /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIpPrefixName}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.5.0 published on Monday, May 19, 2025 by Pulumi
    pulumi/pulumi-azure-native