getFolders

Retrieve information about a set of folders based on a parent ID. See the REST API for more details.

Example Usage

Searching For Folders At The Root Of An Org

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const my-org-folders = gcp.organizations.getFolders({
parentId: `organizations/${organizationId}`,
});
const first-folder = my_org_folders.then(my_org_folders => gcp.organizations.getFolder({
folder: my_org_folders.folders?.[0]?.name,
}));
import pulumi
import pulumi_gcp as gcp
my_org_folders = gcp.organizations.get_folders(parent_id=f"organizations/{organization_id}")
first_folder = gcp.organizations.get_folder(folder=my_org_folders.folders[0].name)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var my_org_folders = Gcp.Organizations.GetFolders.Invoke(new()
{
ParentId = $"organizations/{organizationId}",
});
var first_folder = Gcp.Organizations.GetFolder.Invoke(new()
{
Folder = my_org_folders.Apply(getFoldersResult => getFoldersResult.Folders[0]?.Name),
});
});
package main
import (
"fmt"
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/organizations"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
my_org_folders, err := organizations.GetFolders(ctx, &organizations.GetFoldersArgs{
ParentId: fmt.Sprintf("organizations/%v", organizationId),
}, nil)
if err != nil {
return err
}
_, err = organizations.LookupFolder(ctx, &organizations.LookupFolderArgs{
Folder: my_org_folders.Folders[0].Name,
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetFoldersArgs;
import com.pulumi.gcp.organizations.inputs.GetFolderArgs;
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) {
final var my-org-folders = OrganizationsFunctions.getFolders(GetFoldersArgs.builder()
.parentId(String.format("organizations/%s", organizationId))
.build());
final var first-folder = OrganizationsFunctions.getFolder(GetFolderArgs.builder()
.folder(my_org_folders.folders()[0].name())
.build());
}
}
variables:
my-org-folders:
fn::invoke:
Function: gcp:organizations:getFolders
Arguments:
parentId: organizations/${organizationId}
first-folder:
fn::invoke:
Function: gcp:organizations:getFolder
Arguments:
folder: ${["my-org-folders"].folders[0].name}

Return

A collection of values returned by getFolders.

Parameters

argument

A collection of arguments for invoking getFolders.


suspend fun getFolders(parentId: String): GetFoldersResult

Return

A collection of values returned by getFolders.

Parameters

parentId

A string parent as defined in the REST API.

See also


suspend fun getFolders(argument: suspend GetFoldersPlainArgsBuilder.() -> Unit): GetFoldersResult

Return

A collection of values returned by getFolders.

Parameters

argument

Builder for com.pulumi.gcp.organizations.kotlin.inputs.GetFoldersPlainArgs.

See also