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"; * * // This data source will call the "ListAddresses" API endpoint * // and return all filters in the "All" folder. * // 1. Use a single data block to fetch ALL addresses in the "All" folder. * const allShared = scm.getAddressGroupList({ * folder: "All", * }); * export const addressGroupsDataSourceResultsFromList = allShared.then(allShared => .reduce((__obj, addr) => ({ ...__obj, [addr.id]: addr }), {})); * const paginatedAddressGroupsExample = scm.getAddressGroupList({ * folder: "All", * limit: 5, * offset: 0, * }); * export const paginatedAddressGroups = paginatedAddressGroupsExample.then(paginatedAddressGroupsExample => .reduce((__obj, addr) => ({ ...__obj, [addr.id]: addr }), {})); * export const paginationAddressGroupsDetails = { * totalObjectsInFolder: paginatedAddressGroupsExample.then(paginatedAddressGroupsExample => paginatedAddressGroupsExample.total), * limitUsed: paginatedAddressGroupsExample.then(paginatedAddressGroupsExample => paginatedAddressGroupsExample.limit), * }; * ``` */ export declare function getAddressGroupList(args?: GetAddressGroupListArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getAddressGroupList. */ export interface GetAddressGroupListArgs { /** * 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 getAddressGroupList. */ export interface GetAddressGroupListResult { /** * The data. */ readonly datas: outputs.GetAddressGroupListData[]; /** * The device of the item. */ readonly device?: string; /** * The folder of the item. Default: Shared. */ readonly folder?: 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; /** * The Terraform ID. */ 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"; * * // This data source will call the "ListAddresses" API endpoint * // and return all filters in the "All" folder. * // 1. Use a single data block to fetch ALL addresses in the "All" folder. * const allShared = scm.getAddressGroupList({ * folder: "All", * }); * export const addressGroupsDataSourceResultsFromList = allShared.then(allShared => .reduce((__obj, addr) => ({ ...__obj, [addr.id]: addr }), {})); * const paginatedAddressGroupsExample = scm.getAddressGroupList({ * folder: "All", * limit: 5, * offset: 0, * }); * export const paginatedAddressGroups = paginatedAddressGroupsExample.then(paginatedAddressGroupsExample => .reduce((__obj, addr) => ({ ...__obj, [addr.id]: addr }), {})); * export const paginationAddressGroupsDetails = { * totalObjectsInFolder: paginatedAddressGroupsExample.then(paginatedAddressGroupsExample => paginatedAddressGroupsExample.total), * limitUsed: paginatedAddressGroupsExample.then(paginatedAddressGroupsExample => paginatedAddressGroupsExample.limit), * }; * ``` */ export declare function getAddressGroupListOutput(args?: GetAddressGroupListOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getAddressGroupList. */ export interface GetAddressGroupListOutputArgs { /** * The device of the item. */ device?: pulumi.Input; /** * The folder of the item. Default: Shared. */ folder?: pulumi.Input; /** * The max number of items to return. Default: 200. */ limit?: pulumi.Input; /** * The name of the item. */ name?: pulumi.Input; /** * The offset of the first item to return. */ offset?: pulumi.Input; /** * The snippet of the item. */ snippet?: pulumi.Input; } //# sourceMappingURL=getAddressGroupList.d.ts.map