import * as pulumi from "@pulumi/pulumi"; /** * Manages a custom IPv4 prefix or custom IPv6 prefix. * * ## Example Usage * * *IPv4 custom prefix* * ```typescript * 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", * }, * }); * ``` * * *IPv6 custom prefix* * ```typescript * 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 * * A Custom IP Prefix can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:customip/prefix:Prefix example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/customIPPrefixes/customIPPrefix1 * ``` */ export declare class Prefix extends pulumi.CustomResource { /** * Get an existing Prefix resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: PrefixState, opts?: pulumi.CustomResourceOptions): Prefix; /** * Returns true if the given object is an instance of Prefix. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Prefix; /** * The `cidr` of the Custom IP Prefix, either IPv4 or IPv6. Changing this forces a new resource to be created. */ readonly cidr: pulumi.Output; /** * Specifies that the custom IP prefix should be commissioned after provisioning in Azure. Defaults to `false`. * * !> **Note:** Changing the value of `commissioningEnabled` 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. */ readonly commissioningEnabled: pulumi.Output; /** * Specifies that the custom IP prefix should not be publicly advertised on the Internet when commissioned (regional commissioning feature). Defaults to `false`. * * !> **Note:** Changing the value of `internetAdvertisingDisabled` 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. */ readonly internetAdvertisingDisabled: pulumi.Output; /** * The location where the Custom IP Prefix should exist. Changing this forces a new resource to be created. */ readonly location: pulumi.Output; /** * The name of the Custom IP Prefix. Changing this forces a new resource to be created. */ readonly name: pulumi.Output; /** * 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. */ readonly parentCustomIpPrefixId: pulumi.Output; /** * The name of the Resource Group in which to create the Custom IP Prefix. Changing this forces a new resource to be created. */ readonly resourceGroupName: pulumi.Output; /** * 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. */ readonly roaValidityEndDate: pulumi.Output; /** * A mapping of tags to assign to the Custom IP Prefix. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * 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](https://learn.microsoft.com/en-us/azure/virtual-network/ip-services/create-custom-ip-address-prefix-cli#certificate-readiness) for more details about the process for your RIR. Changing this forces a new resource to be created. */ readonly wanValidationSignedMessage: pulumi.Output; /** * 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. * * > **Note:** In regions with [availability zones](https://docs.microsoft.com/en-us/azure/availability-zones/az-overview), the Custom IP Prefix must be specified as either `Zone-redundant` or assigned to a specific zone. It can't be created with no zone specified in these regions. All IPs from the prefix must have the same zonal properties. */ readonly zones: pulumi.Output; /** * Create a Prefix resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: PrefixArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Prefix resources. */ export interface PrefixState { /** * The `cidr` of the Custom IP Prefix, either IPv4 or IPv6. Changing this forces a new resource to be created. */ cidr?: pulumi.Input; /** * Specifies that the custom IP prefix should be commissioned after provisioning in Azure. Defaults to `false`. * * !> **Note:** Changing the value of `commissioningEnabled` 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. */ commissioningEnabled?: pulumi.Input; /** * Specifies that the custom IP prefix should not be publicly advertised on the Internet when commissioned (regional commissioning feature). Defaults to `false`. * * !> **Note:** Changing the value of `internetAdvertisingDisabled` 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?: pulumi.Input; /** * The location where the Custom IP Prefix should exist. Changing this forces a new resource to be created. */ location?: pulumi.Input; /** * The name of the Custom IP Prefix. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * 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. */ parentCustomIpPrefixId?: pulumi.Input; /** * The name of the Resource Group in which to create the Custom IP Prefix. Changing this forces a new resource to be created. */ resourceGroupName?: pulumi.Input; /** * 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. */ roaValidityEndDate?: pulumi.Input; /** * A mapping of tags to assign to the Custom IP Prefix. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * 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](https://learn.microsoft.com/en-us/azure/virtual-network/ip-services/create-custom-ip-address-prefix-cli#certificate-readiness) for more details about the process for your RIR. Changing this forces a new resource to be created. */ wanValidationSignedMessage?: pulumi.Input; /** * 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. * * > **Note:** In regions with [availability zones](https://docs.microsoft.com/en-us/azure/availability-zones/az-overview), the Custom IP Prefix must be specified as either `Zone-redundant` or assigned to a specific zone. It can't be created with no zone specified in these regions. All IPs from the prefix must have the same zonal properties. */ zones?: pulumi.Input[]>; } /** * The set of arguments for constructing a Prefix resource. */ export interface PrefixArgs { /** * The `cidr` of the Custom IP Prefix, either IPv4 or IPv6. Changing this forces a new resource to be created. */ cidr: pulumi.Input; /** * Specifies that the custom IP prefix should be commissioned after provisioning in Azure. Defaults to `false`. * * !> **Note:** Changing the value of `commissioningEnabled` 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. */ commissioningEnabled?: pulumi.Input; /** * Specifies that the custom IP prefix should not be publicly advertised on the Internet when commissioned (regional commissioning feature). Defaults to `false`. * * !> **Note:** Changing the value of `internetAdvertisingDisabled` 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?: pulumi.Input; /** * The location where the Custom IP Prefix should exist. Changing this forces a new resource to be created. */ location?: pulumi.Input; /** * The name of the Custom IP Prefix. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * 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. */ parentCustomIpPrefixId?: pulumi.Input; /** * The name of the Resource Group in which to create the Custom IP Prefix. Changing this forces a new resource to be created. */ resourceGroupName: pulumi.Input; /** * 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. */ roaValidityEndDate?: pulumi.Input; /** * A mapping of tags to assign to the Custom IP Prefix. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * 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](https://learn.microsoft.com/en-us/azure/virtual-network/ip-services/create-custom-ip-address-prefix-cli#certificate-readiness) for more details about the process for your RIR. Changing this forces a new resource to be created. */ wanValidationSignedMessage?: pulumi.Input; /** * 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. * * > **Note:** In regions with [availability zones](https://docs.microsoft.com/en-us/azure/availability-zones/az-overview), the Custom IP Prefix must be specified as either `Zone-redundant` or assigned to a specific zone. It can't be created with no zone specified in these regions. All IPs from the prefix must have the same zonal properties. */ zones?: pulumi.Input[]>; }