CustomIPPrefix

class CustomIPPrefix : KotlinCustomResource

Custom 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: 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. 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/#accessing-any-api-version-via-local-packages for details.

Example Usage

Create custom IP prefix allocation method

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var customIPPrefix = new AzureNative.Network.CustomIPPrefix("customIPPrefix", new()
{
Cidr = "0.0.0.0/24",
CustomIpPrefixName = "test-customipprefix",
Location = "westus",
ResourceGroupName = "rg1",
});
});
package main
import (
network "github.com/pulumi/pulumi-azure-native-sdk/network/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := network.NewCustomIPPrefix(ctx, "customIPPrefix", &network.CustomIPPrefixArgs{
Cidr: pulumi.String("0.0.0.0/24"),
CustomIpPrefixName: pulumi.String("test-customipprefix"),
Location: pulumi.String("westus"),
ResourceGroupName: pulumi.String("rg1"),
})
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.CustomIPPrefix;
import com.pulumi.azurenative.network.CustomIPPrefixArgs;
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 customIPPrefix = new CustomIPPrefix("customIPPrefix", CustomIPPrefixArgs.builder()
.cidr("0.0.0.0/24")
.customIpPrefixName("test-customipprefix")
.location("westus")
.resourceGroupName("rg1")
.build());
}
}

Import

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

$ pulumi import azure-native:network:CustomIPPrefix test-customipprefix /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/customIpPrefixes/{customIpPrefixName}

Properties

Link copied to clipboard
val asn: Output<String>?

The ASN for CIDR advertising. Should be an integer as string.

Link copied to clipboard

Authorization message for WAN validation.

Link copied to clipboard
val azureApiVersion: Output<String>

The Azure API version of the resource.

Link copied to clipboard

The list of all Children for IPv6 /48 CustomIpPrefix.

Link copied to clipboard
val cidr: Output<String>?

The prefix range in CIDR notation. Should include the start address and the prefix length.

Link copied to clipboard

The commissioned state of the Custom IP Prefix.

Link copied to clipboard

The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix.

Link copied to clipboard
val etag: Output<String>

A unique read-only string that changes whenever the resource is updated.

Link copied to clipboard

Whether to do express route advertise.

Link copied to clipboard

The extended location of the custom IP prefix.

Link copied to clipboard
val failedReason: Output<String>

The reason why resource is in failed state.

Link copied to clipboard
val geo: Output<String>?

The Geo for CIDR advertising. Should be an Geo code.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val location: Output<String>?

Resource location.

Link copied to clipboard
val name: Output<String>

Resource name.

Link copied to clipboard

Whether to Advertise the range to Internet.

Link copied to clipboard
val prefixType: Output<String>?

Type of custom IP prefix. Should be Singular, Parent, or Child.

Link copied to clipboard

The provisioning state of the custom IP prefix resource.

Link copied to clipboard

The list of all referenced PublicIpPrefixes.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val resourceGuid: Output<String>

The resource GUID property of the custom IP prefix resource.

Link copied to clipboard
val signedMessage: Output<String>?

Signed message for WAN validation.

Link copied to clipboard
val tags: Output<Map<String, String>>?

Resource tags.

Link copied to clipboard
val type: Output<String>

Resource type.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val zones: Output<List<String>>?

A list of availability zones denoting the IP allocated for the resource needs to come from.