@pulumi/scm
Version:
A Pulumi package for managing resources on Strata Cloud Manager.. Based on terraform-provider-scm: version v0.2.1
151 lines (150 loc) • 4.62 kB
TypeScript
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";
*
* const config = new pulumi.Config();
* // The folder scope for the SCM resource (e.g., 'Shared', 'Predefined', or a specific folder name).
* const folderScope = config.get("folderScope") || "Service Connections";
* // ------------------------------------------------------------------
* // Data Source List: SCM Service Connection Group (List Lookup)
* // ------------------------------------------------------------------
* const allGroupsInFolder = scm.getServiceConnectionGroupList({
* folder: folderScope,
* limit: 50,
* });
* export const listOfAllGroupNames = allGroupsInFolder.then(allGroupsInFolder => .map(group => (group.name)));
* export const totalGroupsCount = allGroupsInFolder.then(allGroupsInFolder => allGroupsInFolder.datas).length;
* ```
*/
export declare function getServiceConnectionGroupList(args?: GetServiceConnectionGroupListArgs, opts?: pulumi.InvokeOptions): Promise<GetServiceConnectionGroupListResult>;
/**
* A collection of arguments for invoking getServiceConnectionGroupList.
*/
export interface GetServiceConnectionGroupListArgs {
/**
* 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 getServiceConnectionGroupList.
*/
export interface GetServiceConnectionGroupListResult {
/**
* The data.
*/
readonly datas: outputs.GetServiceConnectionGroupListData[];
/**
* 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";
*
* const config = new pulumi.Config();
* // The folder scope for the SCM resource (e.g., 'Shared', 'Predefined', or a specific folder name).
* const folderScope = config.get("folderScope") || "Service Connections";
* // ------------------------------------------------------------------
* // Data Source List: SCM Service Connection Group (List Lookup)
* // ------------------------------------------------------------------
* const allGroupsInFolder = scm.getServiceConnectionGroupList({
* folder: folderScope,
* limit: 50,
* });
* export const listOfAllGroupNames = allGroupsInFolder.then(allGroupsInFolder => .map(group => (group.name)));
* export const totalGroupsCount = allGroupsInFolder.then(allGroupsInFolder => allGroupsInFolder.datas).length;
* ```
*/
export declare function getServiceConnectionGroupListOutput(args?: GetServiceConnectionGroupListOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetServiceConnectionGroupListResult>;
/**
* A collection of arguments for invoking getServiceConnectionGroupList.
*/
export interface GetServiceConnectionGroupListOutputArgs {
/**
* 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>;
}