Azure Native v1.98.1, Mar 24 23

azure-native.network.CustomIPPrefix

Custom IP prefix resource. API Version: 2020-11-01.

Example Usage

Create custom IP prefix allocation method

using System.Collections.Generic;
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/go/azure/network"
	"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 pulumi
import pulumi_azure_native as azure_native

custom_ip_prefix = azure_native.network.CustomIPPrefix("customIPPrefix",
    cidr="0.0.0.0/24",
    custom_ip_prefix_name="test-customipprefix",
    location="westus",
    resource_group_name="rg1")

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

const customIPPrefix = new azure_native.network.CustomIPPrefix("customIPPrefix", {
    cidr: "0.0.0.0/24",
    customIpPrefixName: "test-customipprefix",
    location: "westus",
    resourceGroupName: "rg1",
});

resources:
  customIPPrefix:
    type: azure-native:network:CustomIPPrefix
    properties:
      cidr: 0.0.0.0/24
      customIpPrefixName: test-customipprefix
      location: westus
      resourceGroupName: rg1

Create CustomIPPrefix Resource

new CustomIPPrefix(name: string, args: CustomIPPrefixArgs, opts?: CustomResourceOptions);

@overload
def CustomIPPrefix(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   cidr: Optional[str] = None,
                   commissioned_state: Optional[Union[str, CommissionedState]] = None,
                   custom_ip_prefix_name: Optional[str] = None,
                   extended_location: Optional[ExtendedLocationArgs] = None,
                   id: Optional[str] = None,
                   location: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   zones: Optional[Sequence[str]] = None)
@overload
def CustomIPPrefix(resource_name: str,
                   args: CustomIPPrefixArgs,
                   opts: Optional[ResourceOptions] = None)

func NewCustomIPPrefix(ctx *Context, name string, args CustomIPPrefixArgs, opts ...ResourceOption) (*CustomIPPrefix, error)

public CustomIPPrefix(string name, CustomIPPrefixArgs args, CustomResourceOptions? opts = null)

public CustomIPPrefix(String name, CustomIPPrefixArgs args)
public CustomIPPrefix(String name, CustomIPPrefixArgs args, CustomResourceOptions options)

type: azure-native:network:CustomIPPrefix
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CustomIPPrefixArgs: 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 CustomIPPrefixArgs: 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 CustomIPPrefixArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args CustomIPPrefixArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

