@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 7.43 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* 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, 2024-07-01, 2024-10-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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class CustomIPPrefix extends pulumi.CustomResource {
/**
* Get an existing CustomIPPrefix 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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): CustomIPPrefix;
/**
* Returns true if the given object is an instance of CustomIPPrefix. 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 CustomIPPrefix;
/**
* The ASN for CIDR advertising. Should be an integer as string.
*/
readonly asn: pulumi.Output<string | undefined>;
/**
* Authorization message for WAN validation.
*/
readonly authorizationMessage: pulumi.Output<string | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The list of all Children for IPv6 /48 CustomIpPrefix.
*/
readonly childCustomIpPrefixes: pulumi.Output<outputs.network.SubResourceResponse[]>;
/**
* The prefix range in CIDR notation. Should include the start address and the prefix length.
*/
readonly cidr: pulumi.Output<string | undefined>;
/**
* The commissioned state of the Custom IP Prefix.
*/
readonly commissionedState: pulumi.Output<string | undefined>;
/**
* The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix.
*/
readonly customIpPrefixParent: pulumi.Output<outputs.network.SubResourceResponse | undefined>;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: pulumi.Output<string>;
/**
* Whether to do express route advertise.
*/
readonly expressRouteAdvertise: pulumi.Output<boolean | undefined>;
/**
* The extended location of the custom IP prefix.
*/
readonly extendedLocation: pulumi.Output<outputs.network.ExtendedLocationResponse | undefined>;
/**
* The reason why resource is in failed state.
*/
readonly failedReason: pulumi.Output<string>;
/**
* The Geo for CIDR advertising. Should be an Geo code.
*/
readonly geo: pulumi.Output<string | undefined>;
/**
* Resource location.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* Resource name.
*/
readonly name: pulumi.Output<string>;
/**
* Whether to Advertise the range to Internet.
*/
readonly noInternetAdvertise: pulumi.Output<boolean | undefined>;
/**
* Type of custom IP prefix. Should be Singular, Parent, or Child.
*/
readonly prefixType: pulumi.Output<string | undefined>;
/**
* The provisioning state of the custom IP prefix resource.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The list of all referenced PublicIpPrefixes.
*/
readonly publicIpPrefixes: pulumi.Output<outputs.network.SubResourceResponse[]>;
/**
* The resource GUID property of the custom IP prefix resource.
*/
readonly resourceGuid: pulumi.Output<string>;
/**
* Signed message for WAN validation.
*/
readonly signedMessage: pulumi.Output<string | undefined>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* A list of availability zones denoting the IP allocated for the resource needs to come from.
*/
readonly zones: pulumi.Output<string[] | undefined>;
/**
* Create a CustomIPPrefix 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: CustomIPPrefixArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a CustomIPPrefix resource.
*/
export interface CustomIPPrefixArgs {
/**
* The ASN for CIDR advertising. Should be an integer as string.
*/
asn?: pulumi.Input<string>;
/**
* Authorization message for WAN validation.
*/
authorizationMessage?: pulumi.Input<string>;
/**
* The prefix range in CIDR notation. Should include the start address and the prefix length.
*/
cidr?: pulumi.Input<string>;
/**
* The commissioned state of the Custom IP Prefix.
*/
commissionedState?: pulumi.Input<string | enums.network.CommissionedState>;
/**
* The name of the custom IP prefix.
*/
customIpPrefixName?: pulumi.Input<string>;
/**
* The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix.
*/
customIpPrefixParent?: pulumi.Input<inputs.network.SubResourceArgs>;
/**
* Whether to do express route advertise.
*/
expressRouteAdvertise?: pulumi.Input<boolean>;
/**
* The extended location of the custom IP prefix.
*/
extendedLocation?: pulumi.Input<inputs.network.ExtendedLocationArgs>;
/**
* The Geo for CIDR advertising. Should be an Geo code.
*/
geo?: pulumi.Input<string | enums.network.Geo>;
/**
* Resource ID.
*/
id?: pulumi.Input<string>;
/**
* Resource location.
*/
location?: pulumi.Input<string>;
/**
* Whether to Advertise the range to Internet.
*/
noInternetAdvertise?: pulumi.Input<boolean>;
/**
* Type of custom IP prefix. Should be Singular, Parent, or Child.
*/
prefixType?: pulumi.Input<string | enums.network.CustomIpPrefixType>;
/**
* The name of the resource group.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Signed message for WAN validation.
*/
signedMessage?: pulumi.Input<string>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A list of availability zones denoting the IP allocated for the resource needs to come from.
*/
zones?: pulumi.Input<pulumi.Input<string>[]>;
}