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

vcd.getUiPlugin

Explore with Pulumi AI

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

    Provides a VMware Cloud Director UI Plugin data source. This can be used to fetch and read an existing UI Plugin.

    Reading UI Plugins requires System Administrator privileges.

    Supported in provider v3.10+ and requires VCD 10.3+

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vcd from "@pulumi/vcd";
    
    const existingUiPlugin = vcd.getUiPlugin({
        vendor: "VMware",
        name: "Customize Portal",
        version: "3.1.4",
    });
    export const license = existingUiPlugin.then(existingUiPlugin => existingUiPlugin.license);
    export const tenants = existingUiPlugin.then(existingUiPlugin => existingUiPlugin.tenantIds);
    
    import pulumi
    import pulumi_vcd as vcd
    
    existing_ui_plugin = vcd.get_ui_plugin(vendor="VMware",
        name="Customize Portal",
        version="3.1.4")
    pulumi.export("license", existing_ui_plugin.license)
    pulumi.export("tenants", existing_ui_plugin.tenant_ids)
    
    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 {
    		existingUiPlugin, err := vcd.LookupUiPlugin(ctx, &vcd.LookupUiPluginArgs{
    			Vendor:  "VMware",
    			Name:    "Customize Portal",
    			Version: "3.1.4",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("license", existingUiPlugin.License)
    		ctx.Export("tenants", existingUiPlugin.TenantIds)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vcd = Pulumi.Vcd;
    
    return await Deployment.RunAsync(() => 
    {
        var existingUiPlugin = Vcd.GetUiPlugin.Invoke(new()
        {
            Vendor = "VMware",
            Name = "Customize Portal",
            Version = "3.1.4",
        });
    
        return new Dictionary<string, object?>
        {
            ["license"] = existingUiPlugin.Apply(getUiPluginResult => getUiPluginResult.License),
            ["tenants"] = existingUiPlugin.Apply(getUiPluginResult => getUiPluginResult.TenantIds),
        };
    });
    
    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.GetUiPluginArgs;
    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 existingUiPlugin = VcdFunctions.getUiPlugin(GetUiPluginArgs.builder()
                .vendor("VMware")
                .name("Customize Portal")
                .version("3.1.4")
                .build());
    
            ctx.export("license", existingUiPlugin.applyValue(getUiPluginResult -> getUiPluginResult.license()));
            ctx.export("tenants", existingUiPlugin.applyValue(getUiPluginResult -> getUiPluginResult.tenantIds()));
        }
    }
    
    variables:
      existingUiPlugin:
        fn::invoke:
          function: vcd:getUiPlugin
          arguments:
            vendor: VMware
            name: Customize Portal
            version: 3.1.4
    outputs:
      license: ${existingUiPlugin.license}
      tenants: ${existingUiPlugin.tenantIds}
    

    Using getUiPlugin

    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 getUiPlugin(args: GetUiPluginArgs, opts?: InvokeOptions): Promise<GetUiPluginResult>
    function getUiPluginOutput(args: GetUiPluginOutputArgs, opts?: InvokeOptions): Output<GetUiPluginResult>
    def get_ui_plugin(id: Optional[str] = None,
                      name: Optional[str] = None,
                      vendor: Optional[str] = None,
                      version: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetUiPluginResult
    def get_ui_plugin_output(id: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      vendor: Optional[pulumi.Input[str]] = None,
                      version: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetUiPluginResult]
    func LookupUiPlugin(ctx *Context, args *LookupUiPluginArgs, opts ...InvokeOption) (*LookupUiPluginResult, error)
    func LookupUiPluginOutput(ctx *Context, args *LookupUiPluginOutputArgs, opts ...InvokeOption) LookupUiPluginResultOutput

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

    public static class GetUiPlugin 
    {
        public static Task<GetUiPluginResult> InvokeAsync(GetUiPluginArgs args, InvokeOptions? opts = null)
        public static Output<GetUiPluginResult> Invoke(GetUiPluginInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetUiPluginResult> getUiPlugin(GetUiPluginArgs args, InvokeOptions options)
    public static Output<GetUiPluginResult> getUiPlugin(GetUiPluginArgs args, InvokeOptions options)
    
    fn::invoke:
      function: vcd:index/getUiPlugin:getUiPlugin
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the UI Plugin
    Vendor string
    The vendor of the UI Plugin
    Version string
    The version of the UI Plugin
    Id string
    Name string
    The name of the UI Plugin
    Vendor string
    The vendor of the UI Plugin
    Version string
    The version of the UI Plugin
    Id string
    name String
    The name of the UI Plugin
    vendor String
    The vendor of the UI Plugin
    version String
    The version of the UI Plugin
    id String
    name string
    The name of the UI Plugin
    vendor string
    The vendor of the UI Plugin
    version string
    The version of the UI Plugin
    id string
    name str
    The name of the UI Plugin
    vendor str
    The vendor of the UI Plugin
    version str
    The version of the UI Plugin
    id str
    name String
    The name of the UI Plugin
    vendor String
    The vendor of the UI Plugin
    version String
    The version of the UI Plugin
    id String

    getUiPlugin Result

    The following output properties are available:

    Description string
    Enabled bool
    Id string
    License string
    Link string
    Name string
    ProviderScoped bool
    Status string
    TenantIds List<string>
    TenantScoped bool
    Vendor string
    Version string
    Description string
    Enabled bool
    Id string
    License string
    Link string
    Name string
    ProviderScoped bool
    Status string
    TenantIds []string
    TenantScoped bool
    Vendor string
    Version string
    description String
    enabled Boolean
    id String
    license String
    link String
    name String
    providerScoped Boolean
    status String
    tenantIds List<String>
    tenantScoped Boolean
    vendor String
    version String
    description string
    enabled boolean
    id string
    license string
    link string
    name string
    providerScoped boolean
    status string
    tenantIds string[]
    tenantScoped boolean
    vendor string
    version string
    description String
    enabled Boolean
    id String
    license String
    link String
    name String
    providerScoped Boolean
    status String
    tenantIds List<String>
    tenantScoped Boolean
    vendor String
    version String

    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