1. Packages
  2. Vcd Provider
  3. API Docs
  4. getRightsBundle
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vcd.getRightsBundle

Explore with Pulumi AI

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

    Provides a VMware Cloud Director rights bundle data source. This can be used to read rights bundles.

    Supported in provider v3.3+

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vcd from "@pulumi/vcd";
    
    const default_set = vcd.getRightsBundle({
        name: "Default Rights Bundle",
    });
    
    import pulumi
    import pulumi_vcd as vcd
    
    default_set = vcd.get_rights_bundle(name="Default Rights Bundle")
    
    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.LookupRightsBundle(ctx, &vcd.LookupRightsBundleArgs{
    			Name: "Default Rights Bundle",
    		}, 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 default_set = Vcd.GetRightsBundle.Invoke(new()
        {
            Name = "Default Rights Bundle",
        });
    
    });
    
    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.GetRightsBundleArgs;
    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 default-set = VcdFunctions.getRightsBundle(GetRightsBundleArgs.builder()
                .name("Default Rights Bundle")
                .build());
    
        }
    }
    
    variables:
      default-set:
        fn::invoke:
          function: vcd:getRightsBundle
          arguments:
            name: Default Rights Bundle
    
    Sample output:
    
    default-set = {
      "bundle_key" = "com.vmware.vcloud.undefined.key"
      "description" = "Default set of tenant rights"
      "id" = "urn:vcloud:rightsBundle:31482daa-c398-4938-895e-5dc6911a0641"
      "name" = "Default Rights Bundle"
      "publish_to_all_tenants" = false
      "read_only" = false
      "rights" = toset([
        "Access All Organization VDCs",
        "Catalog: Add vApp from My Cloud",
        "Catalog: CLSP Publish Subscribe",
        "Catalog: Change Owner",
        "Catalog: Create / Delete a Catalog",
        "Catalog: Edit Properties",
        "Catalog: Publish",
        "Catalog: Sharing",
        "Catalog: View ACL",
        "Catalog: View Private and Shared Catalogs",
        "Catalog: View Published Catalogs",
        "Certificate Library: View",
        "Custom entity: View all custom entity instances in org",
        "Custom entity: View custom entity instance",
        "General: Administrator Control",
        "General: Administrator View",
        "General: Send Notification",
        "Group / User: View",
        "Hybrid Cloud Operations: Acquire control ticket",
        "Hybrid Cloud Operations: Acquire from-the-cloud tunnel ticket",
        "Hybrid Cloud Operations: Acquire to-the-cloud tunnel ticket",
        "Hybrid Cloud Operations: Create from-the-cloud tunnel",
        "Hybrid Cloud Operations: Create to-the-cloud tunnel",
        "Hybrid Cloud Operations: Delete from-the-cloud tunnel",
        "Hybrid Cloud Operations: Delete to-the-cloud tunnel",
        "Hybrid Cloud Operations: Update from-the-cloud tunnel endpoint tag",
        "Hybrid Cloud Operations: View from-the-cloud tunnel",
        "Hybrid Cloud Operations: View to-the-cloud tunnel",
        "Organization Network: Edit Properties",
        "Organization Network: View",
        "Organization VDC: view metrics",
        "Organization vDC Compute Policy: View",
        "Organization vDC Distributed Firewall: Configure Rules",
        "Organization vDC Distributed Firewall: View Rules",
        "Organization vDC Gateway: Configure DHCP",
        "Organization vDC Gateway: Configure DNS",
        "Organization vDC Gateway: Configure Firewall",
        "Organization vDC Gateway: Configure IPSec VPN",
        "Organization vDC Gateway: Configure Load Balancer",
        "Organization vDC Gateway: Configure NAT",
        "Organization vDC Gateway: Configure Static Routing",
        "Organization vDC Gateway: Configure Syslog",
        "Organization vDC Gateway: Convert to Advanced Networking",
        "Organization vDC Gateway: View",
        "Organization vDC Gateway: View DHCP",
        "Organization vDC Gateway: View DNS",
        "Organization vDC Gateway: View Firewall",
        "Organization vDC Gateway: View IPSec VPN",
        "Organization vDC Gateway: View Load Balancer",
        "Organization vDC Gateway: View NAT",
        "Organization vDC Gateway: View Static Routing",
        "Organization vDC Named Disk: Change Owner",
        "Organization vDC Named Disk: Create",
        "Organization vDC Named Disk: Delete",
        "Organization vDC Named Disk: Edit Properties",
        "Organization vDC Named Disk: View Properties",
        "Organization vDC Network: Edit Properties",
        "Organization vDC Network: View Properties",
        "Organization vDC Storage Profile: Set Default",
        "Organization vDC: Edit",
        "Organization vDC: Edit ACL",
        "Organization vDC: Manage Firewall",
        "Organization vDC: VM-VM Affinity Edit",
        "Organization vDC: View",
        "Organization vDC: View ACL",
        "Organization: Edit Association Settings",
        "Organization: Edit Federation Settings",
        "Organization: Edit Leases Policy",
        "Organization: Edit OAuth Settings",
        "Organization: Edit Password Policy",
        "Organization: Edit Properties",
        "Organization: Edit Quotas Policy",
        "Organization: Edit SMTP Settings",
        "Organization: Import User/Group from IdP while Editing VDC ACL",
        "Organization: View",
        "Organization: view metrics",
        "Quota Policy Capabilities: View",
        "Role: Create, Edit, Delete, or Copy",
        "SSL: Test Connection",
        "Service Library: View service libraries",
        "Truststore: Manage",
        "Truststore: View",
        "UI Plugins: View",
        "VAPP_VM_METADATA_TO_VCENTER",
        "VDC Template: Instantiate",
        "VDC Template: View",
        "vApp Template / Media: Copy",
        "vApp Template / Media: Create / Upload",
        "vApp Template / Media: Edit",
        "vApp Template / Media: View",
        "vApp Template: Change Owner",
        "vApp Template: Checkout",
        "vApp Template: Download",
        "vApp: Change Owner",
        "vApp: Copy",
        "vApp: Create / Reconfigure",
        "vApp: Delete",
        "vApp: Download",
        "vApp: Edit Properties",
        "vApp: Edit VM CPU",
        "vApp: Edit VM Hard Disk",
        "vApp: Edit VM Memory",
        "vApp: Edit VM Network",
        "vApp: Edit VM Properties",
        "vApp: Manage VM Password Settings",
        "vApp: Power Operations",
        "vApp: Sharing",
        "vApp: Snapshot Operations",
        "vApp: Upload",
        "vApp: Use Console",
        "vApp: VM Boot Options",
        "vApp: View ACL",
        "vApp: View VM metrics",
      ])
      "tenants" = toset([
        "org1",
        "org2"
      ])
    }
    

    More information

    See Roles management for a broader description of how rights bundles and rights work together.

    Using getRightsBundle

    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 getRightsBundle(args: GetRightsBundleArgs, opts?: InvokeOptions): Promise<GetRightsBundleResult>
    function getRightsBundleOutput(args: GetRightsBundleOutputArgs, opts?: InvokeOptions): Output<GetRightsBundleResult>
    def get_rights_bundle(id: Optional[str] = None,
                          name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetRightsBundleResult
    def get_rights_bundle_output(id: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetRightsBundleResult]
    func LookupRightsBundle(ctx *Context, args *LookupRightsBundleArgs, opts ...InvokeOption) (*LookupRightsBundleResult, error)
    func LookupRightsBundleOutput(ctx *Context, args *LookupRightsBundleOutputArgs, opts ...InvokeOption) LookupRightsBundleResultOutput

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

    public static class GetRightsBundle 
    {
        public static Task<GetRightsBundleResult> InvokeAsync(GetRightsBundleArgs args, InvokeOptions? opts = null)
        public static Output<GetRightsBundleResult> Invoke(GetRightsBundleInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRightsBundleResult> getRightsBundle(GetRightsBundleArgs args, InvokeOptions options)
    public static Output<GetRightsBundleResult> getRightsBundle(GetRightsBundleArgs args, InvokeOptions options)
    
    fn::invoke:
      function: vcd:index/getRightsBundle:getRightsBundle
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the rights bundle.
    Id string
    Name string
    The name of the rights bundle.
    Id string
    name String
    The name of the rights bundle.
    id String
    name string
    The name of the rights bundle.
    id string
    name str
    The name of the rights bundle.
    id str
    name String
    The name of the rights bundle.
    id String

    getRightsBundle Result

    The following output properties are available:

    BundleKey string
    Key used for internationalization.
    Description string
    A description of the rights bundle
    Id string
    Name string
    PublishToAllTenants bool
    When true, publishes the rights bundle to all tenants
    ReadOnly bool
    Whether this rights bundle is read-only
    Rights List<string>
    Set of rights assigned to this role
    Tenants List<string>
    Set of tenants to which this rights bundle gets published. Ignored if publish_to_all_tenants is true.
    BundleKey string
    Key used for internationalization.
    Description string
    A description of the rights bundle
    Id string
    Name string
    PublishToAllTenants bool
    When true, publishes the rights bundle to all tenants
    ReadOnly bool
    Whether this rights bundle is read-only
    Rights []string
    Set of rights assigned to this role
    Tenants []string
    Set of tenants to which this rights bundle gets published. Ignored if publish_to_all_tenants is true.
    bundleKey String
    Key used for internationalization.
    description String
    A description of the rights bundle
    id String
    name String
    publishToAllTenants Boolean
    When true, publishes the rights bundle to all tenants
    readOnly Boolean
    Whether this rights bundle is read-only
    rights List<String>
    Set of rights assigned to this role
    tenants List<String>
    Set of tenants to which this rights bundle gets published. Ignored if publish_to_all_tenants is true.
    bundleKey string
    Key used for internationalization.
    description string
    A description of the rights bundle
    id string
    name string
    publishToAllTenants boolean
    When true, publishes the rights bundle to all tenants
    readOnly boolean
    Whether this rights bundle is read-only
    rights string[]
    Set of rights assigned to this role
    tenants string[]
    Set of tenants to which this rights bundle gets published. Ignored if publish_to_all_tenants is true.
    bundle_key str
    Key used for internationalization.
    description str
    A description of the rights bundle
    id str
    name str
    publish_to_all_tenants bool
    When true, publishes the rights bundle to all tenants
    read_only bool
    Whether this rights bundle is read-only
    rights Sequence[str]
    Set of rights assigned to this role
    tenants Sequence[str]
    Set of tenants to which this rights bundle gets published. Ignored if publish_to_all_tenants is true.
    bundleKey String
    Key used for internationalization.
    description String
    A description of the rights bundle
    id String
    name String
    publishToAllTenants Boolean
    When true, publishes the rights bundle to all tenants
    readOnly Boolean
    Whether this rights bundle is read-only
    rights List<String>
    Set of rights assigned to this role
    tenants List<String>
    Set of tenants to which this rights bundle gets published. Ignored if publish_to_all_tenants is true.

    Package Details

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