PublicIpPrefix

Manages a Public IP Prefix.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var examplePublicIpPrefix = new Azure.Network.PublicIpPrefix("examplePublicIpPrefix", new Azure.Network.PublicIpPrefixArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            PrefixLength = 31,
            Tags = 
            {
                { "environment", "Production" },
            },
        });
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        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.Map{
                "environment": pulumi.String("Production"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

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",
    },
});

Create a PublicIpPrefix Resource

new PublicIpPrefix(name: string, args: PublicIpPrefixArgs, opts?: CustomResourceOptions);

def PublicIpPrefix(resource_name, opts=None, location=None, name=None, prefix_length=None, resource_group_name=None, sku=None, tags=None, zones=None, __props__=None);

func NewPublicIpPrefix(ctx *Context, name string, args PublicIpPrefixArgs, opts ...ResourceOption) (*PublicIpPrefix, error)

public PublicIpPrefix(string name, PublicIpPrefixArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

PublicIpPrefix Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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.
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 string: A collection containing the availability zone to allocate the Public IP Prefix in.

ResourceGroupName string: The name of the resource group in which to create the Public IP Prefix.
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: A collection containing the availability zone to allocate the Public IP Prefix in.

resourceGroupName string: The name of the resource group in which to create the Public IP Prefix.
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: A collection containing the availability zone to allocate the Public IP Prefix in.

resource_group_name str: The name of the resource group in which to create the Public IP Prefix.
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 float: 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 Dict[str, str]: A mapping of tags to assign to the resource.
zones str: A collection containing the availability zone to allocate the Public IP Prefix in.

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 str: The provider-assigned unique ID for this managed resource.
ip_prefix str: The IP address prefix value that was allocated.

Look up an 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

static get(resource_name, id, opts=None, ip_prefix=None, location=None, name=None, prefix_length=None, resource_group_name=None, sku=None, tags=None, zones=None, __props__=None);

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)

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.

The following state arguments are supported:

IpPrefix string: The IP address prefix value that was allocated.
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.
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 string: A collection containing the availability zone to allocate the Public IP Prefix in.

IpPrefix string: The IP address prefix value that was allocated.
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.
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: A collection containing the availability zone to allocate the Public IP Prefix in.

ipPrefix string: The IP address prefix value that was allocated.
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.
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: A collection containing the availability zone to allocate the Public IP Prefix in.

ip_prefix str: The IP address prefix value that was allocated.
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 float: 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.
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 Dict[str, str]: A mapping of tags to assign to the resource.
zones str: A collection containing the availability zone to allocate the Public IP Prefix in.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud