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

vcd.getExternalEndpoint

Explore with Pulumi AI

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

    Supported in provider v3.14+ and VCD 10.4.3+.

    Provides a data source to read External Endpoints in VMware Cloud Director. An External Endpoint holds information for the HTTPS endpoint which requests will be proxied to when using a vcd.ApiFilter.

    Only System Administrator can use this data source.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vcd from "@pulumi/vcd";
    
    const externalEndpoint1 = vcd.getExternalEndpoint({
        name: "my-endpoint",
        vendor: "vmware",
        version: "1.0.0",
    });
    
    import pulumi
    import pulumi_vcd as vcd
    
    external_endpoint1 = vcd.get_external_endpoint(name="my-endpoint",
        vendor="vmware",
        version="1.0.0")
    
    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.LookupExternalEndpoint(ctx, &vcd.LookupExternalEndpointArgs{
    			Name:    "my-endpoint",
    			Vendor:  "vmware",
    			Version: "1.0.0",
    		}, 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 externalEndpoint1 = Vcd.GetExternalEndpoint.Invoke(new()
        {
            Name = "my-endpoint",
            Vendor = "vmware",
            Version = "1.0.0",
        });
    
    });
    
    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.GetExternalEndpointArgs;
    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 externalEndpoint1 = VcdFunctions.getExternalEndpoint(GetExternalEndpointArgs.builder()
                .name("my-endpoint")
                .vendor("vmware")
                .version("1.0.0")
                .build());
    
        }
    }
    
    variables:
      externalEndpoint1:
        fn::invoke:
          function: vcd:getExternalEndpoint
          arguments:
            name: my-endpoint
            vendor: vmware
            version: 1.0.0
    

    Using getExternalEndpoint

    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 getExternalEndpoint(args: GetExternalEndpointArgs, opts?: InvokeOptions): Promise<GetExternalEndpointResult>
    function getExternalEndpointOutput(args: GetExternalEndpointOutputArgs, opts?: InvokeOptions): Output<GetExternalEndpointResult>
    def get_external_endpoint(id: Optional[str] = None,
                              name: Optional[str] = None,
                              vendor: Optional[str] = None,
                              version: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetExternalEndpointResult
    def get_external_endpoint_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[GetExternalEndpointResult]
    func LookupExternalEndpoint(ctx *Context, args *LookupExternalEndpointArgs, opts ...InvokeOption) (*LookupExternalEndpointResult, error)
    func LookupExternalEndpointOutput(ctx *Context, args *LookupExternalEndpointOutputArgs, opts ...InvokeOption) LookupExternalEndpointResultOutput

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

    public static class GetExternalEndpoint 
    {
        public static Task<GetExternalEndpointResult> InvokeAsync(GetExternalEndpointArgs args, InvokeOptions? opts = null)
        public static Output<GetExternalEndpointResult> Invoke(GetExternalEndpointInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetExternalEndpointResult> getExternalEndpoint(GetExternalEndpointArgs args, InvokeOptions options)
    public static Output<GetExternalEndpointResult> getExternalEndpoint(GetExternalEndpointArgs args, InvokeOptions options)
    
    fn::invoke:
      function: vcd:index/getExternalEndpoint:getExternalEndpoint
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the External Endpoint
    Vendor string
    The vendor name of the External Endpoint
    Version string
    The version of the External Endpoint
    Id string
    Name string
    The name of the External Endpoint
    Vendor string
    The vendor name of the External Endpoint
    Version string
    The version of the External Endpoint
    Id string
    name String
    The name of the External Endpoint
    vendor String
    The vendor name of the External Endpoint
    version String
    The version of the External Endpoint
    id String
    name string
    The name of the External Endpoint
    vendor string
    The vendor name of the External Endpoint
    version string
    The version of the External Endpoint
    id string
    name str
    The name of the External Endpoint
    vendor str
    The vendor name of the External Endpoint
    version str
    The version of the External Endpoint
    id str
    name String
    The name of the External Endpoint
    vendor String
    The vendor name of the External Endpoint
    version String
    The version of the External Endpoint
    id String

    getExternalEndpoint Result

    The following output properties are available:

    Description string
    Enabled bool
    Id string
    Name string
    RootUrl string
    Vendor string
    Version string
    Description string
    Enabled bool
    Id string
    Name string
    RootUrl string
    Vendor string
    Version string
    description String
    enabled Boolean
    id String
    name String
    rootUrl String
    vendor String
    version String
    description string
    enabled boolean
    id string
    name string
    rootUrl string
    vendor string
    version string
    description String
    enabled Boolean
    id String
    name String
    rootUrl String
    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