@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.96 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* IpAllocation 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-03-01, 2020-04-01, 2020-05-01, 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. 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 IpAllocation extends pulumi.CustomResource {
/**
* Get an existing IpAllocation 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): IpAllocation;
/**
* Returns true if the given object is an instance of IpAllocation. 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 IpAllocation;
/**
* IpAllocation tags.
*/
readonly allocationTags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: pulumi.Output<string>;
/**
* The IPAM allocation ID.
*/
readonly ipamAllocationId: pulumi.Output<string | undefined>;
/**
* Resource location.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* Resource name.
*/
readonly name: pulumi.Output<string>;
/**
* The address prefix for the IpAllocation.
*/
readonly prefix: pulumi.Output<string | undefined>;
/**
* The address prefix length for the IpAllocation.
*/
readonly prefixLength: pulumi.Output<number | undefined>;
/**
* The address prefix Type for the IpAllocation.
*/
readonly prefixType: pulumi.Output<string | undefined>;
/**
* The Subnet that using the prefix of this IpAllocation resource.
*/
readonly subnet: pulumi.Output<outputs.network.SubResourceResponse>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* The VirtualNetwork that using the prefix of this IpAllocation resource.
*/
readonly virtualNetwork: pulumi.Output<outputs.network.SubResourceResponse>;
/**
* Create a IpAllocation 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: IpAllocationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a IpAllocation resource.
*/
export interface IpAllocationArgs {
/**
* IpAllocation tags.
*/
allocationTags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Resource ID.
*/
id?: pulumi.Input<string>;
/**
* The name of the IpAllocation.
*/
ipAllocationName?: pulumi.Input<string>;
/**
* The IPAM allocation ID.
*/
ipamAllocationId?: pulumi.Input<string>;
/**
* Resource location.
*/
location?: pulumi.Input<string>;
/**
* The address prefix for the IpAllocation.
*/
prefix?: pulumi.Input<string>;
/**
* The address prefix length for the IpAllocation.
*/
prefixLength?: pulumi.Input<number>;
/**
* The address prefix Type for the IpAllocation.
*/
prefixType?: pulumi.Input<string | enums.network.IPVersion>;
/**
* The name of the resource group.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The type for the IpAllocation.
*/
type?: pulumi.Input<string | enums.network.IpAllocationType>;
}