vcd.getResourceList

Start a Neo task

Explain and create a vcd.getResourceList resource

vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vmware/terraform-provider-vcd

Using getResourceList

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 getResourceList(args: GetResourceListArgs, opts?: InvokeOptions): Promise<GetResourceListResult>
function getResourceListOutput(args: GetResourceListOutputArgs, opts?: InvokeOptions): Output<GetResourceListResult>

def get_resource_list(id: Optional[str] = None,
                      import_file_name: Optional[str] = None,
                      list_mode: Optional[str] = None,
                      name: Optional[str] = None,
                      name_id_separator: Optional[str] = None,
                      name_regex: Optional[str] = None,
                      org: Optional[str] = None,
                      parent: Optional[str] = None,
                      resource_type: Optional[str] = None,
                      vdc: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetResourceListResult
def get_resource_list_output(id: Optional[pulumi.Input[str]] = None,
                      import_file_name: Optional[pulumi.Input[str]] = None,
                      list_mode: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      name_id_separator: Optional[pulumi.Input[str]] = None,
                      name_regex: Optional[pulumi.Input[str]] = None,
                      org: Optional[pulumi.Input[str]] = None,
                      parent: Optional[pulumi.Input[str]] = None,
                      resource_type: Optional[pulumi.Input[str]] = None,
                      vdc: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetResourceListResult]

func GetResourceList(ctx *Context, args *GetResourceListArgs, opts ...InvokeOption) (*GetResourceListResult, error)
func GetResourceListOutput(ctx *Context, args *GetResourceListOutputArgs, opts ...InvokeOption) GetResourceListResultOutput

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

public static class GetResourceList 
{
    public static Task<GetResourceListResult> InvokeAsync(GetResourceListArgs args, InvokeOptions? opts = null)
    public static Output<GetResourceListResult> Invoke(GetResourceListInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetResourceListResult> getResourceList(GetResourceListArgs args, InvokeOptions options)
public static Output<GetResourceListResult> getResourceList(GetResourceListArgs args, InvokeOptions options)

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

The following arguments are supported:

Name string: An unique name to identify the data source
ResourceType string: Which resource we want to list. Supported keywords are:
Id string
ImportFileName string: Name of the file containing the import block. (Requires list_mode = "import"). See [Importing resources][import-resources] for more information on importing.
ListMode string: How the list should be built. One of:
NameIdSeparator string: A string separating name and ID in the list. Default is " " (two spaces)
NameRegex string: If set, will restrict the list of resources to the ones whose name matches the given regular expression.
Org string: The name of organization to use, optional if defined at provider level
Parent string: The resource parent, such as vApp, catalog, or edge gateway name, when needed.
Vdc string: The name of VDC to use, optional if defined at provider level

Name string: An unique name to identify the data source
ResourceType string: Which resource we want to list. Supported keywords are:
Id string
ImportFileName string: Name of the file containing the import block. (Requires list_mode = "import"). See [Importing resources][import-resources] for more information on importing.
ListMode string: How the list should be built. One of:
NameIdSeparator string: A string separating name and ID in the list. Default is " " (two spaces)
NameRegex string: If set, will restrict the list of resources to the ones whose name matches the given regular expression.
Org string: The name of organization to use, optional if defined at provider level
Parent string: The resource parent, such as vApp, catalog, or edge gateway name, when needed.
Vdc string: The name of VDC to use, optional if defined at provider level

name String: An unique name to identify the data source
resourceType String: Which resource we want to list. Supported keywords are:
id String
importFileName String: Name of the file containing the import block. (Requires list_mode = "import"). See [Importing resources][import-resources] for more information on importing.
listMode String: How the list should be built. One of:
nameIdSeparator String: A string separating name and ID in the list. Default is " " (two spaces)
nameRegex String: If set, will restrict the list of resources to the ones whose name matches the given regular expression.
org String: The name of organization to use, optional if defined at provider level
parent String: The resource parent, such as vApp, catalog, or edge gateway name, when needed.
vdc String: The name of VDC to use, optional if defined at provider level

name string: An unique name to identify the data source
resourceType string: Which resource we want to list. Supported keywords are:
id string
importFileName string: Name of the file containing the import block. (Requires list_mode = "import"). See [Importing resources][import-resources] for more information on importing.
listMode string: How the list should be built. One of:
nameIdSeparator string: A string separating name and ID in the list. Default is " " (two spaces)
nameRegex string: If set, will restrict the list of resources to the ones whose name matches the given regular expression.
org string: The name of organization to use, optional if defined at provider level
parent string: The resource parent, such as vApp, catalog, or edge gateway name, when needed.
vdc string: The name of VDC to use, optional if defined at provider level

name str: An unique name to identify the data source
resource_type str: Which resource we want to list. Supported keywords are:
id str
import_file_name str: Name of the file containing the import block. (Requires list_mode = "import"). See [Importing resources][import-resources] for more information on importing.
list_mode str: How the list should be built. One of:
name_id_separator str: A string separating name and ID in the list. Default is " " (two spaces)
name_regex str: If set, will restrict the list of resources to the ones whose name matches the given regular expression.
org str: The name of organization to use, optional if defined at provider level
parent str: The resource parent, such as vApp, catalog, or edge gateway name, when needed.
vdc str: The name of VDC to use, optional if defined at provider level

name String: An unique name to identify the data source
resourceType String: Which resource we want to list. Supported keywords are:
id String
importFileName String: Name of the file containing the import block. (Requires list_mode = "import"). See [Importing resources][import-resources] for more information on importing.
listMode String: How the list should be built. One of:
nameIdSeparator String: A string separating name and ID in the list. Default is " " (two spaces)
nameRegex String: If set, will restrict the list of resources to the ones whose name matches the given regular expression.
org String: The name of organization to use, optional if defined at provider level
parent String: The resource parent, such as vApp, catalog, or edge gateway name, when needed.
vdc String: The name of VDC to use, optional if defined at provider level

getResourceList Result

The following output properties are available:

Id string
Lists List<string>: (Computed) The list of requested resources in the chosen format.
Name string
ResourceType string
ImportFileName string
ListMode string
NameIdSeparator string
NameRegex string
Org string
Parent string
Vdc string

Id string
Lists []string: (Computed) The list of requested resources in the chosen format.
Name string
ResourceType string
ImportFileName string
ListMode string
NameIdSeparator string
NameRegex string
Org string
Parent string
Vdc string

id String
lists List<String>: (Computed) The list of requested resources in the chosen format.
name String
resourceType String
importFileName String
listMode String
nameIdSeparator String
nameRegex String
org String
parent String
vdc String

id string
lists string[]: (Computed) The list of requested resources in the chosen format.
name string
resourceType string
importFileName string
listMode string
nameIdSeparator string
nameRegex string
org string
parent string
vdc string

id str
lists Sequence[str]: (Computed) The list of requested resources in the chosen format.
name str
resource_type str
import_file_name str
list_mode str
name_id_separator str
name_regex str
org str
parent str
vdc str

id String
lists List<String>: (Computed) The list of requested resources in the chosen format.
name String
resourceType String
importFileName String
listMode String
nameIdSeparator String
nameRegex String
org String
parent String
vdc String

Package Details

Repository: vcd vmware/terraform-provider-vcd
License
Notes: This Pulumi package is based on the vcd Terraform Provider.

vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vmware/terraform-provider-vcd

vcd.getResourceList

On this page

On this page

Using getResourceList

getResourceList Result

Package Details

On this page

On this page