1. Packages
  2. Gcore Provider
  3. API Docs
  4. getCloudProjects
Viewing docs for gcore 2.0.0-alpha.2
published on Tuesday, Mar 24, 2026 by g-core
gcore logo
Viewing docs for gcore 2.0.0-alpha.2
published on Tuesday, Mar 24, 2026 by g-core

    Projects are organizational units that group cloud resources for access control and billing.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as gcore from "@pulumi/gcore";
    
    const exampleCloudProjects = gcore.getCloudProjects({
        clientId: 1,
        name: "my-project",
    });
    
    import pulumi
    import pulumi_gcore as gcore
    
    example_cloud_projects = gcore.get_cloud_projects(client_id=1,
        name="my-project")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/v2/gcore"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := gcore.GetCloudProjects(ctx, &gcore.GetCloudProjectsArgs{
    			ClientId: pulumi.Float64Ref(1),
    			Name:     pulumi.StringRef("my-project"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcore = Pulumi.Gcore;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleCloudProjects = Gcore.GetCloudProjects.Invoke(new()
        {
            ClientId = 1,
            Name = "my-project",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcore.GcoreFunctions;
    import com.pulumi.gcore.inputs.GetCloudProjectsArgs;
    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 exampleCloudProjects = GcoreFunctions.getCloudProjects(GetCloudProjectsArgs.builder()
                .clientId(1)
                .name("my-project")
                .build());
    
        }
    }
    
    variables:
      exampleCloudProjects:
        fn::invoke:
          function: gcore:getCloudProjects
          arguments:
            clientId: 1
            name: my-project
    

    Using getCloudProjects

    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 getCloudProjects(args: GetCloudProjectsArgs, opts?: InvokeOptions): Promise<GetCloudProjectsResult>
    function getCloudProjectsOutput(args: GetCloudProjectsOutputArgs, opts?: InvokeOptions): Output<GetCloudProjectsResult>
    def get_cloud_projects(client_id: Optional[float] = None,
                           include_deleted: Optional[bool] = None,
                           max_items: Optional[float] = None,
                           name: Optional[str] = None,
                           order_by: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetCloudProjectsResult
    def get_cloud_projects_output(client_id: Optional[pulumi.Input[float]] = None,
                           include_deleted: Optional[pulumi.Input[bool]] = None,
                           max_items: Optional[pulumi.Input[float]] = None,
                           name: Optional[pulumi.Input[str]] = None,
                           order_by: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetCloudProjectsResult]
    func GetCloudProjects(ctx *Context, args *GetCloudProjectsArgs, opts ...InvokeOption) (*GetCloudProjectsResult, error)
    func GetCloudProjectsOutput(ctx *Context, args *GetCloudProjectsOutputArgs, opts ...InvokeOption) GetCloudProjectsResultOutput

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

    public static class GetCloudProjects 
    {
        public static Task<GetCloudProjectsResult> InvokeAsync(GetCloudProjectsArgs args, InvokeOptions? opts = null)
        public static Output<GetCloudProjectsResult> Invoke(GetCloudProjectsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCloudProjectsResult> getCloudProjects(GetCloudProjectsArgs args, InvokeOptions options)
    public static Output<GetCloudProjectsResult> getCloudProjects(GetCloudProjectsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: gcore:index/getCloudProjects:getCloudProjects
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ClientId double
    Client ID filter for administrators.
    IncludeDeleted bool
    Whether to include deleted projects in the response.
    MaxItems double
    Max items to fetch, default: 1000
    Name string
    Name to filter the results by.
    OrderBy string
    Order by field and direction. Available values: "createdat.asc", "createdat.desc", "name.asc", "name.desc".
    ClientId float64
    Client ID filter for administrators.
    IncludeDeleted bool
    Whether to include deleted projects in the response.
    MaxItems float64
    Max items to fetch, default: 1000
    Name string
    Name to filter the results by.
    OrderBy string
    Order by field and direction. Available values: "createdat.asc", "createdat.desc", "name.asc", "name.desc".
    clientId Double
    Client ID filter for administrators.
    includeDeleted Boolean
    Whether to include deleted projects in the response.
    maxItems Double
    Max items to fetch, default: 1000
    name String
    Name to filter the results by.
    orderBy String
    Order by field and direction. Available values: "createdat.asc", "createdat.desc", "name.asc", "name.desc".
    clientId number
    Client ID filter for administrators.
    includeDeleted boolean
    Whether to include deleted projects in the response.
    maxItems number
    Max items to fetch, default: 1000
    name string
    Name to filter the results by.
    orderBy string
    Order by field and direction. Available values: "createdat.asc", "createdat.desc", "name.asc", "name.desc".
    client_id float
    Client ID filter for administrators.
    include_deleted bool
    Whether to include deleted projects in the response.
    max_items float
    Max items to fetch, default: 1000
    name str
    Name to filter the results by.
    order_by str
    Order by field and direction. Available values: "createdat.asc", "createdat.desc", "name.asc", "name.desc".
    clientId Number
    Client ID filter for administrators.
    includeDeleted Boolean
    Whether to include deleted projects in the response.
    maxItems Number
    Max items to fetch, default: 1000
    name String
    Name to filter the results by.
    orderBy String
    Order by field and direction. Available values: "createdat.asc", "createdat.desc", "name.asc", "name.desc".

    getCloudProjects Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    IncludeDeleted bool
    Whether to include deleted projects in the response.
    Items List<GetCloudProjectsItem>
    The items returned by the data source
    OrderBy string
    Order by field and direction. Available values: "createdat.asc", "createdat.desc", "name.asc", "name.desc".
    ClientId double
    Client ID filter for administrators.
    MaxItems double
    Max items to fetch, default: 1000
    Name string
    Name to filter the results by.
    Id string
    The provider-assigned unique ID for this managed resource.
    IncludeDeleted bool
    Whether to include deleted projects in the response.
    Items []GetCloudProjectsItem
    The items returned by the data source
    OrderBy string
    Order by field and direction. Available values: "createdat.asc", "createdat.desc", "name.asc", "name.desc".
    ClientId float64
    Client ID filter for administrators.
    MaxItems float64
    Max items to fetch, default: 1000
    Name string
    Name to filter the results by.
    id String
    The provider-assigned unique ID for this managed resource.
    includeDeleted Boolean
    Whether to include deleted projects in the response.
    items List<GetCloudProjectsItem>
    The items returned by the data source
    orderBy String
    Order by field and direction. Available values: "createdat.asc", "createdat.desc", "name.asc", "name.desc".
    clientId Double
    Client ID filter for administrators.
    maxItems Double
    Max items to fetch, default: 1000
    name String
    Name to filter the results by.
    id string
    The provider-assigned unique ID for this managed resource.
    includeDeleted boolean
    Whether to include deleted projects in the response.
    items GetCloudProjectsItem[]
    The items returned by the data source
    orderBy string
    Order by field and direction. Available values: "createdat.asc", "createdat.desc", "name.asc", "name.desc".
    clientId number
    Client ID filter for administrators.
    maxItems number
    Max items to fetch, default: 1000
    name string
    Name to filter the results by.
    id str
    The provider-assigned unique ID for this managed resource.
    include_deleted bool
    Whether to include deleted projects in the response.
    items Sequence[GetCloudProjectsItem]
    The items returned by the data source
    order_by str
    Order by field and direction. Available values: "createdat.asc", "createdat.desc", "name.asc", "name.desc".
    client_id float
    Client ID filter for administrators.
    max_items float
    Max items to fetch, default: 1000
    name str
    Name to filter the results by.
    id String
    The provider-assigned unique ID for this managed resource.
    includeDeleted Boolean
    Whether to include deleted projects in the response.
    items List<Property Map>
    The items returned by the data source
    orderBy String
    Order by field and direction. Available values: "createdat.asc", "createdat.desc", "name.asc", "name.desc".
    clientId Number
    Client ID filter for administrators.
    maxItems Number
    Max items to fetch, default: 1000
    name String
    Name to filter the results by.

    Supporting Types

    GetCloudProjectsItem

    ClientId double
    ID associated with the client.
    CreatedAt string
    Datetime of creation, which is automatically generated.
    DeletedAt string
    Datetime of deletion, which is automatically generated if the project is deleted.
    Description string
    Description of the project.
    Id double
    Project ID, which is automatically generated upon creation.
    IsDefault bool
    Indicates if the project is the default one. Each client always has one default project.
    Name string
    Unique project name for a client.
    State string
    The state of the project.
    ClientId float64
    ID associated with the client.
    CreatedAt string
    Datetime of creation, which is automatically generated.
    DeletedAt string
    Datetime of deletion, which is automatically generated if the project is deleted.
    Description string
    Description of the project.
    Id float64
    Project ID, which is automatically generated upon creation.
    IsDefault bool
    Indicates if the project is the default one. Each client always has one default project.
    Name string
    Unique project name for a client.
    State string
    The state of the project.
    clientId Double
    ID associated with the client.
    createdAt String
    Datetime of creation, which is automatically generated.
    deletedAt String
    Datetime of deletion, which is automatically generated if the project is deleted.
    description String
    Description of the project.
    id Double
    Project ID, which is automatically generated upon creation.
    isDefault Boolean
    Indicates if the project is the default one. Each client always has one default project.
    name String
    Unique project name for a client.
    state String
    The state of the project.
    clientId number
    ID associated with the client.
    createdAt string
    Datetime of creation, which is automatically generated.
    deletedAt string
    Datetime of deletion, which is automatically generated if the project is deleted.
    description string
    Description of the project.
    id number
    Project ID, which is automatically generated upon creation.
    isDefault boolean
    Indicates if the project is the default one. Each client always has one default project.
    name string
    Unique project name for a client.
    state string
    The state of the project.
    client_id float
    ID associated with the client.
    created_at str
    Datetime of creation, which is automatically generated.
    deleted_at str
    Datetime of deletion, which is automatically generated if the project is deleted.
    description str
    Description of the project.
    id float
    Project ID, which is automatically generated upon creation.
    is_default bool
    Indicates if the project is the default one. Each client always has one default project.
    name str
    Unique project name for a client.
    state str
    The state of the project.
    clientId Number
    ID associated with the client.
    createdAt String
    Datetime of creation, which is automatically generated.
    deletedAt String
    Datetime of deletion, which is automatically generated if the project is deleted.
    description String
    Description of the project.
    id Number
    Project ID, which is automatically generated upon creation.
    isDefault Boolean
    Indicates if the project is the default one. Each client always has one default project.
    name String
    Unique project name for a client.
    state String
    The state of the project.

    Package Details

    Repository
    gcore g-core/terraform-provider-gcore
    License
    Notes
    This Pulumi package is based on the gcore Terraform Provider.
    gcore logo
    Viewing docs for gcore 2.0.0-alpha.2
    published on Tuesday, Mar 24, 2026 by g-core
      Try Pulumi Cloud free. Your team will thank you.