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

vra.CatalogItemEntitlement

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 item entitlement in VMware vRealize Automation.

    Example Usage

    S

    import * as pulumi from "@pulumi/pulumi";
    import * as vra from "@pulumi/vra";
    
    const _this = new vra.CatalogItemEntitlement("this", {
        catalogItemId: _var.catalog_item_id,
        projectId: _var.project_id,
    });
    
    import pulumi
    import pulumi_vra as vra
    
    this = vra.CatalogItemEntitlement("this",
        catalog_item_id=var["catalog_item_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.NewCatalogItemEntitlement(ctx, "this", &vra.CatalogItemEntitlementArgs{
    			CatalogItemId: pulumi.Any(_var.Catalog_item_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.CatalogItemEntitlement("this", new()
        {
            CatalogItemId = @var.Catalog_item_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.CatalogItemEntitlement;
    import com.pulumi.vra.CatalogItemEntitlementArgs;
    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 CatalogItemEntitlement("this", CatalogItemEntitlementArgs.builder()
                .catalogItemId(var_.catalog_item_id())
                .projectId(var_.project_id())
                .build());
    
        }
    }
    
    resources:
      this:
        type: vra:CatalogItemEntitlement
        properties:
          catalogItemId: ${var.catalog_item_id}
          projectId: ${var.project_id}
    

    Create CatalogItemEntitlement Resource

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

    Constructor syntax

    new CatalogItemEntitlement(name: string, args: CatalogItemEntitlementArgs, opts?: CustomResourceOptions);
    @overload
    def CatalogItemEntitlement(resource_name: str,
                               args: CatalogItemEntitlementArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def CatalogItemEntitlement(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               catalog_item_id: Optional[str] = None,
                               project_id: Optional[str] = None,
                               catalog_item_entitlement_id: Optional[str] = None)
    func NewCatalogItemEntitlement(ctx *Context, name string, args CatalogItemEntitlementArgs, opts ...ResourceOption) (*CatalogItemEntitlement, error)
    public CatalogItemEntitlement(string name, CatalogItemEntitlementArgs args, CustomResourceOptions? opts = null)
    public CatalogItemEntitlement(String name, CatalogItemEntitlementArgs args)
    public CatalogItemEntitlement(String name, CatalogItemEntitlementArgs args, CustomResourceOptions options)
    
    type: vra:CatalogItemEntitlement
    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 CatalogItemEntitlementArgs
    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 CatalogItemEntitlementArgs
    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 CatalogItemEntitlementArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CatalogItemEntitlementArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CatalogItemEntitlementArgs
    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 catalogItemEntitlementResource = new Vra.CatalogItemEntitlement("catalogItemEntitlementResource", new()
    {
        CatalogItemId = "string",
        ProjectId = "string",
        CatalogItemEntitlementId = "string",
    });
    
    example, err := vra.NewCatalogItemEntitlement(ctx, "catalogItemEntitlementResource", &vra.CatalogItemEntitlementArgs{
    	CatalogItemId:            pulumi.String("string"),
    	ProjectId:                pulumi.String("string"),
    	CatalogItemEntitlementId: pulumi.String("string"),
    })
    
    var catalogItemEntitlementResource = new CatalogItemEntitlement("catalogItemEntitlementResource", CatalogItemEntitlementArgs.builder()
        .catalogItemId("string")
        .projectId("string")
        .catalogItemEntitlementId("string")
        .build());
    
    catalog_item_entitlement_resource = vra.CatalogItemEntitlement("catalogItemEntitlementResource",
        catalog_item_id="string",
        project_id="string",
        catalog_item_entitlement_id="string")
    
    const catalogItemEntitlementResource = new vra.CatalogItemEntitlement("catalogItemEntitlementResource", {
        catalogItemId: "string",
        projectId: "string",
        catalogItemEntitlementId: "string",
    });
    
    type: vra:CatalogItemEntitlement
    properties:
        catalogItemEntitlementId: string
        catalogItemId: string
        projectId: string
    

    CatalogItemEntitlement 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 CatalogItemEntitlement resource accepts the following input properties:

    CatalogItemId string
    The id of the catalog item to create the entitlement.
    ProjectId string
    The id of the project this entity belongs to.
    CatalogItemEntitlementId string
    Id of the catalog item.
    CatalogItemId string
    The id of the catalog item to create the entitlement.
    ProjectId string
    The id of the project this entity belongs to.
    CatalogItemEntitlementId string
    Id of the catalog item.
    catalogItemId String
    The id of the catalog item to create the entitlement.
    projectId String
    The id of the project this entity belongs to.
    catalogItemEntitlementId String
    Id of the catalog item.
    catalogItemId string
    The id of the catalog item to create the entitlement.
    projectId string
    The id of the project this entity belongs to.
    catalogItemEntitlementId string
    Id of the catalog item.
    catalog_item_id str
    The id of the catalog item to create the entitlement.
    project_id str
    The id of the project this entity belongs to.
    catalog_item_entitlement_id str
    Id of the catalog item.
    catalogItemId String
    The id of the catalog item to create the entitlement.
    projectId String
    The id of the project this entity belongs to.
    catalogItemEntitlementId String
    Id of the catalog item.

    Outputs

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

    Definitions List<CatalogItemEntitlementDefinition>
    Represents a catalog item that is linked to a project via an entitlement.
    Id string
    The provider-assigned unique ID for this managed resource.
    Definitions []CatalogItemEntitlementDefinition
    Represents a catalog item that is linked to a project via an entitlement.
    Id string
    The provider-assigned unique ID for this managed resource.
    definitions List<CatalogItemEntitlementDefinition>
    Represents a catalog item that is linked to a project via an entitlement.
    id String
    The provider-assigned unique ID for this managed resource.
    definitions CatalogItemEntitlementDefinition[]
    Represents a catalog item that is linked to a project via an entitlement.
    id string
    The provider-assigned unique ID for this managed resource.
    definitions Sequence[CatalogItemEntitlementDefinition]
    Represents a catalog item that is linked to a project via an entitlement.
    id str
    The provider-assigned unique ID for this managed resource.
    definitions List<Property Map>
    Represents a catalog item that is linked to a project via an entitlement.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CatalogItemEntitlement Resource

    Get an existing CatalogItemEntitlement 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?: CatalogItemEntitlementState, opts?: CustomResourceOptions): CatalogItemEntitlement
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            catalog_item_entitlement_id: Optional[str] = None,
            catalog_item_id: Optional[str] = None,
            definitions: Optional[Sequence[CatalogItemEntitlementDefinitionArgs]] = None,
            project_id: Optional[str] = None) -> CatalogItemEntitlement
    func GetCatalogItemEntitlement(ctx *Context, name string, id IDInput, state *CatalogItemEntitlementState, opts ...ResourceOption) (*CatalogItemEntitlement, error)
    public static CatalogItemEntitlement Get(string name, Input<string> id, CatalogItemEntitlementState? state, CustomResourceOptions? opts = null)
    public static CatalogItemEntitlement get(String name, Output<String> id, CatalogItemEntitlementState state, CustomResourceOptions options)
    resources:  _:    type: vra:CatalogItemEntitlement    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:
    CatalogItemEntitlementId string
    Id of the catalog item.
    CatalogItemId string
    The id of the catalog item to create the entitlement.
    Definitions List<CatalogItemEntitlementDefinition>
    Represents a catalog item that is linked to a project via an entitlement.
    ProjectId string
    The id of the project this entity belongs to.
    CatalogItemEntitlementId string
    Id of the catalog item.
    CatalogItemId string
    The id of the catalog item to create the entitlement.
    Definitions []CatalogItemEntitlementDefinitionArgs
    Represents a catalog item that is linked to a project via an entitlement.
    ProjectId string
    The id of the project this entity belongs to.
    catalogItemEntitlementId String
    Id of the catalog item.
    catalogItemId String
    The id of the catalog item to create the entitlement.
    definitions List<CatalogItemEntitlementDefinition>
    Represents a catalog item that is linked to a project via an entitlement.
    projectId String
    The id of the project this entity belongs to.
    catalogItemEntitlementId string
    Id of the catalog item.
    catalogItemId string
    The id of the catalog item to create the entitlement.
    definitions CatalogItemEntitlementDefinition[]
    Represents a catalog item that is linked to a project via an entitlement.
    projectId string
    The id of the project this entity belongs to.
    catalog_item_entitlement_id str
    Id of the catalog item.
    catalog_item_id str
    The id of the catalog item to create the entitlement.
    definitions Sequence[CatalogItemEntitlementDefinitionArgs]
    Represents a catalog item that is linked to a project via an entitlement.
    project_id str
    The id of the project this entity belongs to.
    catalogItemEntitlementId String
    Id of the catalog item.
    catalogItemId String
    The id of the catalog item to create the entitlement.
    definitions List<Property Map>
    Represents a catalog item that is linked to a project via an entitlement.
    projectId String
    The id of the project this entity belongs to.

    Supporting Types

    CatalogItemEntitlementDefinition, CatalogItemEntitlementDefinitionArgs

    Description string
    Description of the catalog item.
    IconId string
    Icon id of associated catalog item.
    Id string
    Id of the catalog item.
    Name string
    Name of the catalog item.
    NumberOfItems double
    Number of items in the associated catalog source.
    SourceName string
    Catalog source name.
    SourceType string
    Catalog source type.
    Type string
    Content definition type.
    Description string
    Description of the catalog item.
    IconId string
    Icon id of associated catalog item.
    Id string
    Id of the catalog item.
    Name string
    Name of the catalog item.
    NumberOfItems float64
    Number of items in the associated catalog source.
    SourceName string
    Catalog source name.
    SourceType string
    Catalog source type.
    Type string
    Content definition type.
    description String
    Description of the catalog item.
    iconId String
    Icon id of associated catalog item.
    id String
    Id of the catalog item.
    name String
    Name of the catalog item.
    numberOfItems Double
    Number of items in the associated catalog source.
    sourceName String
    Catalog source name.
    sourceType String
    Catalog source type.
    type String
    Content definition type.
    description string
    Description of the catalog item.
    iconId string
    Icon id of associated catalog item.
    id string
    Id of the catalog item.
    name string
    Name of the catalog item.
    numberOfItems number
    Number of items in the associated catalog source.
    sourceName string
    Catalog source name.
    sourceType string
    Catalog source type.
    type string
    Content definition type.
    description str
    Description of the catalog item.
    icon_id str
    Icon id of associated catalog item.
    id str
    Id of the catalog item.
    name str
    Name of the catalog item.
    number_of_items float
    Number of items in the associated catalog source.
    source_name str
    Catalog source name.
    source_type str
    Catalog source type.
    type str
    Content definition type.
    description String
    Description of the catalog item.
    iconId String
    Icon id of associated catalog item.
    id String
    Id of the catalog item.
    name String
    Name of the catalog item.
    numberOfItems Number
    Number of items in the associated catalog source.
    sourceName String
    Catalog source name.
    sourceType String
    Catalog source type.
    type String
    Content definition type.

    Import

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

    $ pulumi import vra:index/catalogItemEntitlement:CatalogItemEntitlement 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