1. Packages
  2. Vra Provider
  3. API Docs
  4. CatalogSourceEntitlement
vra 0.12.0 published on Monday, Apr 14, 2025 by vmware

vra.CatalogSourceEntitlement

Explore with Pulumi AI

vra logo
vra 0.12.0 published on Monday, Apr 14, 2025 by vmware

    Note: Deprecated - please use vra.ContentSharingPolicy instead.

    This resource provides a way to create a catalog source entitlement in VMware vRealize Automation.

    Example Usage

    S

    import * as pulumi from "@pulumi/pulumi";
    import * as vra from "@pulumi/vra";
    
    const _this = new vra.CatalogSourceEntitlement("this", {
        catalogSourceId: _var.catalog_source_blueprint_id,
        projectId: _var.project_id,
    });
    
    import pulumi
    import pulumi_vra as vra
    
    this = vra.CatalogSourceEntitlement("this",
        catalog_source_id=var["catalog_source_blueprint_id"],
        project_id=var["project_id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vra/vra"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := vra.NewCatalogSourceEntitlement(ctx, "this", &vra.CatalogSourceEntitlementArgs{
    			CatalogSourceId: pulumi.Any(_var.Catalog_source_blueprint_id),
    			ProjectId:       pulumi.Any(_var.Project_id),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vra = Pulumi.Vra;
    
    return await Deployment.RunAsync(() => 
    {
        var @this = new Vra.CatalogSourceEntitlement("this", new()
        {
            CatalogSourceId = @var.Catalog_source_blueprint_id,
            ProjectId = @var.Project_id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vra.CatalogSourceEntitlement;
    import com.pulumi.vra.CatalogSourceEntitlementArgs;
    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) {
            var this_ = new CatalogSourceEntitlement("this", CatalogSourceEntitlementArgs.builder()
                .catalogSourceId(var_.catalog_source_blueprint_id())
                .projectId(var_.project_id())
                .build());
    
        }
    }
    
    resources:
      this:
        type: vra:CatalogSourceEntitlement
        properties:
          catalogSourceId: ${var.catalog_source_blueprint_id}
          projectId: ${var.project_id}
    

    Attribute Reference

    • definition - Represents a catalog source that is linked to a project via an entitlement.

      • description - Description of the catalog source.

      • icon_id - Icon id of associated catalog source.

      • id - Id of the catalog source.

      • name - Name of the catalog source.

      • number_of_items - Number of items in the associated catalog source.

      • source_name - Catalog source name.

      • source_type - Catalog source type.

      • type - Content definition type.

    Create CatalogSourceEntitlement Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CatalogSourceEntitlement(name: string, args: CatalogSourceEntitlementArgs, opts?: CustomResourceOptions);
    @overload
    def CatalogSourceEntitlement(resource_name: str,
                                 args: CatalogSourceEntitlementArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def CatalogSourceEntitlement(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 catalog_source_id: Optional[str] = None,
                                 project_id: Optional[str] = None,
                                 catalog_source_entitlement_id: Optional[str] = None)
    func NewCatalogSourceEntitlement(ctx *Context, name string, args CatalogSourceEntitlementArgs, opts ...ResourceOption) (*CatalogSourceEntitlement, error)
    public CatalogSourceEntitlement(string name, CatalogSourceEntitlementArgs args, CustomResourceOptions? opts = null)
    public CatalogSourceEntitlement(String name, CatalogSourceEntitlementArgs args)
    public CatalogSourceEntitlement(String name, CatalogSourceEntitlementArgs args, CustomResourceOptions options)
    
    type: vra:CatalogSourceEntitlement
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args CatalogSourceEntitlementArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CatalogSourceEntitlementArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CatalogSourceEntitlementArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CatalogSourceEntitlementArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CatalogSourceEntitlementArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var catalogSourceEntitlementResource = new Vra.CatalogSourceEntitlement("catalogSourceEntitlementResource", new()
    {
        CatalogSourceId = "string",
        ProjectId = "string",
        CatalogSourceEntitlementId = "string",
    });
    
    example, err := vra.NewCatalogSourceEntitlement(ctx, "catalogSourceEntitlementResource", &vra.CatalogSourceEntitlementArgs{
    	CatalogSourceId:            pulumi.String("string"),
    	ProjectId:                  pulumi.String("string"),
    	CatalogSourceEntitlementId: pulumi.String("string"),
    })
    
    var catalogSourceEntitlementResource = new CatalogSourceEntitlement("catalogSourceEntitlementResource", CatalogSourceEntitlementArgs.builder()
        .catalogSourceId("string")
        .projectId("string")
        .catalogSourceEntitlementId("string")
        .build());
    
    catalog_source_entitlement_resource = vra.CatalogSourceEntitlement("catalogSourceEntitlementResource",
        catalog_source_id="string",
        project_id="string",
        catalog_source_entitlement_id="string")
    
    const catalogSourceEntitlementResource = new vra.CatalogSourceEntitlement("catalogSourceEntitlementResource", {
        catalogSourceId: "string",
        projectId: "string",
        catalogSourceEntitlementId: "string",
    });
    
    type: vra:CatalogSourceEntitlement
    properties:
        catalogSourceEntitlementId: string
        catalogSourceId: string
        projectId: string
    

    CatalogSourceEntitlement Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CatalogSourceEntitlement resource accepts the following input properties:

    CatalogSourceId string
    The id of the catalog source to create the entitlement.
    ProjectId string
    The id of the project this entity belongs to.
    CatalogSourceEntitlementId string
    CatalogSourceId string
    The id of the catalog source to create the entitlement.
    ProjectId string
    The id of the project this entity belongs to.
    CatalogSourceEntitlementId string
    catalogSourceId String
    The id of the catalog source to create the entitlement.
    projectId String
    The id of the project this entity belongs to.
    catalogSourceEntitlementId String
    catalogSourceId string
    The id of the catalog source to create the entitlement.
    projectId string
    The id of the project this entity belongs to.
    catalogSourceEntitlementId string
    catalog_source_id str
    The id of the catalog source to create the entitlement.
    project_id str
    The id of the project this entity belongs to.
    catalog_source_entitlement_id str
    catalogSourceId String
    The id of the catalog source to create the entitlement.
    projectId String
    The id of the project this entity belongs to.
    catalogSourceEntitlementId String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CatalogSourceEntitlement resource produces the following output properties:

    Definitions List<CatalogSourceEntitlementDefinition>
    Id string
    The provider-assigned unique ID for this managed resource.
    Definitions []CatalogSourceEntitlementDefinition
    Id string
    The provider-assigned unique ID for this managed resource.
    definitions List<CatalogSourceEntitlementDefinition>
    id String
    The provider-assigned unique ID for this managed resource.
    definitions CatalogSourceEntitlementDefinition[]
    id string
    The provider-assigned unique ID for this managed resource.
    definitions Sequence[CatalogSourceEntitlementDefinition]
    id str
    The provider-assigned unique ID for this managed resource.
    definitions List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CatalogSourceEntitlement Resource

    Get an existing CatalogSourceEntitlement resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CatalogSourceEntitlementState, opts?: CustomResourceOptions): CatalogSourceEntitlement
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            catalog_source_entitlement_id: Optional[str] = None,
            catalog_source_id: Optional[str] = None,
            definitions: Optional[Sequence[CatalogSourceEntitlementDefinitionArgs]] = None,
            project_id: Optional[str] = None) -> CatalogSourceEntitlement
    func GetCatalogSourceEntitlement(ctx *Context, name string, id IDInput, state *CatalogSourceEntitlementState, opts ...ResourceOption) (*CatalogSourceEntitlement, error)
    public static CatalogSourceEntitlement Get(string name, Input<string> id, CatalogSourceEntitlementState? state, CustomResourceOptions? opts = null)
    public static CatalogSourceEntitlement get(String name, Output<String> id, CatalogSourceEntitlementState state, CustomResourceOptions options)
    resources:  _:    type: vra:CatalogSourceEntitlement    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CatalogSourceEntitlementId string
    CatalogSourceId string
    The id of the catalog source to create the entitlement.
    Definitions List<CatalogSourceEntitlementDefinition>
    ProjectId string
    The id of the project this entity belongs to.
    CatalogSourceEntitlementId string
    CatalogSourceId string
    The id of the catalog source to create the entitlement.
    Definitions []CatalogSourceEntitlementDefinitionArgs
    ProjectId string
    The id of the project this entity belongs to.
    catalogSourceEntitlementId String
    catalogSourceId String
    The id of the catalog source to create the entitlement.
    definitions List<CatalogSourceEntitlementDefinition>
    projectId String
    The id of the project this entity belongs to.
    catalogSourceEntitlementId string
    catalogSourceId string
    The id of the catalog source to create the entitlement.
    definitions CatalogSourceEntitlementDefinition[]
    projectId string
    The id of the project this entity belongs to.
    catalog_source_entitlement_id str
    catalog_source_id str
    The id of the catalog source to create the entitlement.
    definitions Sequence[CatalogSourceEntitlementDefinitionArgs]
    project_id str
    The id of the project this entity belongs to.
    catalogSourceEntitlementId String
    catalogSourceId String
    The id of the catalog source to create the entitlement.
    definitions List<Property Map>
    projectId String
    The id of the project this entity belongs to.

    Supporting Types

    CatalogSourceEntitlementDefinition, CatalogSourceEntitlementDefinitionArgs

    Description string
    IconId string
    Id string
    Name string
    NumberOfItems double
    SourceName string
    SourceType string
    Type string
    Description string
    IconId string
    Id string
    Name string
    NumberOfItems float64
    SourceName string
    SourceType string
    Type string
    description String
    iconId String
    id String
    name String
    numberOfItems Double
    sourceName String
    sourceType String
    type String
    description string
    iconId string
    id string
    name string
    numberOfItems number
    sourceName string
    sourceType string
    type string
    description String
    iconId String
    id String
    name String
    numberOfItems Number
    sourceName String
    sourceType String
    type String

    Import

    Catalog source entitlement can be imported using the id, e.g.

    $ pulumi import vra:index/catalogSourceEntitlement:CatalogSourceEntitlement this 05956583-6488-4e7d-84c9-92a7b7219a15`
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    vra vmware/terraform-provider-vra
    License
    Notes
    This Pulumi package is based on the vra Terraform Provider.
    vra logo
    vra 0.12.0 published on Monday, Apr 14, 2025 by vmware