@equinix-labs/pulumi-equinix/metal/getOrganization.d.ts

A Pulumi package for creating and managing equinix cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Provides an Equinix Metal organization datasource.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as equinix from "@equinix-labs/pulumi-equinix";
 *
 * const test = equinix.metal.getOrganization({
 *     organizationId: local.org_id,
 * });
 * export const projectsInTheOrg = test.then(test => test.projectIds);
 * ```
 */
export declare function getOrganization(args?: GetOrganizationArgs, opts?: pulumi.InvokeOptions): Promise<GetOrganizationResult>;
/**
 * A collection of arguments for invoking getOrganization.
 */
export interface GetOrganizationArgs {
    /**
     * Description string.
     */
    description?: string;
    /**
     * The organization name.
     */
    name?: string;
    /**
     * The UUID of the organization resource.
     *
     * Exactly one of `name` or `organizationId` must be given.
     */
    organizationId?: string;
}
/**
 * A collection of values returned by getOrganization.
 */
export interface GetOrganizationResult {
    /**
     * Postal address.
     */
    readonly address: outputs.metal.GetOrganizationAddress;
    /**
     * Description string.
     */
    readonly description?: string;
    readonly id: string;
    /**
     * (Deprecated) Logo URL.
     *
     * @deprecated Empty string is the only valid value. Support for this field has been removed from the API
     */
    readonly logo: string;
    readonly name: string;
    readonly organizationId: string;
    /**
     * UUIDs of project resources which belong to this organization.
     */
    readonly projectIds: string[];
    /**
     * Twitter handle.
     */
    readonly twitter: string;
    /**
     * Website link.
     */
    readonly website: string;
}
/**
 * Provides an Equinix Metal organization datasource.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as equinix from "@equinix-labs/pulumi-equinix";
 *
 * const test = equinix.metal.getOrganization({
 *     organizationId: local.org_id,
 * });
 * export const projectsInTheOrg = test.then(test => test.projectIds);
 * ```
 */
export declare function getOrganizationOutput(args?: GetOrganizationOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetOrganizationResult>;
/**
 * A collection of arguments for invoking getOrganization.
 */
export interface GetOrganizationOutputArgs {
    /**
     * Description string.
     */
    description?: pulumi.Input<string>;
    /**
     * The organization name.
     */
    name?: pulumi.Input<string>;
    /**
     * The UUID of the organization resource.
     *
     * Exactly one of `name` or `organizationId` must be given.
     */
    organizationId?: pulumi.Input<string>;
}