ResourceGroupName string: The name of the resource group.
Cidr string: The prefix range in CIDR notation. Should include the start address and the prefix length.
CommissionedState string | Pulumi.AzureNative.Network.CommissionedState: The commissioned state of the Custom IP Prefix.
CustomIpPrefixName string: The name of the custom IP prefix.
ExtendedLocation Pulumi.AzureNative.Network.Inputs.ExtendedLocationArgs: The extended location of the custom IP prefix.
Id string: Resource ID.
Location string: Resource location.
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.
Cidr string: The prefix range in CIDR notation. Should include the start address and the prefix length.
CommissionedState string | CommissionedState: The commissioned state of the Custom IP Prefix.
CustomIpPrefixName string: The name of the custom IP prefix.
ExtendedLocation ExtendedLocationArgs: The extended location of the custom IP prefix.
Id string: Resource ID.
Location string: Resource location.
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.
cidr String: The prefix range in CIDR notation. Should include the start address and the prefix length.
commissionedState String | CommissionedState: The commissioned state of the Custom IP Prefix.
customIpPrefixName String: The name of the custom IP prefix.
extendedLocation ExtendedLocationArgs: The extended location of the custom IP prefix.
id String: Resource ID.
location String: Resource location.
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.
cidr string: The prefix range in CIDR notation. Should include the start address and the prefix length.
commissionedState string | CommissionedState: The commissioned state of the Custom IP Prefix.
customIpPrefixName string: The name of the custom IP prefix.
extendedLocation ExtendedLocationArgs: The extended location of the custom IP prefix.
id string: Resource ID.
location string: Resource location.
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.
cidr str: The prefix range in CIDR notation. Should include the start address and the prefix length.
commissioned_state str | CommissionedState: The commissioned state of the Custom IP Prefix.
custom_ip_prefix_name str: The name of the custom IP prefix.
extended_location ExtendedLocationArgs: The extended location of the custom IP prefix.
id str: Resource ID.
location str: Resource location.
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.
cidr String: The prefix range in CIDR notation. Should include the start address and the prefix length.
commissionedState String | "Provisioning" | "Provisioned" | "Commissioning" | "Commissioned" | "Decommissioning" | "Deprovisioning": The commissioned state of the Custom IP Prefix.
customIpPrefixName String: The name of the custom IP prefix.
extendedLocation Property Map: The extended location of the custom IP prefix.
id String: Resource ID.
location String: Resource location.
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 CustomIPPrefix resource produces the following output properties:

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.
Name string: Resource name.
ProvisioningState string: The provisioning state of the custom IP prefix resource.
PublicIpPrefixes List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>: The list of all referenced PublicIpPrefixes.
ResourceGuid string: The resource GUID property of the custom IP prefix resource.
Type string: Resource type.

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.
Name string: Resource name.
ProvisioningState string: The provisioning state of the custom IP prefix resource.
PublicIpPrefixes []SubResourceResponse: The list of all referenced PublicIpPrefixes.
ResourceGuid string: The resource GUID property of the custom IP prefix resource.
Type string: Resource type.

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.
name String: Resource name.
provisioningState String: The provisioning state of the custom IP prefix resource.
publicIpPrefixes List<SubResourceResponse>: The list of all referenced PublicIpPrefixes.
resourceGuid String: The resource GUID property of the custom IP prefix resource.
type String: Resource type.

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.
name string: Resource name.
provisioningState string: The provisioning state of the custom IP prefix resource.
publicIpPrefixes SubResourceResponse[]: The list of all referenced PublicIpPrefixes.
resourceGuid string: The resource GUID property of the custom IP prefix resource.
type string: Resource type.

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.
name str: Resource name.
provisioning_state str: The provisioning state of the custom IP prefix resource.
public_ip_prefixes Sequence[SubResourceResponse]: The list of all referenced PublicIpPrefixes.
resource_guid str: The resource GUID property of the custom IP prefix resource.
type str: Resource type.

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.
name String: Resource name.
provisioningState String: The provisioning state of the custom IP prefix resource.
publicIpPrefixes List<Property Map>: The list of all referenced PublicIpPrefixes.
resourceGuid String: The resource GUID property of the custom IP prefix resource.
type String: Resource type.

Supporting Types

CommissionedState

Provisioning: Provisioning
Provisioned: Provisioned
Commissioning: Commissioning
Commissioned: Commissioned
Decommissioning: Decommissioning
Deprovisioning: Deprovisioning

CommissionedStateProvisioning: Provisioning
CommissionedStateProvisioned: Provisioned
CommissionedStateCommissioning: Commissioning
CommissionedStateCommissioned: Commissioned
CommissionedStateDecommissioning: Decommissioning
CommissionedStateDeprovisioning: Deprovisioning

Provisioning: Provisioning
Provisioned: Provisioned
Commissioning: Commissioning
Commissioned: Commissioned
Decommissioning: Decommissioning
Deprovisioning: Deprovisioning

Provisioning: Provisioning
Provisioned: Provisioned
Commissioning: Commissioning
Commissioned: Commissioned
Decommissioning: Decommissioning
Deprovisioning: Deprovisioning

PROVISIONING: Provisioning
PROVISIONED: Provisioned
COMMISSIONING: Commissioning
COMMISSIONED: Commissioned
DECOMMISSIONING: Decommissioning
DEPROVISIONING: Deprovisioning

"Provisioning": Provisioning
"Provisioned": Provisioned
"Commissioning": Commissioning
"Commissioned": Commissioned
"Decommissioning": Decommissioning
"Deprovisioning": Deprovisioning

ExtendedLocation

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

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

EdgeZone: EdgeZone

ExtendedLocationTypesEdgeZone: EdgeZone

EdgeZone: EdgeZone

EdgeZone: EdgeZone

EDGE_ZONE: EdgeZone

"EdgeZone": EdgeZone

SubResourceResponse

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:CustomIPPrefix test-customipprefix /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/customIpPrefixes/test-customipprefix

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0