Viewing docs for Strata Cloud Manager v1.0.5
published on Saturday, Mar 21, 2026 by Pulumi
published on Saturday, Mar 21, 2026 by Pulumi
Viewing docs for Strata Cloud Manager v1.0.5
published on Saturday, Mar 21, 2026 by Pulumi
published on Saturday, Mar 21, 2026 by Pulumi
Retrieves a listing of config items.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as scm from "@pulumi/scm";
// Fetch a list of all HIP Profile objects in the Shared folder.
const allShared = scm.getHipProfileList({
folder: "All",
});
export const hipProfilesListAllShared = allShared.then(allShared => allShared.datas);
// Example of using pagination to get the first 10 HIP Profiles.
const paginated = scm.getHipProfileList({
folder: "All",
limit: 10,
offset: 0,
});
export const hipProfilesListPaginated = paginated.then(paginated => paginated.datas);
import pulumi
import pulumi_scm as scm
# Fetch a list of all HIP Profile objects in the Shared folder.
all_shared = scm.get_hip_profile_list(folder="All")
pulumi.export("hipProfilesListAllShared", all_shared.datas)
# Example of using pagination to get the first 10 HIP Profiles.
paginated = scm.get_hip_profile_list(folder="All",
limit=10,
offset=0)
pulumi.export("hipProfilesListPaginated", paginated.datas)
package main
import (
"github.com/pulumi/pulumi-scm/sdk/go/scm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Fetch a list of all HIP Profile objects in the Shared folder.
allShared, err := scm.GetHipProfileList(ctx, &scm.GetHipProfileListArgs{
Folder: pulumi.StringRef("All"),
}, nil)
if err != nil {
return err
}
ctx.Export("hipProfilesListAllShared", allShared.Datas)
// Example of using pagination to get the first 10 HIP Profiles.
paginated, err := scm.GetHipProfileList(ctx, &scm.GetHipProfileListArgs{
Folder: pulumi.StringRef("All"),
Limit: pulumi.IntRef(10),
Offset: pulumi.IntRef(0),
}, nil)
if err != nil {
return err
}
ctx.Export("hipProfilesListPaginated", paginated.Datas)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;
return await Deployment.RunAsync(() =>
{
// Fetch a list of all HIP Profile objects in the Shared folder.
var allShared = Scm.GetHipProfileList.Invoke(new()
{
Folder = "All",
});
// Example of using pagination to get the first 10 HIP Profiles.
var paginated = Scm.GetHipProfileList.Invoke(new()
{
Folder = "All",
Limit = 10,
Offset = 0,
});
return new Dictionary<string, object?>
{
["hipProfilesListAllShared"] = allShared.Apply(getHipProfileListResult => getHipProfileListResult.Datas),
["hipProfilesListPaginated"] = paginated.Apply(getHipProfileListResult => getHipProfileListResult.Datas),
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.ScmFunctions;
import com.pulumi.scm.inputs.GetHipProfileListArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
// Fetch a list of all HIP Profile objects in the Shared folder.
final var allShared = ScmFunctions.getHipProfileList(GetHipProfileListArgs.builder()
.folder("All")
.build());
ctx.export("hipProfilesListAllShared", allShared.datas());
// Example of using pagination to get the first 10 HIP Profiles.
final var paginated = ScmFunctions.getHipProfileList(GetHipProfileListArgs.builder()
.folder("All")
.limit(10)
.offset(0)
.build());
ctx.export("hipProfilesListPaginated", paginated.datas());
}
}
variables:
# Fetch a list of all HIP Profile objects in the Shared folder.
allShared:
fn::invoke:
function: scm:getHipProfileList
arguments:
folder: All
# Example of using pagination to get the first 10 HIP Profiles.
paginated:
fn::invoke:
function: scm:getHipProfileList
arguments:
folder: All
limit: 10
offset: 0
outputs:
# Output the raw list of all HIP Profile objects.
hipProfilesListAllShared: ${allShared.datas}
hipProfilesListPaginated: ${paginated.datas}
Using getHipProfileList
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getHipProfileList(args: GetHipProfileListArgs, opts?: InvokeOptions): Promise<GetHipProfileListResult>
function getHipProfileListOutput(args: GetHipProfileListOutputArgs, opts?: InvokeOptions): Output<GetHipProfileListResult>def get_hip_profile_list(device: Optional[str] = None,
folder: Optional[str] = None,
limit: Optional[int] = None,
name: Optional[str] = None,
offset: Optional[int] = None,
snippet: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetHipProfileListResult
def get_hip_profile_list_output(device: Optional[pulumi.Input[str]] = None,
folder: Optional[pulumi.Input[str]] = None,
limit: Optional[pulumi.Input[int]] = None,
name: Optional[pulumi.Input[str]] = None,
offset: Optional[pulumi.Input[int]] = None,
snippet: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetHipProfileListResult]func GetHipProfileList(ctx *Context, args *GetHipProfileListArgs, opts ...InvokeOption) (*GetHipProfileListResult, error)
func GetHipProfileListOutput(ctx *Context, args *GetHipProfileListOutputArgs, opts ...InvokeOption) GetHipProfileListResultOutput> Note: This function is named GetHipProfileList in the Go SDK.
public static class GetHipProfileList
{
public static Task<GetHipProfileListResult> InvokeAsync(GetHipProfileListArgs args, InvokeOptions? opts = null)
public static Output<GetHipProfileListResult> Invoke(GetHipProfileListInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetHipProfileListResult> getHipProfileList(GetHipProfileListArgs args, InvokeOptions options)
public static Output<GetHipProfileListResult> getHipProfileList(GetHipProfileListArgs args, InvokeOptions options)
fn::invoke:
function: scm:index/getHipProfileList:getHipProfileList
arguments:
# arguments dictionaryThe following arguments are supported:
getHipProfileList Result
The following output properties are available:
- Datas
List<Get
Hip Profile List Data> - The data.
- Id string
- The provider-assigned unique ID for this managed resource.
- Tfid string
- The Terraform ID.
- Total int
- The total number of items.
- Device string
- The device of the item.
- Folder string
- The folder of the item. Default: Shared.
- Limit int
- The max number of items to return. Default: 200.
- Name string
- The name of the item.
- Offset int
- The offset of the first item to return.
- Snippet string
- The snippet of the item.
- Datas
[]Get
Hip Profile List Data - The data.
- Id string
- The provider-assigned unique ID for this managed resource.
- Tfid string
- The Terraform ID.
- Total int
- The total number of items.
- Device string
- The device of the item.
- Folder string
- The folder of the item. Default: Shared.
- Limit int
- The max number of items to return. Default: 200.
- Name string
- The name of the item.
- Offset int
- The offset of the first item to return.
- Snippet string
- The snippet of the item.
- datas
List<Get
Hip Profile List Data> - The data.
- id String
- The provider-assigned unique ID for this managed resource.
- tfid String
- The Terraform ID.
- total Integer
- The total number of items.
- device String
- The device of the item.
- folder String
- The folder of the item. Default: Shared.
- limit Integer
- The max number of items to return. Default: 200.
- name String
- The name of the item.
- offset Integer
- The offset of the first item to return.
- snippet String
- The snippet of the item.
- datas
Get
Hip Profile List Data[] - The data.
- id string
- The provider-assigned unique ID for this managed resource.
- tfid string
- The Terraform ID.
- total number
- The total number of items.
- device string
- The device of the item.
- folder string
- The folder of the item. Default: Shared.
- limit number
- The max number of items to return. Default: 200.
- name string
- The name of the item.
- offset number
- The offset of the first item to return.
- snippet string
- The snippet of the item.
- datas
Sequence[Get
Hip Profile List Data] - The data.
- id str
- The provider-assigned unique ID for this managed resource.
- tfid str
- The Terraform ID.
- total int
- The total number of items.
- device str
- The device of the item.
- folder str
- The folder of the item. Default: Shared.
- limit int
- The max number of items to return. Default: 200.
- name str
- The name of the item.
- offset int
- The offset of the first item to return.
- snippet str
- The snippet of the item.
- datas List<Property Map>
- The data.
- id String
- The provider-assigned unique ID for this managed resource.
- tfid String
- The Terraform ID.
- total Number
- The total number of items.
- device String
- The device of the item.
- folder String
- The folder of the item. Default: Shared.
- limit Number
- The max number of items to return. Default: 200.
- name String
- The name of the item.
- offset Number
- The offset of the first item to return.
- snippet String
- The snippet of the item.
Supporting Types
GetHipProfileListData
Package Details
- Repository
- scm pulumi/pulumi-scm
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scmTerraform Provider.
Viewing docs for Strata Cloud Manager v1.0.5
published on Saturday, Mar 21, 2026 by Pulumi
published on Saturday, Mar 21, 2026 by Pulumi
