Azure Classic v6.2.0, Sep 27 24

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi

pulumi/pulumi-azure

azure.customip.Prefix

Explore with Pulumi AI

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi

pulumi/pulumi-azure

Example Usage

IPv4 custom prefix

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 examplePrefix = new azure.customip.Prefix("example", {
    name: "example-CustomIPPrefix",
    location: example.location,
    resourceGroupName: example.name,
    cidr: "1.2.3.4/22",
    zones: [
        "1",
        "2",
        "3",
    ],
    commissioningEnabled: true,
    roaValidityEndDate: "2099-12-12",
    wanValidationSignedMessage: "signed message for WAN validation",
    tags: {
        env: "test",
    },
});

import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_prefix = azure.customip.Prefix("example",
    name="example-CustomIPPrefix",
    location=example.location,
    resource_group_name=example.name,
    cidr="1.2.3.4/22",
    zones=[
        "1",
        "2",
        "3",
    ],
    commissioning_enabled=True,
    roa_validity_end_date="2099-12-12",
    wan_validation_signed_message="signed message for WAN validation",
    tags={
        "env": "test",
    })

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/customip"
	"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 = customip.NewPrefix(ctx, "example", &customip.PrefixArgs{
			Name:              pulumi.String("example-CustomIPPrefix"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Cidr:              pulumi.String("1.2.3.4/22"),
			Zones: pulumi.StringArray{
				pulumi.String("1"),
				pulumi.String("2"),
				pulumi.String("3"),
			},
			CommissioningEnabled:       pulumi.Bool(true),
			RoaValidityEndDate:         pulumi.String("2099-12-12"),
			WanValidationSignedMessage: pulumi.String("signed message for WAN validation"),
			Tags: pulumi.StringMap{
				"env": pulumi.String("test"),
			},
		})
		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 examplePrefix = new Azure.CustomIp.Prefix("example", new()
    {
        Name = "example-CustomIPPrefix",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Cidr = "1.2.3.4/22",
        Zones = new[]
        {
            "1",
            "2",
            "3",
        },
        CommissioningEnabled = true,
        RoaValidityEndDate = "2099-12-12",
        WanValidationSignedMessage = "signed message for WAN validation",
        Tags = 
        {
            { "env", "test" },
        },
    });

});

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.customip.Prefix;
import com.pulumi.azure.customip.PrefixArgs;
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 examplePrefix = new Prefix("examplePrefix", PrefixArgs.builder()
            .name("example-CustomIPPrefix")
            .location(example.location())
            .resourceGroupName(example.name())
            .cidr("1.2.3.4/22")
            .zones(            
                "1",
                "2",
                "3")
            .commissioningEnabled(true)
            .roaValidityEndDate("2099-12-12")
            .wanValidationSignedMessage("signed message for WAN validation")
            .tags(Map.of("env", "test"))
            .build());

    }
}

resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  examplePrefix:
    type: azure:customip:Prefix
    name: example
    properties:
      name: example-CustomIPPrefix
      location: ${example.location}
      resourceGroupName: ${example.name}
      cidr: 1.2.3.4/22
      zones:
        - '1'
        - '2'
        - '3'
      commissioningEnabled: true
      roaValidityEndDate: 2099-12-12
      wanValidationSignedMessage: signed message for WAN validation
      tags:
        env: test

IPv6 custom prefix

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

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const global = new azure.customip.Prefix("global", {
    name: "example-Global-CustomIPPrefix",
    location: test.location,
    resourceGroupName: test.name,
    cidr: "2001:db8:1::/48",
    roaValidityEndDate: "2199-12-12",
    wanValidationSignedMessage: "signed message for WAN validation",
});
const regional = new azure.customip.Prefix("regional", {
    name: "example-Regional-CustomIPPrefix",
    location: test.location,
    resourceGroupName: test.name,
    parentCustomIpPrefixId: global.id,
    cidr: global.cidr.apply(cidr => std.cidrsubnetOutput({
        input: cidr,
        newbits: 16,
        netnum: 1,
    })).apply(invoke => invoke.result),
    zones: ["1"],
});

