@pulumi/scm/getHipObjectList.js

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

"use strict";
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.getHipObjectListOutput = exports.getHipObjectList = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
 * Retrieves a listing of config items.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scm from "@pulumi/scm";
 *
 * // Fetch a list of all HIP Object objects in the Shared folder.
 * const allShared = scm.getHipObjectList({
 *     folder: "All",
 * });
 * export const hipObjectsListAllShared = allShared.then(allShared => allShared.datas);
 * // Example of using pagination to get the first 10 HIP objects.
 * const paginated = scm.getHipObjectList({
 *     folder: "All",
 *     limit: 10,
 *     offset: 0,
 * });
 * export const hipObjectsListPaginated = paginated.then(paginated => paginated.datas);
 * ```
 */
function getHipObjectList(args, opts) {
    args = args || {};
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invoke("scm:index/getHipObjectList:getHipObjectList", {
        "device": args.device,
        "folder": args.folder,
        "limit": args.limit,
        "name": args.name,
        "offset": args.offset,
        "snippet": args.snippet,
    }, opts);
}
exports.getHipObjectList = getHipObjectList;
/**
 * Retrieves a listing of config items.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scm from "@pulumi/scm";
 *
 * // Fetch a list of all HIP Object objects in the Shared folder.
 * const allShared = scm.getHipObjectList({
 *     folder: "All",
 * });
 * export const hipObjectsListAllShared = allShared.then(allShared => allShared.datas);
 * // Example of using pagination to get the first 10 HIP objects.
 * const paginated = scm.getHipObjectList({
 *     folder: "All",
 *     limit: 10,
 *     offset: 0,
 * });
 * export const hipObjectsListPaginated = paginated.then(paginated => paginated.datas);
 * ```
 */
function getHipObjectListOutput(args, opts) {
    args = args || {};
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invokeOutput("scm:index/getHipObjectList:getHipObjectList", {
        "device": args.device,
        "folder": args.folder,
        "limit": args.limit,
        "name": args.name,
        "offset": args.offset,
        "snippet": args.snippet,
    }, opts);
}
exports.getHipObjectListOutput = getHipObjectListOutput;
//# sourceMappingURL=getHipObjectList.js.map