vcd 3.14.1, Apr 14 25

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

vcd.getSubscribedCatalog

Explore with Pulumi AI

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

A vcd.SubscribedCatalog is a catalog that was created by subscribing to another catalog. It can be used, to some extent, like any other catalog, but users must keep in mind that this resource depends on the connection to another catalog, which may not even be in the same VCD. For more information, see the full Catalog subscription and sharing guide.

Supported in provider v3.8+

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

const subscriber = vcd.getSubscribedCatalog({
    name: "subscriber",
    org: "my-org",
});

import pulumi
import pulumi_vcd as vcd

subscriber = vcd.get_subscribed_catalog(name="subscriber",
    org="my-org")

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.LookupSubscribedCatalog(ctx, &vcd.LookupSubscribedCatalogArgs{
			Name: "subscriber",
			Org:  pulumi.StringRef("my-org"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var subscriber = Vcd.GetSubscribedCatalog.Invoke(new()
    {
        Name = "subscriber",
        Org = "my-org",
    });

});

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.GetSubscribedCatalogArgs;
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 subscriber = VcdFunctions.getSubscribedCatalog(GetSubscribedCatalogArgs.builder()
            .name("subscriber")
            .org("my-org")
            .build());

    }
}

variables:
  subscriber:
    fn::invoke:
      function: vcd:getSubscribedCatalog
      arguments:
        name: subscriber
        org: my-org

Filter arguments

name_regex (Optional) matches the name using a regular expression.
date (Optional) is an expression starting with an operator (>, <, >=, <=, ==), followed by a date, with optional spaces in between. For example: > 2020-02-01 12:35:00.523Z The filter recognizes several formats, but one of yyyy-mm-dd [hh:mm[:ss[.nnnZ]]] or dd-MMM-yyyy [hh:mm[:ss[.nnnZ]]] is recommended. Comparison with equality operator (==) need to define the date to the microseconds.
latest (Optional) If true, retrieve the latest item among the ones matching other parameters. If no other parameters are set, it retrieves the newest item.
earliest (Optional) If true, retrieve the earliest item among the ones matching other parameters. If no other parameters are set, it retrieves the oldest item.
metadata (Optional) One or more parameters that will match metadata contents.

See Filters reference for details and examples.

Using getSubscribedCatalog

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.

TypeScript
Python
Go
C#
Java
YAML

function getSubscribedCatalog(args: GetSubscribedCatalogArgs, opts?: InvokeOptions): Promise<GetSubscribedCatalogResult>
function getSubscribedCatalogOutput(args: GetSubscribedCatalogOutputArgs, opts?: InvokeOptions): Output<GetSubscribedCatalogResult>

