@equinix-labs/pulumi-equinix
Version:
A Pulumi package for creating and managing equinix cloud resources.
86 lines (85 loc) • 3.22 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Use this data source to find IP address blocks in Equinix Metal. You can use IP address or a block ID for lookup.
*
* > For backward compatibility, this data source can be also used for precreated (management) IP blocks.
*
* See the [Virtual Routing and Forwarding documentation](https://deploy.equinix.com/developers/docs/metal/layer2-networking/vrf/) for product details and API reference material.
*/
export declare function getReservedIpBlock(args?: GetReservedIpBlockArgs, opts?: pulumi.InvokeOptions): Promise<GetReservedIpBlockResult>;
/**
* A collection of arguments for invoking getReservedIpBlock.
*/
export interface GetReservedIpBlockArgs {
/**
* UUID of the IP address block to look up.
*/
id?: string;
/**
* Block containing this IP address will be returned.
*
* > **NOTE:** You should pass either `id`, or both `projectId` and `ipAddress`.
*/
ipAddress?: string;
/**
* UUID of the project where the searched block should be.
*/
projectId?: string;
}
/**
* A collection of values returned by getReservedIpBlock.
*/
export interface GetReservedIpBlockResult {
readonly address: string;
readonly addressFamily: number;
readonly cidr: number;
readonly cidrNotation: string;
/**
* @deprecated Use metro instead of facility. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices
*/
readonly facility: string;
readonly gateway: string;
readonly global: boolean;
readonly id: string;
readonly ipAddress?: string;
readonly manageable: boolean;
readonly management: boolean;
readonly metro: string;
readonly netmask: string;
readonly network: string;
readonly projectId: string;
readonly public: boolean;
readonly quantity: number;
/**
* One of `globalIpv4`, `publicIpv4`, `privateIpv4`, `publicIpv6`,or `vrf`
*/
readonly type: string;
readonly vrfId: number;
}
/**
* Use this data source to find IP address blocks in Equinix Metal. You can use IP address or a block ID for lookup.
*
* > For backward compatibility, this data source can be also used for precreated (management) IP blocks.
*
* See the [Virtual Routing and Forwarding documentation](https://deploy.equinix.com/developers/docs/metal/layer2-networking/vrf/) for product details and API reference material.
*/
export declare function getReservedIpBlockOutput(args?: GetReservedIpBlockOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetReservedIpBlockResult>;
/**
* A collection of arguments for invoking getReservedIpBlock.
*/
export interface GetReservedIpBlockOutputArgs {
/**
* UUID of the IP address block to look up.
*/
id?: pulumi.Input<string>;
/**
* Block containing this IP address will be returned.
*
* > **NOTE:** You should pass either `id`, or both `projectId` and `ipAddress`.
*/
ipAddress?: pulumi.Input<string>;
/**
* UUID of the project where the searched block should be.
*/
projectId?: pulumi.Input<string>;
}