Docs Packages
  1. Pulumi Registry
  2. Azure Classic
  3. API Docs
  4. network
  5. PublicIpPrefix
azure logo
Azure Classic v5.43.0, May 6 23

azure.network.PublicIpPrefix

Explore with Pulumi AI

Manages a Public IP Prefix.

Example Usage

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

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

    var examplePublicIpPrefix = new Azure.Network.PublicIpPrefix("examplePublicIpPrefix", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        PrefixLength = 31,
        Tags = 
        {
            { "environment", "Production" },
        },
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = network.NewPublicIpPrefix(ctx, "examplePublicIpPrefix", &network.PublicIpPrefixArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			PrefixLength:      pulumi.Int(31),
			Tags: pulumi.StringMap{
				"environment": pulumi.String("Production"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

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

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

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

        var examplePublicIpPrefix = new PublicIpPrefix("examplePublicIpPrefix", PublicIpPrefixArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .prefixLength(31)
            .tags(Map.of("environment", "Production"))
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_public_ip_prefix = azure.network.PublicIpPrefix("examplePublicIpPrefix",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    prefix_length=31,
    tags={
        "environment": "Production",
    })

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const examplePublicIpPrefix = new azure.network.PublicIpPrefix("examplePublicIpPrefix", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    prefixLength: 31,
    tags: {
        environment: "Production",
    },
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  examplePublicIpPrefix:
    type: azure:network:PublicIpPrefix
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      prefixLength: 31
      tags:
        environment: Production

Create PublicIpPrefix Resource

new PublicIpPrefix(name: string, args: PublicIpPrefixArgs, opts?: CustomResourceOptions);
@overload
def PublicIpPrefix(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   ip_version: Optional[str] = None,
                   location: Optional[str] = None,
                   name: Optional[str] = None,
                   prefix_length: Optional[int] = None,
                   resource_group_name: Optional[str] = None,
                   sku: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   zones: Optional[Sequence[str]] = None)
@overload
def PublicIpPrefix(resource_name: str,
                   args: PublicIpPrefixArgs,
                   opts: Optional[ResourceOptions] = 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:network:PublicIpPrefix
properties: # The arguments to resource properties.
options: # 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.
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.

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

The PublicIpPrefix resource accepts the following input properties:

ResourceGroupName string

The name of the resource group in which to create the Public IP Prefix. Changing this forces a new resource to be created.

IpVersion string

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

Location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Name string

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

PrefixLength int

Specifies the number of bits of the prefix. The value can be set between 0 (4,294,967,296 addresses) and 31 (2 addresses). Defaults to 28(16 addresses). Changing this forces a new resource to be created.

Sku string

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

Tags Dictionary<string, string>

A mapping of tags to assign to the resource.

Zones List<string>

Specifies a list of Availability Zones in which this Public IP Prefix should be located. Changing this forces a new Public IP Prefix to be created.

ResourceGroupName string

The name of the resource group in which to create the Public IP Prefix. Changing this forces a new resource to be created.

IpVersion string

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

Location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Name string

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

PrefixLength int

Specifies the number of bits of the prefix. The value can be set between 0 (4,294,967,296 addresses) and 31 (2 addresses). Defaults to 28(16 addresses). Changing this forces a new resource to be created.

Sku string

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

Tags map[string]string

A mapping of tags to assign to the resource.

Zones []string

Specifies a list of Availability Zones in which this Public IP Prefix should be located. Changing this forces a new Public IP Prefix to be created.

resourceGroupName String

The name of the resource group in which to create the Public IP Prefix. Changing this forces a new resource to be created.

ipVersion String

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

location String

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name String

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

prefixLength Integer

Specifies the number of bits of the prefix. The value can be set between 0 (4,294,967,296 addresses) and 31 (2 addresses). Defaults to 28(16 addresses). Changing this forces a new resource to be created.

sku String

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

tags Map<String,String>

A mapping of tags to assign to the resource.

zones List<String>

Specifies a list of Availability Zones in which this Public IP Prefix should be located. Changing this forces a new Public IP Prefix to be created.

resourceGroupName string

The name of the resource group in which to create the Public IP Prefix. Changing this forces a new resource to be created.

ipVersion string

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

location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name string

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

prefixLength number

Specifies the number of bits of the prefix. The value can be set between 0 (4,294,967,296 addresses) and 31 (2 addresses). Defaults to 28(16 addresses). Changing this forces a new resource to be created.

sku string

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

tags {[key: string]: string}

A mapping of tags to assign to the resource.

zones string[]

Specifies a list of Availability Zones in which this Public IP Prefix should be located. Changing this forces a new Public IP Prefix to be created.

resource_group_name str

The name of the resource group in which to create the Public IP Prefix. Changing this forces a new resource to be created.

ip_version str

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

location str

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name str

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

prefix_length int

Specifies the number of bits of the prefix. The value can be set between 0 (4,294,967,296 addresses) and 31 (2 addresses). Defaults to 28(16 addresses). Changing this forces a new resource to be created.

sku str

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

tags Mapping[str, str]

A mapping of tags to assign to the resource.

zones Sequence[str]

Specifies a list of Availability Zones in which this Public IP Prefix should be located. Changing this forces a new Public IP Prefix to be created.

resourceGroupName String

The name of the resource group in which to create the Public IP Prefix. Changing this forces a new resource to be created.

ipVersion String

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

location String

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name String

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

prefixLength Number

Specifies the number of bits of the prefix. The value can be set between 0 (4,294,967,296 addresses) and 31 (2 addresses). Defaults to 28(16 addresses). Changing this forces a new resource to be created.

sku String

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

tags Map<String>

A mapping of tags to assign to the resource.

zones List<String>

Specifies a list of Availability Zones in which this Public IP Prefix should be located. Changing this forces a new Public IP Prefix to be created.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

IpPrefix string

The IP address prefix value that was allocated.

Id string

The provider-assigned unique ID for this managed resource.

IpPrefix string

The IP address prefix value that was allocated.

id String

The provider-assigned unique ID for this managed resource.

ipPrefix String

The IP address prefix value that was allocated.

id string

The provider-assigned unique ID for this managed resource.

ipPrefix string

The IP address prefix value that was allocated.

id str

The provider-assigned unique ID for this managed resource.

ip_prefix str

The IP address prefix value that was allocated.

id String

The provider-assigned unique ID for this managed resource.

ipPrefix String

The IP address prefix value that was allocated.

Look up Existing PublicIpPrefix Resource

Get an existing PublicIpPrefix 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?: PublicIpPrefixState, opts?: CustomResourceOptions): PublicIpPrefix
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ip_prefix: Optional[str] = None,
        ip_version: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        prefix_length: Optional[int] = None,
        resource_group_name: Optional[str] = None,
        sku: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        zones: Optional[Sequence[str]] = None) -> PublicIpPrefix
func GetPublicIpPrefix(ctx *Context, name string, id IDInput, state *PublicIpPrefixState, opts ...ResourceOption) (*PublicIpPrefix, error)
public static PublicIpPrefix Get(string name, Input<string> id, PublicIpPrefixState? state, CustomResourceOptions? opts = null)
public static PublicIpPrefix get(String name, Output<String> id, PublicIpPrefixState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
IpPrefix string

The IP address prefix value that was allocated.

IpVersion string

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

Location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Name string

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

PrefixLength int

Specifies the number of bits of the prefix. The value can be set between 0 (4,294,967,296 addresses) and 31 (2 addresses). Defaults to 28(16 addresses). Changing this forces a new resource to be created.

ResourceGroupName string

The name of the resource group in which to create the Public IP Prefix. Changing this forces a new resource to be created.

Sku string

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

Tags Dictionary<string, string>

A mapping of tags to assign to the resource.

Zones List<string>

Specifies a list of Availability Zones in which this Public IP Prefix should be located. Changing this forces a new Public IP Prefix to be created.

IpPrefix string

The IP address prefix value that was allocated.

IpVersion string

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

Location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Name string

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

PrefixLength int

Specifies the number of bits of the prefix. The value can be set between 0 (4,294,967,296 addresses) and 31 (2 addresses). Defaults to 28(16 addresses). Changing this forces a new resource to be created.

ResourceGroupName string

The name of the resource group in which to create the Public IP Prefix. Changing this forces a new resource to be created.

Sku string

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

Tags map[string]string

A mapping of tags to assign to the resource.

Zones []string

Specifies a list of Availability Zones in which this Public IP Prefix should be located. Changing this forces a new Public IP Prefix to be created.

ipPrefix String

The IP address prefix value that was allocated.

ipVersion String

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

location String

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name String

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

prefixLength Integer

Specifies the number of bits of the prefix. The value can be set between 0 (4,294,967,296 addresses) and 31 (2 addresses). Defaults to 28(16 addresses). Changing this forces a new resource to be created.

resourceGroupName String

The name of the resource group in which to create the Public IP Prefix. Changing this forces a new resource to be created.

sku String

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

tags Map<String,String>

A mapping of tags to assign to the resource.

zones List<String>

Specifies a list of Availability Zones in which this Public IP Prefix should be located. Changing this forces a new Public IP Prefix to be created.

ipPrefix string

The IP address prefix value that was allocated.

ipVersion string

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

location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name string

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

prefixLength number

Specifies the number of bits of the prefix. The value can be set between 0 (4,294,967,296 addresses) and 31 (2 addresses). Defaults to 28(16 addresses). Changing this forces a new resource to be created.

resourceGroupName string

The name of the resource group in which to create the Public IP Prefix. Changing this forces a new resource to be created.

sku string

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

tags {[key: string]: string}

A mapping of tags to assign to the resource.

zones string[]

Specifies a list of Availability Zones in which this Public IP Prefix should be located. Changing this forces a new Public IP Prefix to be created.

ip_prefix str

The IP address prefix value that was allocated.

ip_version str

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

location str

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name str

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

prefix_length int

Specifies the number of bits of the prefix. The value can be set between 0 (4,294,967,296 addresses) and 31 (2 addresses). Defaults to 28(16 addresses). Changing this forces a new resource to be created.

resource_group_name str

The name of the resource group in which to create the Public IP Prefix. Changing this forces a new resource to be created.

sku str

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

tags Mapping[str, str]

A mapping of tags to assign to the resource.

zones Sequence[str]

Specifies a list of Availability Zones in which this Public IP Prefix should be located. Changing this forces a new Public IP Prefix to be created.

ipPrefix String

The IP address prefix value that was allocated.

ipVersion String

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

location String

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name String

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

prefixLength Number

Specifies the number of bits of the prefix. The value can be set between 0 (4,294,967,296 addresses) and 31 (2 addresses). Defaults to 28(16 addresses). Changing this forces a new resource to be created.

resourceGroupName String

The name of the resource group in which to create the Public IP Prefix. Changing this forces a new resource to be created.

sku String

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

tags Map<String>

A mapping of tags to assign to the resource.

zones List<String>

Specifies a list of Availability Zones in which this Public IP Prefix should be located. Changing this forces a new Public IP Prefix to be created.

Import

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

 $ pulumi import azure:network/publicIpPrefix:PublicIpPrefix myPublicIpPrefix /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/publicIPPrefixes/myPublicIpPrefix1

Package Details

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

This Pulumi package is based on the azurerm Terraform Provider.