@pulumi/scm/getServiceList.d.ts

A Pulumi package for managing resources on Strata Cloud Manager.. Based on terraform-provider-scm: version v0.2.1

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
 * Retrieves a listing of config items.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scm from "@pulumi/scm";
 *
 * // Data source to fetch all services in the "Shared" folder.
 * const allSharedServices = scm.getServiceList({
 *     folder: "All",
 * });
 * export const allSharedServicesMap = allSharedServices.then(allSharedServices => .reduce((__obj, svc) => ({ ...__obj, [svc.name]: svc })));
 * // Example of using pagination to get the first 5 services.
 * const paginatedServices = scm.getServiceList({
 *     folder: "All",
 *     limit: 5,
 *     offset: 0,
 * });
 * export const paginatedServicesList = paginatedServices.then(paginatedServices => paginatedServices.datas);
 * export const paginatedServicesDetails = {
 *     totalInFolder: paginatedServices.then(paginatedServices => paginatedServices.total),
 *     limitUsed: paginatedServices.then(paginatedServices => paginatedServices.limit),
 *     offsetUsed: paginatedServices.then(paginatedServices => paginatedServices.offset),
 * };
 * ```
 */
export declare function getServiceList(args?: GetServiceListArgs, opts?: pulumi.InvokeOptions): Promise<GetServiceListResult>;
/**
 * A collection of arguments for invoking getServiceList.
 */
export interface GetServiceListArgs {
    /**
     * The device of the item.
     */
    device?: string;
    /**
     * The folder of the item. Default: Shared.
     */
    folder?: string;
    /**
     * The max number of items to return. Default: 200.
     */
    limit?: number;
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The offset of the first item to return.
     */
    offset?: number;
    /**
     * The snippet of the item.
     */
    snippet?: string;
}
/**
 * A collection of values returned by getServiceList.
 */
export interface GetServiceListResult {
    /**
     * The data.
     */
    readonly datas: outputs.GetServiceListData[];
    /**
     * The device of the item.
     */
    readonly device?: string;
    /**
     * The folder of the item. Default: Shared.
     */
    readonly folder?: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * The max number of items to return. Default: 200.
     */
    readonly limit?: number;
    /**
     * The name of the item.
     */
    readonly name?: string;
    /**
     * The offset of the first item to return.
     */
    readonly offset?: number;
    /**
     * The snippet of the item.
     */
    readonly snippet?: string;
    readonly tfid: string;
    /**
     * The total number of items.
     */
    readonly total: number;
}
/**
 * Retrieves a listing of config items.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scm from "@pulumi/scm";
 *
 * // Data source to fetch all services in the "Shared" folder.
 * const allSharedServices = scm.getServiceList({
 *     folder: "All",
 * });
 * export const allSharedServicesMap = allSharedServices.then(allSharedServices => .reduce((__obj, svc) => ({ ...__obj, [svc.name]: svc })));
 * // Example of using pagination to get the first 5 services.
 * const paginatedServices = scm.getServiceList({
 *     folder: "All",
 *     limit: 5,
 *     offset: 0,
 * });
 * export const paginatedServicesList = paginatedServices.then(paginatedServices => paginatedServices.datas);
 * export const paginatedServicesDetails = {
 *     totalInFolder: paginatedServices.then(paginatedServices => paginatedServices.total),
 *     limitUsed: paginatedServices.then(paginatedServices => paginatedServices.limit),
 *     offsetUsed: paginatedServices.then(paginatedServices => paginatedServices.offset),
 * };
 * ```
 */
export declare function getServiceListOutput(args?: GetServiceListOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetServiceListResult>;
/**
 * A collection of arguments for invoking getServiceList.
 */
export interface GetServiceListOutputArgs {
    /**
     * The device of the item.
     */
    device?: pulumi.Input<string>;
    /**
     * The folder of the item. Default: Shared.
     */
    folder?: pulumi.Input<string>;
    /**
     * The max number of items to return. Default: 200.
     */
    limit?: pulumi.Input<number>;
    /**
     * The name of the item.
     */
    name?: pulumi.Input<string>;
    /**
     * The offset of the first item to return.
     */
    offset?: pulumi.Input<number>;
    /**
     * The snippet of the item.
     */
    snippet?: pulumi.Input<string>;
}