import pulumi
import pulumi_azure as azure
import pulumi_std as std

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
global_ = azure.customip.Prefix("global",
    name="example-Global-CustomIPPrefix",
    location=test["location"],
    resource_group_name=test["name"],
    cidr="2001:db8:1::/48",
    roa_validity_end_date="2199-12-12",
    wan_validation_signed_message="signed message for WAN validation")
regional = azure.customip.Prefix("regional",
    name="example-Regional-CustomIPPrefix",
    location=test["location"],
    resource_group_name=test["name"],
    parent_custom_ip_prefix_id=global_.id,
    cidr=global_.cidr.apply(lambda cidr: std.cidrsubnet_output(input=cidr,
        newbits=16,
        netnum=1)).apply(lambda invoke: invoke.result),
    zones=["1"])

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/customip"
	"github.com/pulumi/pulumi-std/sdk/go/std"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		global, err := customip.NewPrefix(ctx, "global", &customip.PrefixArgs{
			Name:                       pulumi.String("example-Global-CustomIPPrefix"),
			Location:                   pulumi.Any(test.Location),
			ResourceGroupName:          pulumi.Any(test.Name),
			Cidr:                       pulumi.String("2001:db8:1::/48"),
			RoaValidityEndDate:         pulumi.String("2199-12-12"),
			WanValidationSignedMessage: pulumi.String("signed message for WAN validation"),
		})
		if err != nil {
			return err
		}
		_, err = customip.NewPrefix(ctx, "regional", &customip.PrefixArgs{
			Name:                   pulumi.String("example-Regional-CustomIPPrefix"),
			Location:               pulumi.Any(test.Location),
			ResourceGroupName:      pulumi.Any(test.Name),
			ParentCustomIpPrefixId: global.ID(),
			Cidr: pulumi.String(global.Cidr.ApplyT(func(cidr string) (std.CidrsubnetResult, error) {
				return std.CidrsubnetResult(interface{}(std.CidrsubnetOutput(ctx, std.CidrsubnetOutputArgs{
					Input:   cidr,
					Newbits: 16,
					Netnum:  1,
				}, nil))), nil
			}).(std.CidrsubnetResultOutput).ApplyT(func(invoke std.CidrsubnetResult) (*string, error) {
				return invoke.Result, nil
			}).(pulumi.StringPtrOutput)),
			Zones: pulumi.StringArray{
				pulumi.String("1"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

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

    var @global = new Azure.CustomIp.Prefix("global", new()
    {
        Name = "example-Global-CustomIPPrefix",
        Location = test.Location,
        ResourceGroupName = test.Name,
        Cidr = "2001:db8:1::/48",
        RoaValidityEndDate = "2199-12-12",
        WanValidationSignedMessage = "signed message for WAN validation",
    });

    var regional = new Azure.CustomIp.Prefix("regional", new()
    {
        Name = "example-Regional-CustomIPPrefix",
        Location = test.Location,
        ResourceGroupName = test.Name,
        ParentCustomIpPrefixId = @global.Id,
        Cidr = @global.Cidr.Apply(cidr => Std.Cidrsubnet.Invoke(new()
        {
            Input = cidr,
            Newbits = 16,
            Netnum = 1,
        })).Apply(invoke => invoke.Result),
        Zones = new[]
        {
            "1",
        },
    });

});

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.customip.Prefix;
import com.pulumi.azure.customip.PrefixArgs;
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 global = new Prefix("global", PrefixArgs.builder()
            .name("example-Global-CustomIPPrefix")
            .location(test.location())
            .resourceGroupName(test.name())
            .cidr("2001:db8:1::/48")
            .roaValidityEndDate("2199-12-12")
            .wanValidationSignedMessage("signed message for WAN validation")
            .build());

        var regional = new Prefix("regional", PrefixArgs.builder()
            .name("example-Regional-CustomIPPrefix")
            .location(test.location())
            .resourceGroupName(test.name())
            .parentCustomIpPrefixId(global.id())
            .cidr(global.cidr().applyValue(cidr -> StdFunctions.cidrsubnet()).applyValue(invoke -> invoke.result()))
            .zones("1")
            .build());

    }
}

resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  global:
    type: azure:customip:Prefix
    properties:
      name: example-Global-CustomIPPrefix
      location: ${test.location}
      resourceGroupName: ${test.name}
      cidr: 2001:db8:1::/48
      roaValidityEndDate: 2199-12-12
      wanValidationSignedMessage: signed message for WAN validation
  regional:
    type: azure:customip:Prefix
    properties:
      name: example-Regional-CustomIPPrefix
      location: ${test.location}
      resourceGroupName: ${test.name}
      parentCustomIpPrefixId: ${global.id}
      cidr:
        fn::invoke:
          Function: std:cidrsubnet
          Arguments:
            input: ${global.cidr}
            newbits: 16
            netnum: 1
          Return: result
      zones:
        - '1'

Create Prefix Resource

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

Constructor syntax

new Prefix(name: string, args: PrefixArgs, opts?: CustomResourceOptions);

@overload
def Prefix(resource_name: str,
           args: PrefixArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Prefix(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           cidr: Optional[str] = None,
           resource_group_name: Optional[str] = None,
           commissioning_enabled: Optional[bool] = None,
           internet_advertising_disabled: Optional[bool] = None,
           location: Optional[str] = None,
           name: Optional[str] = None,
           parent_custom_ip_prefix_id: Optional[str] = None,
           roa_validity_end_date: Optional[str] = None,
           tags: Optional[Mapping[str, str]] = None,
           wan_validation_signed_message: Optional[str] = None,
           zones: Optional[Sequence[str]] = None)

func NewPrefix(ctx *Context, name string, args PrefixArgs, opts ...ResourceOption) (*Prefix, error)

public Prefix(string name, PrefixArgs args, CustomResourceOptions? opts = null)

public Prefix(String name, PrefixArgs args)
public Prefix(String name, PrefixArgs args, CustomResourceOptions options)

type: azure:customip:Prefix
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 PrefixArgs: 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 PrefixArgs: 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 PrefixArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PrefixArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PrefixArgs: 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 prefixResource = new Azure.CustomIp.Prefix("prefixResource", new()
{
    Cidr = "string",
    ResourceGroupName = "string",
    CommissioningEnabled = false,
    InternetAdvertisingDisabled = false,
    Location = "string",
    Name = "string",
    ParentCustomIpPrefixId = "string",
    RoaValidityEndDate = "string",
    Tags = 
    {
        { "string", "string" },
    },
    WanValidationSignedMessage = "string",
    Zones = new[]
    {
        "string",
    },
});

example, err := customip.NewPrefix(ctx, "prefixResource", &customip.PrefixArgs{
	Cidr:                        pulumi.String("string"),
	ResourceGroupName:           pulumi.String("string"),
	CommissioningEnabled:        pulumi.Bool(false),
	InternetAdvertisingDisabled: pulumi.Bool(false),
	Location:                    pulumi.String("string"),
	Name:                        pulumi.String("string"),
	ParentCustomIpPrefixId:      pulumi.String("string"),
	RoaValidityEndDate:          pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	WanValidationSignedMessage: pulumi.String("string"),
	Zones: pulumi.StringArray{
		pulumi.String("string"),
	},
})

var prefixResource = new Prefix("prefixResource", PrefixArgs.builder()
    .cidr("string")
    .resourceGroupName("string")
    .commissioningEnabled(false)
    .internetAdvertisingDisabled(false)
    .location("string")
    .name("string")
    .parentCustomIpPrefixId("string")
    .roaValidityEndDate("string")
    .tags(Map.of("string", "string"))
    .wanValidationSignedMessage("string")
    .zones("string")
    .build());

prefix_resource = azure.customip.Prefix("prefixResource",
    cidr="string",
    resource_group_name="string",
    commissioning_enabled=False,
    internet_advertising_disabled=False,
    location="string",
    name="string",
    parent_custom_ip_prefix_id="string",
    roa_validity_end_date="string",
    tags={
        "string": "string",
    },
    wan_validation_signed_message="string",
    zones=["string"])

const prefixResource = new azure.customip.Prefix("prefixResource", {
    cidr: "string",
    resourceGroupName: "string",
    commissioningEnabled: false,
    internetAdvertisingDisabled: false,
    location: "string",
    name: "string",
    parentCustomIpPrefixId: "string",
    roaValidityEndDate: "string",
    tags: {
        string: "string",
    },
    wanValidationSignedMessage: "string",
    zones: ["string"],
});

type: azure:customip:Prefix
properties:
    cidr: string
    commissioningEnabled: false
    internetAdvertisingDisabled: false
    location: string
    name: string
    parentCustomIpPrefixId: string
    resourceGroupName: string
    roaValidityEndDate: string
    tags:
        string: string
    wanValidationSignedMessage: string
    zones:
        - string

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

Cidr string

The cidr of the Custom IP Prefix, either IPv4 or IPv6. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the Resource Group in which to create the Custom IP Prefix. Changing this forces a new resource to be created.

CommissioningEnabled bool

Specifies that the custom IP prefix should be commissioned after provisioning in Azure. Defaults to false.

!> Warning Changing the value of commissioning_enabled from true to false causes the IP prefix to stop being advertised by Azure and is functionally equivalent to deleting it when used in a production setting.

InternetAdvertisingDisabled bool

Specifies that the custom IP prefix should not be publicly advertised on the Internet when commissioned (regional commissioning feature). Defaults to false.

!> Warning Changing the value of internet_advertising_disabled from true to false causes the IP prefix to stop being advertised by Azure and is functionally equivalent to deleting it when used in a production setting.

Location string

The location where the Custom IP Prefix should exist. Changing this forces a new resource to be created.

Name string

The name of the Custom IP Prefix. Changing this forces a new resource to be created.

ParentCustomIpPrefixId string

Specifies the ID of the parent prefix. Only needed when creating a regional/child IPv6 prefix. Changing this forces a new resource to be created.

RoaValidityEndDate string

The expiration date of the Route Origin Authorization (ROA) document which has been filed with the Routing Internet Registry (RIR) for this prefix. The expected format is YYYY-MM-DD. Required when provisioning an IPv4 prefix or IPv6 global prefix. Changing this forces a new resource to be created.

Tags Dictionary<string, string>

A mapping of tags to assign to the Custom IP Prefix.

WanValidationSignedMessage string

The signed base64-encoded authorization message, which will be sent to Microsoft for WAN verification. Required when provisioning an IPv4 prefix or IPv6 global prefix. Refer to Azure documentation for more details about the process for your RIR. Changing this forces a new resource to be created.

Zones List<string>

Specifies a list of Availability Zones in which this Custom IP Prefix should be located. Should not be specified when creating an IPv6 global prefix. Changing this forces a new resource to be created.

Cidr string

The cidr of the Custom IP Prefix, either IPv4 or IPv6. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the Resource Group in which to create the Custom IP Prefix. Changing this forces a new resource to be created.

CommissioningEnabled bool

Specifies that the custom IP prefix should be commissioned after provisioning in Azure. Defaults to false.

InternetAdvertisingDisabled bool

Specifies that the custom IP prefix should not be publicly advertised on the Internet when commissioned (regional commissioning feature). Defaults to false.

Location string

The location where the Custom IP Prefix should exist. Changing this forces a new resource to be created.

Name string

The name of the Custom IP Prefix. Changing this forces a new resource to be created.

ParentCustomIpPrefixId string

Specifies the ID of the parent prefix. Only needed when creating a regional/child IPv6 prefix. Changing this forces a new resource to be created.

RoaValidityEndDate string

Tags map[string]string

A mapping of tags to assign to the Custom IP Prefix.

WanValidationSignedMessage string

Zones []string

cidr String

The cidr of the Custom IP Prefix, either IPv4 or IPv6. Changing this forces a new resource to be created.

resourceGroupName String

The name of the Resource Group in which to create the Custom IP Prefix. Changing this forces a new resource to be created.

commissioningEnabled Boolean

Specifies that the custom IP prefix should be commissioned after provisioning in Azure. Defaults to false.

internetAdvertisingDisabled Boolean

Specifies that the custom IP prefix should not be publicly advertised on the Internet when commissioned (regional commissioning feature). Defaults to false.

location String

The location where the Custom IP Prefix should exist. Changing this forces a new resource to be created.

name String

The name of the Custom IP Prefix. Changing this forces a new resource to be created.

parentCustomIpPrefixId String

Specifies the ID of the parent prefix. Only needed when creating a regional/child IPv6 prefix. Changing this forces a new resource to be created.

roaValidityEndDate String

tags Map<String,String>

A mapping of tags to assign to the Custom IP Prefix.

wanValidationSignedMessage String

zones List<String>

cidr string

The cidr of the Custom IP Prefix, either IPv4 or IPv6. Changing this forces a new resource to be created.

resourceGroupName string

The name of the Resource Group in which to create the Custom IP Prefix. Changing this forces a new resource to be created.

commissioningEnabled boolean

Specifies that the custom IP prefix should be commissioned after provisioning in Azure. Defaults to false.

internetAdvertisingDisabled boolean

Specifies that the custom IP prefix should not be publicly advertised on the Internet when commissioned (regional commissioning feature). Defaults to false.

location string

The location where the Custom IP Prefix should exist. Changing this forces a new resource to be created.

name string

The name of the Custom IP Prefix. Changing this forces a new resource to be created.

parentCustomIpPrefixId string

Specifies the ID of the parent prefix. Only needed when creating a regional/child IPv6 prefix. Changing this forces a new resource to be created.

roaValidityEndDate string

tags {[key: string]: string}

A mapping of tags to assign to the Custom IP Prefix.

wanValidationSignedMessage string

zones string[]

cidr str

The cidr of the Custom IP Prefix, either IPv4 or IPv6. Changing this forces a new resource to be created.

resource_group_name str

The name of the Resource Group in which to create the Custom IP Prefix. Changing this forces a new resource to be created.

commissioning_enabled bool

Specifies that the custom IP prefix should be commissioned after provisioning in Azure. Defaults to false.

internet_advertising_disabled bool

Specifies that the custom IP prefix should not be publicly advertised on the Internet when commissioned (regional commissioning feature). Defaults to false.

location str

The location where the Custom IP Prefix should exist. Changing this forces a new resource to be created.

name str

The name of the Custom IP Prefix. Changing this forces a new resource to be created.

parent_custom_ip_prefix_id str

Specifies the ID of the parent prefix. Only needed when creating a regional/child IPv6 prefix. Changing this forces a new resource to be created.

roa_validity_end_date str

tags Mapping[str, str]

A mapping of tags to assign to the Custom IP Prefix.

wan_validation_signed_message str

zones Sequence[str]

cidr String

The cidr of the Custom IP Prefix, either IPv4 or IPv6. Changing this forces a new resource to be created.

resourceGroupName String

The name of the Resource Group in which to create the Custom IP Prefix. Changing this forces a new resource to be created.

commissioningEnabled Boolean

Specifies that the custom IP prefix should be commissioned after provisioning in Azure. Defaults to false.

internetAdvertisingDisabled Boolean

Specifies that the custom IP prefix should not be publicly advertised on the Internet when commissioned (regional commissioning feature). Defaults to false.

location String

The location where the Custom IP Prefix should exist. Changing this forces a new resource to be created.

name String

The name of the Custom IP Prefix. Changing this forces a new resource to be created.

parentCustomIpPrefixId String

Specifies the ID of the parent prefix. Only needed when creating a regional/child IPv6 prefix. Changing this forces a new resource to be created.

roaValidityEndDate String

tags Map<String>

A mapping of tags to assign to the Custom IP Prefix.

wanValidationSignedMessage String

zones List<String>

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing Prefix Resource

Get an existing Prefix 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?: PrefixState, opts?: CustomResourceOptions): Prefix

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cidr: Optional[str] = None,
        commissioning_enabled: Optional[bool] = None,
        internet_advertising_disabled: Optional[bool] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        parent_custom_ip_prefix_id: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        roa_validity_end_date: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        wan_validation_signed_message: Optional[str] = None,
        zones: Optional[Sequence[str]] = None) -> Prefix

