@equinix-labs/pulumi-equinix/fabric/getStreams.d.ts

A Pulumi package for creating and managing equinix cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Fabric V4 API compatible data resource that allow user to fetch Equinix Fabric Streams with pagination details
 *
 * Additional Documentation:
 * * Getting Started: https://docs.equinix.com/en-us/Content/KnowledgeCenter/Fabric/GettingStarted/Integrating-with-Fabric-V4-APIs/IntegrateWithSink.htm
 * * API: https://developer.equinix.com/catalog/fabricv4#tag/Streams
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as equinix from "@equinix-labs/pulumi-equinix";
 *
 * const dataStreams = equinix.fabric.getStreams({
 *     pagination: {
 *         limit: 2,
 *         offset: 1,
 *     },
 * });
 * export const numberOfReturnedStreams = dataStreams.then(dataStreams => dataStreams.datas).length;
 * ```
 */
export declare function getStreams(args: GetStreamsArgs, opts?: pulumi.InvokeOptions): Promise<GetStreamsResult>;
/**
 * A collection of arguments for invoking getStreams.
 */
export interface GetStreamsArgs {
    /**
     * Pagination details for the returned streams list
     */
    pagination: inputs.fabric.GetStreamsPagination;
}
/**
 * A collection of values returned by getStreams.
 */
export interface GetStreamsResult {
    /**
     * Returned list of stream objects
     */
    readonly datas: outputs.fabric.GetStreamsData[];
    /**
     * The unique identifier of the resource
     */
    readonly id: string;
    /**
     * Pagination details for the returned streams list
     */
    readonly pagination: outputs.fabric.GetStreamsPagination;
}
/**
 * Fabric V4 API compatible data resource that allow user to fetch Equinix Fabric Streams with pagination details
 *
 * Additional Documentation:
 * * Getting Started: https://docs.equinix.com/en-us/Content/KnowledgeCenter/Fabric/GettingStarted/Integrating-with-Fabric-V4-APIs/IntegrateWithSink.htm
 * * API: https://developer.equinix.com/catalog/fabricv4#tag/Streams
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as equinix from "@equinix-labs/pulumi-equinix";
 *
 * const dataStreams = equinix.fabric.getStreams({
 *     pagination: {
 *         limit: 2,
 *         offset: 1,
 *     },
 * });
 * export const numberOfReturnedStreams = dataStreams.then(dataStreams => dataStreams.datas).length;
 * ```
 */
export declare function getStreamsOutput(args: GetStreamsOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetStreamsResult>;
/**
 * A collection of arguments for invoking getStreams.
 */
export interface GetStreamsOutputArgs {
    /**
     * Pagination details for the returned streams list
     */
    pagination: pulumi.Input<inputs.fabric.GetStreamsPaginationArgs>;
}