vSphere

Pulumi Official
Package maintained by Pulumi
v4.1.0 published on Wednesday, Nov 24, 2021 by Pulumi

getFolder

The vsphere.Folder data source can be used to get the general attributes of a vSphere inventory folder. Paths are absolute and include must include the datacenter.

Example Usage

using Pulumi;
using VSphere = Pulumi.VSphere;

class MyStack : Stack
{
    public MyStack()
    {
        var folder = Output.Create(VSphere.GetFolder.InvokeAsync(new VSphere.GetFolderArgs
        {
            Path = "/dc1/datastore/folder1",
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-vsphere/sdk/v4/go/vsphere"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vsphere.LookupFolder(ctx, &GetFolderArgs{
			Path: "/dc1/datastore/folder1",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_vsphere as vsphere

folder = vsphere.get_folder(path="/dc1/datastore/folder1")
import * as pulumi from "@pulumi/pulumi";
import * as vsphere from "@pulumi/vsphere";

const folder = pulumi.output(vsphere.getFolder({
    path: "/dc1/datastore/folder1",
}));

Coming soon!

Using getFolder

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 getFolder(args: GetFolderArgs, opts?: InvokeOptions): Promise<GetFolderResult>
function getFolderOutput(args: GetFolderOutputArgs, opts?: InvokeOptions): Output<GetFolderResult>
def get_folder(path: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetFolderResult
def get_folder_output(path: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetFolderResult]
func LookupFolder(ctx *Context, args *LookupFolderArgs, opts ...InvokeOption) (*LookupFolderResult, error)
func LookupFolderOutput(ctx *Context, args *LookupFolderOutputArgs, opts ...InvokeOption) LookupFolderResultOutput

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

public static class GetFolder 
{
    public static Task<GetFolderResult> InvokeAsync(GetFolderArgs args, InvokeOptions? opts = null)
    public static Output<GetFolderResult> Invoke(GetFolderInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetFolderResult> getFolder(GetFolderArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: vsphere:index/getFolder:getFolder
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Path string

The absolute path of the folder. For example, given a default datacenter of default-dc, a folder of type vm, and a folder name of test-folder, the resulting path would be /default-dc/vm/test-folder. The valid folder types to be used in the path are: vm, host, datacenter, datastore, or network.

Path string

The absolute path of the folder. For example, given a default datacenter of default-dc, a folder of type vm, and a folder name of test-folder, the resulting path would be /default-dc/vm/test-folder. The valid folder types to be used in the path are: vm, host, datacenter, datastore, or network.

path String

The absolute path of the folder. For example, given a default datacenter of default-dc, a folder of type vm, and a folder name of test-folder, the resulting path would be /default-dc/vm/test-folder. The valid folder types to be used in the path are: vm, host, datacenter, datastore, or network.

path string

The absolute path of the folder. For example, given a default datacenter of default-dc, a folder of type vm, and a folder name of test-folder, the resulting path would be /default-dc/vm/test-folder. The valid folder types to be used in the path are: vm, host, datacenter, datastore, or network.

path str

The absolute path of the folder. For example, given a default datacenter of default-dc, a folder of type vm, and a folder name of test-folder, the resulting path would be /default-dc/vm/test-folder. The valid folder types to be used in the path are: vm, host, datacenter, datastore, or network.

path String

The absolute path of the folder. For example, given a default datacenter of default-dc, a folder of type vm, and a folder name of test-folder, the resulting path would be /default-dc/vm/test-folder. The valid folder types to be used in the path are: vm, host, datacenter, datastore, or network.

getFolder Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Path string
Id string

The provider-assigned unique ID for this managed resource.

Path string
id String

The provider-assigned unique ID for this managed resource.

path String
id string

The provider-assigned unique ID for this managed resource.

path string
id str

The provider-assigned unique ID for this managed resource.

path str
id String

The provider-assigned unique ID for this managed resource.

path String

Package Details

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

This Pulumi package is based on the vsphere Terraform Provider.