func GetPrefix(ctx *Context, name string, id IDInput, state *PrefixState, opts ...ResourceOption) (*Prefix, error)

public static Prefix Get(string name, Input<string> id, PrefixState? state, CustomResourceOptions? opts = null)

public static Prefix get(String name, Output<String> id, PrefixState 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:

Cidr string

The cidr of the Custom IP Prefix, either IPv4 or IPv6. Changing this forces a new resource to be created.

CommissioningEnabled bool

Specifies that the custom IP prefix should be commissioned after provisioning in Azure. Defaults to false.

InternetAdvertisingDisabled bool

Specifies that the custom IP prefix should not be publicly advertised on the Internet when commissioned (regional commissioning feature). Defaults to false.

Location string

The location where the Custom IP Prefix should exist. Changing this forces a new resource to be created.

Name string

The name of the Custom IP Prefix. Changing this forces a new resource to be created.

ParentCustomIpPrefixId string

Specifies the ID of the parent prefix. Only needed when creating a regional/child IPv6 prefix. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the Resource Group in which to create the Custom IP Prefix. Changing this forces a new resource to be created.

RoaValidityEndDate string

Tags Dictionary<string, string>

A mapping of tags to assign to the Custom IP Prefix.

WanValidationSignedMessage string

Zones List<string>

Cidr string

The cidr of the Custom IP Prefix, either IPv4 or IPv6. Changing this forces a new resource to be created.

CommissioningEnabled bool

Specifies that the custom IP prefix should be commissioned after provisioning in Azure. Defaults to false.

InternetAdvertisingDisabled bool

Specifies that the custom IP prefix should not be publicly advertised on the Internet when commissioned (regional commissioning feature). Defaults to false.

Location string

The location where the Custom IP Prefix should exist. Changing this forces a new resource to be created.

Name string

The name of the Custom IP Prefix. Changing this forces a new resource to be created.

ParentCustomIpPrefixId string

Specifies the ID of the parent prefix. Only needed when creating a regional/child IPv6 prefix. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the Resource Group in which to create the Custom IP Prefix. Changing this forces a new resource to be created.

RoaValidityEndDate string

Tags map[string]string

A mapping of tags to assign to the Custom IP Prefix.

WanValidationSignedMessage string

Zones []string

cidr String

The cidr of the Custom IP Prefix, either IPv4 or IPv6. Changing this forces a new resource to be created.

commissioningEnabled Boolean

Specifies that the custom IP prefix should be commissioned after provisioning in Azure. Defaults to false.

internetAdvertisingDisabled Boolean

Specifies that the custom IP prefix should not be publicly advertised on the Internet when commissioned (regional commissioning feature). Defaults to false.

location String

The location where the Custom IP Prefix should exist. Changing this forces a new resource to be created.

name String

The name of the Custom IP Prefix. Changing this forces a new resource to be created.

parentCustomIpPrefixId String

Specifies the ID of the parent prefix. Only needed when creating a regional/child IPv6 prefix. Changing this forces a new resource to be created.

resourceGroupName String

The name of the Resource Group in which to create the Custom IP Prefix. Changing this forces a new resource to be created.

roaValidityEndDate String

tags Map<String,String>

A mapping of tags to assign to the Custom IP Prefix.

wanValidationSignedMessage String

zones List<String>

cidr string

The cidr of the Custom IP Prefix, either IPv4 or IPv6. Changing this forces a new resource to be created.

commissioningEnabled boolean

Specifies that the custom IP prefix should be commissioned after provisioning in Azure. Defaults to false.

internetAdvertisingDisabled boolean

Specifies that the custom IP prefix should not be publicly advertised on the Internet when commissioned (regional commissioning feature). Defaults to false.

location string

The location where the Custom IP Prefix should exist. Changing this forces a new resource to be created.

name string

The name of the Custom IP Prefix. Changing this forces a new resource to be created.

parentCustomIpPrefixId string

Specifies the ID of the parent prefix. Only needed when creating a regional/child IPv6 prefix. Changing this forces a new resource to be created.

resourceGroupName string

The name of the Resource Group in which to create the Custom IP Prefix. Changing this forces a new resource to be created.

roaValidityEndDate string

tags {[key: string]: string}

A mapping of tags to assign to the Custom IP Prefix.

wanValidationSignedMessage string

zones string[]

cidr str

The cidr of the Custom IP Prefix, either IPv4 or IPv6. Changing this forces a new resource to be created.

commissioning_enabled bool

Specifies that the custom IP prefix should be commissioned after provisioning in Azure. Defaults to false.

internet_advertising_disabled bool

Specifies that the custom IP prefix should not be publicly advertised on the Internet when commissioned (regional commissioning feature). Defaults to false.

location str

The location where the Custom IP Prefix should exist. Changing this forces a new resource to be created.

name str

The name of the Custom IP Prefix. Changing this forces a new resource to be created.

parent_custom_ip_prefix_id str

Specifies the ID of the parent prefix. Only needed when creating a regional/child IPv6 prefix. Changing this forces a new resource to be created.

resource_group_name str

The name of the Resource Group in which to create the Custom IP Prefix. Changing this forces a new resource to be created.

roa_validity_end_date str

tags Mapping[str, str]

A mapping of tags to assign to the Custom IP Prefix.

wan_validation_signed_message str

zones Sequence[str]

cidr String

The cidr of the Custom IP Prefix, either IPv4 or IPv6. Changing this forces a new resource to be created.

commissioningEnabled Boolean

Specifies that the custom IP prefix should be commissioned after provisioning in Azure. Defaults to false.

internetAdvertisingDisabled Boolean

Specifies that the custom IP prefix should not be publicly advertised on the Internet when commissioned (regional commissioning feature). Defaults to false.

location String

The location where the Custom IP Prefix should exist. Changing this forces a new resource to be created.

name String

The name of the Custom IP Prefix. Changing this forces a new resource to be created.

parentCustomIpPrefixId String

Specifies the ID of the parent prefix. Only needed when creating a regional/child IPv6 prefix. Changing this forces a new resource to be created.

resourceGroupName String

The name of the Resource Group in which to create the Custom IP Prefix. Changing this forces a new resource to be created.

roaValidityEndDate String

tags Map<String>

A mapping of tags to assign to the Custom IP Prefix.

wanValidationSignedMessage String

zones List<String>

Import

A Custom IP Prefix can be imported using the resource id, e.g.

$ pulumi import azure:customip/prefix:Prefix example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/customIPPrefixes/customIPPrefix1

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 azurerm Terraform Provider.

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi

pulumi/pulumi-azure

azure.customip.Prefix

On this page

On this page

Example Usage

Create Prefix Resource

Constructor syntax

Parameters

Constructor example

Prefix Resource Properties

Inputs

Outputs

Look up Existing Prefix Resource

Import

Package Details

On this page

On this page