Alibaba Cloud

Pulumi Official
Package maintained by Pulumi
v3.28.0 published on Tuesday, Aug 16, 2022 by Pulumi

getFolders

This data source provides the resource manager folders of the current Alibaba Cloud user.

NOTE: Available in 1.84.0+.

NOTE: You can view only the information of the first-level child folders of the specified folder.

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(AliCloud.ResourceManager.GetFolders.InvokeAsync(new AliCloud.ResourceManager.GetFoldersArgs
        {
            NameRegex = "tftest",
        }));
        this.FirstFolderId = example.Apply(example => example.Folders?[0]?.Id);
    }

    [Output("firstFolderId")]
    public Output<string> FirstFolderId { get; set; }
}
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/resourcemanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := resourcemanager.GetFolders(ctx, &resourcemanager.GetFoldersArgs{
			NameRegex: pulumi.StringRef("tftest"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("firstFolderId", example.Folders[0].Id)
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.resourcemanager.ResourcemanagerFunctions;
import com.pulumi.alicloud.dataworks.inputs.GetFoldersArgs;
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 example = ResourcemanagerFunctions.getFolders(GetFoldersArgs.builder()
            .nameRegex("tftest")
            .build());

        ctx.export("firstFolderId", example.applyValue(getFoldersResult -> getFoldersResult.folders()[0].id()));
    }
}
import pulumi
import pulumi_alicloud as alicloud

example = alicloud.resourcemanager.get_folders(name_regex="tftest")
pulumi.export("firstFolderId", example.folders[0].id)
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const example = pulumi.output(alicloud.resourcemanager.getFolders({
    nameRegex: "tftest",
}));

export const firstFolderId = example.folders[0].id;
variables:
  example:
    Fn::Invoke:
      Function: alicloud:resourcemanager:getFolders
      Arguments:
        nameRegex: tftest
outputs:
  firstFolderId: ${example.folders[0].id}

Using getFolders

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 getFolders(args: GetFoldersArgs, opts?: InvokeOptions): Promise<GetFoldersResult>
function getFoldersOutput(args: GetFoldersOutputArgs, opts?: InvokeOptions): Output<GetFoldersResult>
def get_folders(enable_details: Optional[bool] = None,
                ids: Optional[Sequence[str]] = None,
                name_regex: Optional[str] = None,
                output_file: Optional[str] = None,
                parent_folder_id: Optional[str] = None,
                query_keyword: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetFoldersResult
def get_folders_output(enable_details: Optional[pulumi.Input[bool]] = None,
                ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                name_regex: Optional[pulumi.Input[str]] = None,
                output_file: Optional[pulumi.Input[str]] = None,
                parent_folder_id: Optional[pulumi.Input[str]] = None,
                query_keyword: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetFoldersResult]
func GetFolders(ctx *Context, args *GetFoldersArgs, opts ...InvokeOption) (*GetFoldersResult, error)
func GetFoldersOutput(ctx *Context, args *GetFoldersOutputArgs, opts ...InvokeOption) GetFoldersResultOutput

> Note: This function is named GetFolders in the Go SDK.

public static class GetFolders 
{
    public static Task<GetFoldersResult> InvokeAsync(GetFoldersArgs args, InvokeOptions? opts = null)
    public static Output<GetFoldersResult> Invoke(GetFoldersInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetFoldersResult> getFolders(GetFoldersArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: alicloud:resourcemanager/getFolders:getFolders
  Arguments:
    # Arguments dictionary

The following arguments are supported:

EnableDetails bool

-(Optional, Available in v1.114.0+) Default to false. Set it to true can output more details.

Ids List<string>

A list of resource manager folders IDs.

NameRegex string

A regex string to filter results by folder name.

OutputFile string
ParentFolderId string

The ID of the parent folder.

QueryKeyword string

The query keyword.

EnableDetails bool

-(Optional, Available in v1.114.0+) Default to false. Set it to true can output more details.

Ids []string

A list of resource manager folders IDs.

NameRegex string

A regex string to filter results by folder name.

OutputFile string
ParentFolderId string

The ID of the parent folder.

QueryKeyword string

The query keyword.

enableDetails Boolean

-(Optional, Available in v1.114.0+) Default to false. Set it to true can output more details.

ids List<String>

A list of resource manager folders IDs.

nameRegex String

A regex string to filter results by folder name.

outputFile String
parentFolderId String

The ID of the parent folder.

queryKeyword String

The query keyword.

enableDetails boolean

-(Optional, Available in v1.114.0+) Default to false. Set it to true can output more details.

ids string[]

A list of resource manager folders IDs.

nameRegex string

A regex string to filter results by folder name.

outputFile string
parentFolderId string

The ID of the parent folder.

queryKeyword string

The query keyword.

enable_details bool

-(Optional, Available in v1.114.0+) Default to false. Set it to true can output more details.

ids Sequence[str]

A list of resource manager folders IDs.

name_regex str

A regex string to filter results by folder name.

output_file str
parent_folder_id str

The ID of the parent folder.

query_keyword str

The query keyword.

enableDetails Boolean

-(Optional, Available in v1.114.0+) Default to false. Set it to true can output more details.

ids List<String>

A list of resource manager folders IDs.

nameRegex String

A regex string to filter results by folder name.

outputFile String
parentFolderId String

The ID of the parent folder.

queryKeyword String

The query keyword.

getFolders Result

The following output properties are available:

Folders List<Pulumi.AliCloud.ResourceManager.Outputs.GetFoldersFolder>

A list of folders. Each element contains the following attributes:

Id string

The provider-assigned unique ID for this managed resource.

Ids List<string>

A list of folder IDs.

Names List<string>

A list of folder names.

EnableDetails bool
NameRegex string
OutputFile string
ParentFolderId string
QueryKeyword string
Folders []GetFoldersFolder

A list of folders. Each element contains the following attributes:

Id string

The provider-assigned unique ID for this managed resource.

Ids []string

A list of folder IDs.

Names []string

A list of folder names.

EnableDetails bool
NameRegex string
OutputFile string
ParentFolderId string
QueryKeyword string
folders List<GetFoldersFolder>

A list of folders. Each element contains the following attributes:

id String

The provider-assigned unique ID for this managed resource.

ids List<String>

A list of folder IDs.

names List<String>

A list of folder names.

enableDetails Boolean
nameRegex String
outputFile String
parentFolderId String
queryKeyword String
folders GetFoldersFolder[]

A list of folders. Each element contains the following attributes:

id string

The provider-assigned unique ID for this managed resource.

ids string[]

A list of folder IDs.

names string[]

A list of folder names.

enableDetails boolean
nameRegex string
outputFile string
parentFolderId string
queryKeyword string
folders Sequence[GetFoldersFolder]

A list of folders. Each element contains the following attributes:

id str

The provider-assigned unique ID for this managed resource.

ids Sequence[str]

A list of folder IDs.

names Sequence[str]

A list of folder names.

enable_details bool
name_regex str
output_file str
parent_folder_id str
query_keyword str
folders List<Property Map>

A list of folders. Each element contains the following attributes:

id String

The provider-assigned unique ID for this managed resource.

ids List<String>

A list of folder IDs.

names List<String>

A list of folder names.

enableDetails Boolean
nameRegex String
outputFile String
parentFolderId String
queryKeyword String

Supporting Types

GetFoldersFolder

FolderId string
FolderName string
Id string

The ID of the folder.

  • folder_id- The ID of the folder.
  • folder_name- The name of the folder.
  • parent_folder_id- (Available in v1.114.0+)The ID of the parent folder.
ParentFolderId string

The ID of the parent folder.

FolderId string
FolderName string
Id string

The ID of the folder.

  • folder_id- The ID of the folder.
  • folder_name- The name of the folder.
  • parent_folder_id- (Available in v1.114.0+)The ID of the parent folder.
ParentFolderId string

The ID of the parent folder.

folderId String
folderName String
id String

The ID of the folder.

  • folder_id- The ID of the folder.
  • folder_name- The name of the folder.
  • parent_folder_id- (Available in v1.114.0+)The ID of the parent folder.
parentFolderId String

The ID of the parent folder.

folderId string
folderName string
id string

The ID of the folder.

  • folder_id- The ID of the folder.
  • folder_name- The name of the folder.
  • parent_folder_id- (Available in v1.114.0+)The ID of the parent folder.
parentFolderId string

The ID of the parent folder.

folder_id str
folder_name str
id str

The ID of the folder.

  • folder_id- The ID of the folder.
  • folder_name- The name of the folder.
  • parent_folder_id- (Available in v1.114.0+)The ID of the parent folder.
parent_folder_id str

The ID of the parent folder.

folderId String
folderName String
id String

The ID of the folder.

  • folder_id- The ID of the folder.
  • folder_name- The name of the folder.
  • parent_folder_id- (Available in v1.114.0+)The ID of the parent folder.
parentFolderId String

The ID of the parent folder.

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.