def get_subscribed_catalog(filter: Optional[GetSubscribedCatalogFilter] = None,
                           id: Optional[str] = None,
                           name: Optional[str] = None,
                           org: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetSubscribedCatalogResult
def get_subscribed_catalog_output(filter: Optional[pulumi.Input[GetSubscribedCatalogFilterArgs]] = None,
                           id: Optional[pulumi.Input[str]] = None,
                           name: Optional[pulumi.Input[str]] = None,
                           org: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetSubscribedCatalogResult]

func LookupSubscribedCatalog(ctx *Context, args *LookupSubscribedCatalogArgs, opts ...InvokeOption) (*LookupSubscribedCatalogResult, error)
func LookupSubscribedCatalogOutput(ctx *Context, args *LookupSubscribedCatalogOutputArgs, opts ...InvokeOption) LookupSubscribedCatalogResultOutput

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

public static class GetSubscribedCatalog 
{
    public static Task<GetSubscribedCatalogResult> InvokeAsync(GetSubscribedCatalogArgs args, InvokeOptions? opts = null)
    public static Output<GetSubscribedCatalogResult> Invoke(GetSubscribedCatalogInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSubscribedCatalogResult> getSubscribedCatalog(GetSubscribedCatalogArgs args, InvokeOptions options)
public static Output<GetSubscribedCatalogResult> getSubscribedCatalog(GetSubscribedCatalogArgs args, InvokeOptions options)

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

The following arguments are supported:

Name string: Catalog name. Required if filter is not set.
Filter GetSubscribedCatalogFilter: Retrieves the data source using one or more filter parameters
Id string
Org string: The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

Name string: Catalog name. Required if filter is not set.
Filter GetSubscribedCatalogFilter: Retrieves the data source using one or more filter parameters
Id string
Org string: The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

name String: Catalog name. Required if filter is not set.
filter GetSubscribedCatalogFilter: Retrieves the data source using one or more filter parameters
id String
org String: The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

name string: Catalog name. Required if filter is not set.
filter GetSubscribedCatalogFilter: Retrieves the data source using one or more filter parameters
id string
org string: The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

name str: Catalog name. Required if filter is not set.
filter GetSubscribedCatalogFilter: Retrieves the data source using one or more filter parameters
id str
org str: The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

name String: Catalog name. Required if filter is not set.
filter Property Map: Retrieves the data source using one or more filter parameters
id String
org String: The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

getSubscribedCatalog Result

The following output properties are available:

CatalogVersion double: Version number from this catalog.
Created string: Date and time of catalog creation.
Description string: Description of the catalog. This is inherited from the publishing catalog
FailedTasks List<string>: List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
Href string: the catalog's Hyper reference.
Id string
IsLocal bool: (v3.8.1+) Indicates if this catalog was created in the current organization.
IsPublished bool: Indicates if this catalog is available for subscription. (Always return false for this data source)
IsShared bool: Indicates if the catalog is shared (true or false).
MakeLocalCopy bool
MediaItemLists List<string>: List of media item names in this catalog, in alphabetical order.
Name string
NumberOfMedia double: Number of media items available in this catalog.
NumberOfVappTemplates double: Number of vApp templates available in this catalog.
OwnerName string: Owner of the catalog.
PublishSubscriptionType string: Shows if the catalog is published, if it is a subscription from another one or none of those. (Always returns SUBSCRIBED for this data source)
RunningTasks List<string>: List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
StorageProfileId string: Allows to set specific storage profile to be used for catalog.
SubscriptionUrl string: The URL to which this catalog is subscribed.
VappTemplateLists List<string>: List of vApp template names in this catalog, in alphabetical order.
Filter GetSubscribedCatalogFilter
Org string

CatalogVersion float64: Version number from this catalog.
Created string: Date and time of catalog creation.
Description string: Description of the catalog. This is inherited from the publishing catalog
FailedTasks []string: List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
Href string: the catalog's Hyper reference.
Id string
IsLocal bool: (v3.8.1+) Indicates if this catalog was created in the current organization.
IsPublished bool: Indicates if this catalog is available for subscription. (Always return false for this data source)
IsShared bool: Indicates if the catalog is shared (true or false).
MakeLocalCopy bool
MediaItemLists []string: List of media item names in this catalog, in alphabetical order.
Name string
NumberOfMedia float64: Number of media items available in this catalog.
NumberOfVappTemplates float64: Number of vApp templates available in this catalog.
OwnerName string: Owner of the catalog.
PublishSubscriptionType string: Shows if the catalog is published, if it is a subscription from another one or none of those. (Always returns SUBSCRIBED for this data source)
RunningTasks []string: List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
StorageProfileId string: Allows to set specific storage profile to be used for catalog.
SubscriptionUrl string: The URL to which this catalog is subscribed.
VappTemplateLists []string: List of vApp template names in this catalog, in alphabetical order.
Filter GetSubscribedCatalogFilter
Org string

catalogVersion Double: Version number from this catalog.
created String: Date and time of catalog creation.
description String: Description of the catalog. This is inherited from the publishing catalog
failedTasks List<String>: List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
href String: the catalog's Hyper reference.
id String
isLocal Boolean: (v3.8.1+) Indicates if this catalog was created in the current organization.
isPublished Boolean: Indicates if this catalog is available for subscription. (Always return false for this data source)
isShared Boolean: Indicates if the catalog is shared (true or false).
makeLocalCopy Boolean
mediaItemLists List<String>: List of media item names in this catalog, in alphabetical order.
name String
numberOfMedia Double: Number of media items available in this catalog.
numberOfVappTemplates Double: Number of vApp templates available in this catalog.
ownerName String: Owner of the catalog.
publishSubscriptionType String: Shows if the catalog is published, if it is a subscription from another one or none of those. (Always returns SUBSCRIBED for this data source)
runningTasks List<String>: List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
storageProfileId String: Allows to set specific storage profile to be used for catalog.
subscriptionUrl String: The URL to which this catalog is subscribed.
vappTemplateLists List<String>: List of vApp template names in this catalog, in alphabetical order.
filter GetSubscribedCatalogFilter
org String

catalogVersion number: Version number from this catalog.
created string: Date and time of catalog creation.
description string: Description of the catalog. This is inherited from the publishing catalog
failedTasks string[]: List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
href string: the catalog's Hyper reference.
id string
isLocal boolean: (v3.8.1+) Indicates if this catalog was created in the current organization.
isPublished boolean: Indicates if this catalog is available for subscription. (Always return false for this data source)
isShared boolean: Indicates if the catalog is shared (true or false).
makeLocalCopy boolean
mediaItemLists string[]: List of media item names in this catalog, in alphabetical order.
name string
numberOfMedia number: Number of media items available in this catalog.
numberOfVappTemplates number: Number of vApp templates available in this catalog.
ownerName string: Owner of the catalog.
publishSubscriptionType string: Shows if the catalog is published, if it is a subscription from another one or none of those. (Always returns SUBSCRIBED for this data source)
runningTasks string[]: List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
storageProfileId string: Allows to set specific storage profile to be used for catalog.
subscriptionUrl string: The URL to which this catalog is subscribed.
vappTemplateLists string[]: List of vApp template names in this catalog, in alphabetical order.
filter GetSubscribedCatalogFilter
org string

catalog_version float: Version number from this catalog.
created str: Date and time of catalog creation.
description str: Description of the catalog. This is inherited from the publishing catalog
failed_tasks Sequence[str]: List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
href str: the catalog's Hyper reference.
id str
is_local bool: (v3.8.1+) Indicates if this catalog was created in the current organization.
is_published bool: Indicates if this catalog is available for subscription. (Always return false for this data source)
is_shared bool: Indicates if the catalog is shared (true or false).
make_local_copy bool
media_item_lists Sequence[str]: List of media item names in this catalog, in alphabetical order.
name str
number_of_media float: Number of media items available in this catalog.
number_of_vapp_templates float: Number of vApp templates available in this catalog.
owner_name str: Owner of the catalog.
publish_subscription_type str: Shows if the catalog is published, if it is a subscription from another one or none of those. (Always returns SUBSCRIBED for this data source)
running_tasks Sequence[str]: List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
storage_profile_id str: Allows to set specific storage profile to be used for catalog.
subscription_url str: The URL to which this catalog is subscribed.
vapp_template_lists Sequence[str]: List of vApp template names in this catalog, in alphabetical order.
filter GetSubscribedCatalogFilter
org str

catalogVersion Number: Version number from this catalog.
created String: Date and time of catalog creation.
description String: Description of the catalog. This is inherited from the publishing catalog
failedTasks List<String>: List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
href String: the catalog's Hyper reference.
id String
isLocal Boolean: (v3.8.1+) Indicates if this catalog was created in the current organization.
isPublished Boolean: Indicates if this catalog is available for subscription. (Always return false for this data source)
isShared Boolean: Indicates if the catalog is shared (true or false).
makeLocalCopy Boolean
mediaItemLists List<String>: List of media item names in this catalog, in alphabetical order.
name String
numberOfMedia Number: Number of media items available in this catalog.
numberOfVappTemplates Number: Number of vApp templates available in this catalog.
ownerName String: Owner of the catalog.
publishSubscriptionType String: Shows if the catalog is published, if it is a subscription from another one or none of those. (Always returns SUBSCRIBED for this data source)
runningTasks List<String>: List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
storageProfileId String: Allows to set specific storage profile to be used for catalog.
subscriptionUrl String: The URL to which this catalog is subscribed.
vappTemplateLists List<String>: List of vApp template names in this catalog, in alphabetical order.
filter Property Map
org String

Supporting Types

GetSubscribedCatalogFilter

Date string: Search by date comparison ({>|>=|<|<=|==} yyyy-mm-dd[ hh[:mm[:ss]]])
Earliest bool: Retrieves the oldest item
Latest bool: Retrieves the newest item
Metadatas List<GetSubscribedCatalogFilterMetadata>: Optional metadata of the catalog. This is inherited from the publishing catalog
NameRegex string: Search by name with a regular expression

Date string: Search by date comparison ({>|>=|<|<=|==} yyyy-mm-dd[ hh[:mm[:ss]]])
Earliest bool: Retrieves the oldest item
Latest bool: Retrieves the newest item
Metadatas []GetSubscribedCatalogFilterMetadata: Optional metadata of the catalog. This is inherited from the publishing catalog
NameRegex string: Search by name with a regular expression

date String: Search by date comparison ({>|>=|<|<=|==} yyyy-mm-dd[ hh[:mm[:ss]]])
earliest Boolean: Retrieves the oldest item
latest Boolean: Retrieves the newest item
metadatas List<GetSubscribedCatalogFilterMetadata>: Optional metadata of the catalog. This is inherited from the publishing catalog
nameRegex String: Search by name with a regular expression

date string: Search by date comparison ({>|>=|<|<=|==} yyyy-mm-dd[ hh[:mm[:ss]]])
earliest boolean: Retrieves the oldest item
latest boolean: Retrieves the newest item
metadatas GetSubscribedCatalogFilterMetadata[]: Optional metadata of the catalog. This is inherited from the publishing catalog
nameRegex string: Search by name with a regular expression

date str: Search by date comparison ({>|>=|<|<=|==} yyyy-mm-dd[ hh[:mm[:ss]]])
earliest bool: Retrieves the oldest item
latest bool: Retrieves the newest item
metadatas Sequence[GetSubscribedCatalogFilterMetadata]: Optional metadata of the catalog. This is inherited from the publishing catalog
name_regex str: Search by name with a regular expression

date String: Search by date comparison ({>|>=|<|<=|==} yyyy-mm-dd[ hh[:mm[:ss]]])
earliest Boolean: Retrieves the oldest item
latest Boolean: Retrieves the newest item
metadatas List<Property Map>: Optional metadata of the catalog. This is inherited from the publishing catalog
nameRegex String: Search by name with a regular expression

GetSubscribedCatalogFilterMetadata

Key string: Metadata key (field name)
Value string: Metadata value (can be a regular expression if "use_api_search" is false)
IsSystem bool: True if is a metadata@SYSTEM key
Type string: Type of metadata value (needed only if "use_api_search" is true)
UseApiSearch bool: If true, will search the vCD using native metadata query (without regular expressions)

Key string: Metadata key (field name)
Value string: Metadata value (can be a regular expression if "use_api_search" is false)
IsSystem bool: True if is a metadata@SYSTEM key
Type string: Type of metadata value (needed only if "use_api_search" is true)
UseApiSearch bool: If true, will search the vCD using native metadata query (without regular expressions)

key String: Metadata key (field name)
value String: Metadata value (can be a regular expression if "use_api_search" is false)
isSystem Boolean: True if is a metadata@SYSTEM key
type String: Type of metadata value (needed only if "use_api_search" is true)
useApiSearch Boolean: If true, will search the vCD using native metadata query (without regular expressions)

key string: Metadata key (field name)
value string: Metadata value (can be a regular expression if "use_api_search" is false)
isSystem boolean: True if is a metadata@SYSTEM key
type string: Type of metadata value (needed only if "use_api_search" is true)
useApiSearch boolean: If true, will search the vCD using native metadata query (without regular expressions)

key str: Metadata key (field name)
value str: Metadata value (can be a regular expression if "use_api_search" is false)
is_system bool: True if is a metadata@SYSTEM key
type str: Type of metadata value (needed only if "use_api_search" is true)
use_api_search bool: If true, will search the vCD using native metadata query (without regular expressions)

key String: Metadata key (field name)
value String: Metadata value (can be a regular expression if "use_api_search" is false)
isSystem Boolean: True if is a metadata@SYSTEM key
type String: Type of metadata value (needed only if "use_api_search" is true)
useApiSearch Boolean: If true, will search the vCD using native metadata query (without regular expressions)

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.getSubscribedCatalog

On this page

On this page

Example

Filter arguments

Using getSubscribedCatalog

getSubscribedCatalog Result

Supporting Types

GetSubscribedCatalogFilter

GetSubscribedCatalogFilterMetadata

Package Details

On this page

On this page