@cuemby/equinix/getMetalVlan.d.ts

A Pulumi package for creating and managing equinix cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Provides an Equinix Metal Virtual Network datasource. VLANs data sources can be
 * searched by VLAN UUID, or project UUID and vxlan number.
 *
 * ## Example Usage
 *
 * Fetch a vlan by ID:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as equinix from "@cuemby/equinix";
 * import * as equinix from "@pulumi/equinix";
 *
 * const foovlan = new equinix.MetalVlan("foovlan", {
 *     projectId: local.project_id,
 *     metro: "sv",
 *     vxlan: 5,
 * });
 * const dsvlan = equinix.GetMetalVlanOutput({
 *     vlanId: foovlan.id,
 * });
 * ```
 *
 * Fetch a vlan by project ID, vxlan and metro
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as equinix from "@pulumi/equinix";
 *
 * const dsvlan = equinix.GetMetalVlan({
 *     projectId: local.project_id,
 *     vxlan: 5,
 *     metro: "sv",
 * });
 * ```
 */
export declare function getMetalVlan(args?: GetMetalVlanArgs, opts?: pulumi.InvokeOptions): Promise<GetMetalVlanResult>;
/**
 * A collection of arguments for invoking GetMetalVlan.
 */
export interface GetMetalVlanArgs {
    /**
     * Facility where the VLAN is deployed.
     */
    facility?: string;
    /**
     * Metro where the VLAN is deployed.
     */
    metro?: string;
    /**
     * UUID of parent project of the VLAN. Use together with the vxlan number and metro or facility.
     */
    projectId?: string;
    /**
     * Metal UUID of the VLAN resource to look up.
     */
    vlanId?: string;
    /**
     * vxlan number of the VLAN to look up. Use together with the projectId and metro or facility.
     */
    vxlan?: number;
}
/**
 * A collection of values returned by GetMetalVlan.
 */
export interface GetMetalVlanResult {
    /**
     * List of device ID to which this VLAN is assigned.
     */
    readonly assignedDevicesIds: string[];
    /**
     * Description text of the VLAN resource.
     */
    readonly description: string;
    readonly facility: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly metro: string;
    readonly projectId: string;
    readonly vlanId: string;
    readonly vxlan: number;
}
export declare function getMetalVlanOutput(args?: GetMetalVlanOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetMetalVlanResult>;
/**
 * A collection of arguments for invoking GetMetalVlan.
 */
export interface GetMetalVlanOutputArgs {
    /**
     * Facility where the VLAN is deployed.
     */
    facility?: pulumi.Input<string>;
    /**
     * Metro where the VLAN is deployed.
     */
    metro?: pulumi.Input<string>;
    /**
     * UUID of parent project of the VLAN. Use together with the vxlan number and metro or facility.
     */
    projectId?: pulumi.Input<string>;
    /**
     * Metal UUID of the VLAN resource to look up.
     */
    vlanId?: pulumi.Input<string>;
    /**
     * vxlan number of the VLAN to look up. Use together with the projectId and metro or facility.
     */
    vxlan?: pulumi.Input<number>;
}