1. Packages
  2. Nsxt Provider
  3. API Docs
  4. getComputeCollection
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

nsxt.getComputeCollection

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

    This data source provides information about a Compute Collection configured on NSX.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nsxt from "@pulumi/nsxt";
    
    const testCluster = nsxt.getComputeCollection({
        displayName: "Compute_Cluster",
    });
    
    import pulumi
    import pulumi_nsxt as nsxt
    
    test_cluster = nsxt.get_compute_collection(display_name="Compute_Cluster")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/nsxt/v3/nsxt"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := nsxt.GetComputeCollection(ctx, &nsxt.GetComputeCollectionArgs{
    			DisplayName: "Compute_Cluster",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nsxt = Pulumi.Nsxt;
    
    return await Deployment.RunAsync(() => 
    {
        var testCluster = Nsxt.GetComputeCollection.Invoke(new()
        {
            DisplayName = "Compute_Cluster",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nsxt.NsxtFunctions;
    import com.pulumi.nsxt.inputs.GetComputeCollectionArgs;
    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 testCluster = NsxtFunctions.getComputeCollection(GetComputeCollectionArgs.builder()
                .displayName("Compute_Cluster")
                .build());
    
        }
    }
    
    variables:
      testCluster:
        fn::invoke:
          function: nsxt:getComputeCollection
          arguments:
            displayName: Compute_Cluster
    

    Using getComputeCollection

    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 getComputeCollection(args: GetComputeCollectionArgs, opts?: InvokeOptions): Promise<GetComputeCollectionResult>
    function getComputeCollectionOutput(args: GetComputeCollectionOutputArgs, opts?: InvokeOptions): Output<GetComputeCollectionResult>
    def get_compute_collection(cm_local_id: Optional[str] = None,
                               display_name: Optional[str] = None,
                               id: Optional[str] = None,
                               origin_id: Optional[str] = None,
                               origin_type: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetComputeCollectionResult
    def get_compute_collection_output(cm_local_id: Optional[pulumi.Input[str]] = None,
                               display_name: Optional[pulumi.Input[str]] = None,
                               id: Optional[pulumi.Input[str]] = None,
                               origin_id: Optional[pulumi.Input[str]] = None,
                               origin_type: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetComputeCollectionResult]
    func GetComputeCollection(ctx *Context, args *GetComputeCollectionArgs, opts ...InvokeOption) (*GetComputeCollectionResult, error)
    func GetComputeCollectionOutput(ctx *Context, args *GetComputeCollectionOutputArgs, opts ...InvokeOption) GetComputeCollectionResultOutput

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

    public static class GetComputeCollection 
    {
        public static Task<GetComputeCollectionResult> InvokeAsync(GetComputeCollectionArgs args, InvokeOptions? opts = null)
        public static Output<GetComputeCollectionResult> Invoke(GetComputeCollectionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetComputeCollectionResult> getComputeCollection(GetComputeCollectionArgs args, InvokeOptions options)
    public static Output<GetComputeCollectionResult> getComputeCollection(GetComputeCollectionArgs args, InvokeOptions options)
    
    fn::invoke:
      function: nsxt:index/getComputeCollection:getComputeCollection
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DisplayName string
    The Display Name of the Compute Collection to retrieve.
    CmLocalId string
    Local Id of the compute collection in the Compute Manager.
    Id string
    The ID of Compute Collection to retrieve.
    OriginId string
    Id of the compute manager from where this Compute Collection was discovered.
    OriginType string
    ComputeCollection type, f.e. VC_Cluster. Here the Compute Manager type prefix would help in differentiating similar named Compute Collection types from different Compute Managers.
    DisplayName string
    The Display Name of the Compute Collection to retrieve.
    CmLocalId string
    Local Id of the compute collection in the Compute Manager.
    Id string
    The ID of Compute Collection to retrieve.
    OriginId string
    Id of the compute manager from where this Compute Collection was discovered.
    OriginType string
    ComputeCollection type, f.e. VC_Cluster. Here the Compute Manager type prefix would help in differentiating similar named Compute Collection types from different Compute Managers.
    displayName String
    The Display Name of the Compute Collection to retrieve.
    cmLocalId String
    Local Id of the compute collection in the Compute Manager.
    id String
    The ID of Compute Collection to retrieve.
    originId String
    Id of the compute manager from where this Compute Collection was discovered.
    originType String
    ComputeCollection type, f.e. VC_Cluster. Here the Compute Manager type prefix would help in differentiating similar named Compute Collection types from different Compute Managers.
    displayName string
    The Display Name of the Compute Collection to retrieve.
    cmLocalId string
    Local Id of the compute collection in the Compute Manager.
    id string
    The ID of Compute Collection to retrieve.
    originId string
    Id of the compute manager from where this Compute Collection was discovered.
    originType string
    ComputeCollection type, f.e. VC_Cluster. Here the Compute Manager type prefix would help in differentiating similar named Compute Collection types from different Compute Managers.
    display_name str
    The Display Name of the Compute Collection to retrieve.
    cm_local_id str
    Local Id of the compute collection in the Compute Manager.
    id str
    The ID of Compute Collection to retrieve.
    origin_id str
    Id of the compute manager from where this Compute Collection was discovered.
    origin_type str
    ComputeCollection type, f.e. VC_Cluster. Here the Compute Manager type prefix would help in differentiating similar named Compute Collection types from different Compute Managers.
    displayName String
    The Display Name of the Compute Collection to retrieve.
    cmLocalId String
    Local Id of the compute collection in the Compute Manager.
    id String
    The ID of Compute Collection to retrieve.
    originId String
    Id of the compute manager from where this Compute Collection was discovered.
    originType String
    ComputeCollection type, f.e. VC_Cluster. Here the Compute Manager type prefix would help in differentiating similar named Compute Collection types from different Compute Managers.

    getComputeCollection Result

    The following output properties are available:

    DisplayName string
    Id string
    CmLocalId string
    OriginId string
    OriginType string
    DisplayName string
    Id string
    CmLocalId string
    OriginId string
    OriginType string
    displayName String
    id String
    cmLocalId String
    originId String
    originType String
    displayName string
    id string
    cmLocalId string
    originId string
    originType string
    displayName String
    id String
    cmLocalId String
    originId String
    originType String

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    nsxt logo
    nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware