getResourceSchema

vcd 3.14.2, Jul 11 26

Viewing docs for vcd 3.14.2
published on Saturday, Jul 11, 2026 by vmware

Schema (JSON)

vmware/terraform-provider-vcd

Viewing docs for vcd 3.14.2
published on Saturday, Jul 11, 2026 by vmware

Schema (JSON)

vmware/terraform-provider-vcd

Example Usage

1

Showing a structure with simple attributes only

import * as pulumi from "@pulumi/pulumi";
import * as vcd from "@pulumi/vcd";

export = async () => {
    const orgStruct = await vcd.getResourceSchema({
        name: "org_struct",
        resourceType: "vcd_org",
    });
    return {
        orgStruct: orgStruct.attributes,
    };
}

import pulumi
import pulumi_vcd as vcd

org_struct = vcd.get_resource_schema(name="org_struct",
    resource_type="vcd_org")
pulumi.export("orgStruct", org_struct.attributes)

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vcd/v3/vcd"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		orgStruct, err := vcd.GetResourceSchema(ctx, &vcd.GetResourceSchemaArgs{
			Name:         "org_struct",
			ResourceType: "vcd_org",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("orgStruct", orgStruct.Attributes)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vcd = Pulumi.Vcd;

return await Deployment.RunAsync(() => 
{
    var orgStruct = Vcd.GetResourceSchema.Invoke(new()
    {
        Name = "org_struct",
        ResourceType = "vcd_org",
    });

    return new Dictionary<string, object?>
    {
        ["orgStruct"] = orgStruct.Apply(getResourceSchemaResult => getResourceSchemaResult.Attributes),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vcd.VcdFunctions;
import com.pulumi.vcd.inputs.GetResourceSchemaArgs;
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 orgStruct = VcdFunctions.getResourceSchema(GetResourceSchemaArgs.builder()
            .name("org_struct")
            .resourceType("vcd_org")
            .build());

        ctx.export("orgStruct", orgStruct.attributes());
    }
}

variables:
  orgStruct:
    fn::invoke:
      function: vcd:getResourceSchema
      arguments:
        name: org_struct
        resourceType: vcd_org
outputs:
  # Shows the organization attributes
  orgStruct: ${orgStruct.attributes}

Example coming soon!

2

Showing a structure with both simple and compound attributes

import * as pulumi from "@pulumi/pulumi";
import * as vcd from "@pulumi/vcd";

const networkIsolatedStruct = vcd.getResourceSchema({
    name: "net_struct",
    resourceType: "vcd_network_isolated",
});
export const netStruct = netStructVcdResourceSchema;

import pulumi
import pulumi_vcd as vcd

network_isolated_struct = vcd.get_resource_schema(name="net_struct",
    resource_type="vcd_network_isolated")
pulumi.export("netStruct", net_struct_vcd_resource_schema)

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vcd/v3/vcd"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vcd.GetResourceSchema(ctx, &vcd.GetResourceSchemaArgs{
			Name:         "net_struct",
			ResourceType: "vcd_network_isolated",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("netStruct", netStructVcdResourceSchema)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vcd = Pulumi.Vcd;

return await Deployment.RunAsync(() => 
{
    var networkIsolatedStruct = Vcd.GetResourceSchema.Invoke(new()
    {
        Name = "net_struct",
        ResourceType = "vcd_network_isolated",
    });

    return new Dictionary<string, object?>
    {
        ["netStruct"] = netStructVcdResourceSchema,
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vcd.VcdFunctions;
import com.pulumi.vcd.inputs.GetResourceSchemaArgs;
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 networkIsolatedStruct = VcdFunctions.getResourceSchema(GetResourceSchemaArgs.builder()
            .name("net_struct")
            .resourceType("vcd_network_isolated")
            .build());

        ctx.export("netStruct", netStructVcdResourceSchema);
    }
}

variables:
  networkIsolatedStruct:
    fn::invoke:
      function: vcd:getResourceSchema
      arguments:
        name: net_struct
        resourceType: vcd_network_isolated
outputs:
  netStruct: ${netStructVcdResourceSchema}

Example coming soon!

Using getResourceSchema

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 getResourceSchema(args: GetResourceSchemaArgs, opts?: InvokeOptions): Promise<GetResourceSchemaResult>
function getResourceSchemaOutput(args: GetResourceSchemaOutputArgs, opts?: InvokeOutputOptions): Output<GetResourceSchemaResult>

def get_resource_schema(id: Optional[str] = None,
                        name: Optional[str] = None,
                        resource_type: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetResourceSchemaResult
def get_resource_schema_output(id: pulumi.Input[Optional[str]] = None,
                        name: pulumi.Input[Optional[str]] = None,
                        resource_type: pulumi.Input[Optional[str]] = None,
                        opts: Optional[InvokeOutputOptions] = None) -> Output[GetResourceSchemaResult]

func GetResourceSchema(ctx *Context, args *GetResourceSchemaArgs, opts ...InvokeOption) (*GetResourceSchemaResult, error)
func GetResourceSchemaOutput(ctx *Context, args *GetResourceSchemaOutputArgs, opts ...InvokeOption) GetResourceSchemaResultOutput

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

public static class GetResourceSchema 
{
    public static Task<GetResourceSchemaResult> InvokeAsync(GetResourceSchemaArgs args, InvokeOptions? opts = null)
    public static Output<GetResourceSchemaResult> Invoke(GetResourceSchemaInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetResourceSchemaResult> Invoke(GetResourceSchemaInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetResourceSchemaResult> getResourceSchema(GetResourceSchemaArgs args, InvokeOptions options)
public static Output<GetResourceSchemaResult> getResourceSchema(GetResourceSchemaArgs args, InvokeOptions options)
public static Output<GetResourceSchemaResult> getResourceSchema(GetResourceSchemaArgs args, InvokeOutputOptions options)

fn::invoke:
  function: vcd:index/getResourceSchema:getResourceSchema
  arguments:
    # arguments dictionary

data "vcd_get_resource_schema" "name" {
    # arguments
}

The following arguments are supported:

Name string: An unique name to identify the data source
ResourceType string: Which resource we want to list. It needs to use the full name of the resource (i.e. "vcd.Org", not simply "org")
Id string

Name string: An unique name to identify the data source
ResourceType string: Which resource we want to list. It needs to use the full name of the resource (i.e. "vcd.Org", not simply "org")
Id string

name string: An unique name to identify the data source
resource_type string: Which resource we want to list. It needs to use the full name of the resource (i.e. "vcd.Org", not simply "org")
id string

name String: An unique name to identify the data source
resourceType String: Which resource we want to list. It needs to use the full name of the resource (i.e. "vcd.Org", not simply "org")
id String

name string: An unique name to identify the data source
resourceType string: Which resource we want to list. It needs to use the full name of the resource (i.e. "vcd.Org", not simply "org")
id string

name str: An unique name to identify the data source
resource_type str: Which resource we want to list. It needs to use the full name of the resource (i.e. "vcd.Org", not simply "org")
id str

name String: An unique name to identify the data source
resourceType String: Which resource we want to list. It needs to use the full name of the resource (i.e. "vcd.Org", not simply "org")
id String