GetProject

Provides details about a specific project in the gitlab provider. The results include the name of the project, path, description, default branch, etc.

Example Usage

using Pulumi;
using GitLab = Pulumi.GitLab;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(GitLab.GetProject.InvokeAsync(new GitLab.GetProjectArgs
        {
            Id = 30,
        }));
    }

}

Coming soon!

import pulumi
import pulumi_gitlab as gitlab

example = gitlab.get_project(id=30)

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const example = pulumi.output(gitlab.getProject({
    id: 30,
}, { async: true }));

Using GetProject

function getProject(args: GetProjectArgs, opts?: InvokeOptions): Promise<GetProjectResult>

function  get_project(archived=None, default_branch=None, description=None, http_url_to_repo=None, id=None, issues_enabled=None, lfs_enabled=None, merge_requests_enabled=None, name=None, namespace_id=None, path=None, pipelines_enabled=None, remove_source_branch_after_merge=None, request_access_enabled=None, runners_token=None, snippets_enabled=None, ssh_url_to_repo=None, visibility_level=None, web_url=None, wiki_enabled=None, opts=None)

func LookupProject(ctx *Context, args *LookupProjectArgs, opts ...InvokeOption) (*LookupProjectResult, error)

Note: This function is named LookupProject in the Go SDK.

public static class GetProject {
    public static Task<GetProjectResult> InvokeAsync(GetProjectArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Id int: The integer that uniquely identifies the project within the gitlab install.
Archived bool: Whether the project is in read-only mode (archived).
DefaultBranch string: The default branch for the project.
Description string: A description of the project.
HttpUrlToRepo string: URL that can be provided to git clone to clone the repository via HTTP.
IssuesEnabled bool: Enable issue tracking for the project.
LfsEnabled bool: Enable LFS for the project.
MergeRequestsEnabled bool: Enable merge requests for the project.
Name string
NamespaceId int: The namespace (group or user) of the project. Defaults to your user. See gitlab..Group for an example.
Path string: The path of the repository.
PipelinesEnabled bool: Enable pipelines for the project.
RemoveSourceBranchAfterMerge bool: Enable Delete source branch option by default for all new merge requests
RequestAccessEnabled bool: Allow users to request member access.
RunnersToken string: Registration token to use during runner setup.
SnippetsEnabled bool: Enable snippets for the project.
SshUrlToRepo string: URL that can be provided to git clone to clone the repository via SSH.
VisibilityLevel string: Repositories are created as private by default.
WebUrl string: URL that can be used to find the project in a browser.
WikiEnabled bool: Enable wiki for the project.

Id int: The integer that uniquely identifies the project within the gitlab install.
Archived bool: Whether the project is in read-only mode (archived).
DefaultBranch string: The default branch for the project.
Description string: A description of the project.
HttpUrlToRepo string: URL that can be provided to git clone to clone the repository via HTTP.
IssuesEnabled bool: Enable issue tracking for the project.
LfsEnabled bool: Enable LFS for the project.
MergeRequestsEnabled bool: Enable merge requests for the project.
Name string
NamespaceId int: The namespace (group or user) of the project. Defaults to your user. See gitlab..Group for an example.
Path string: The path of the repository.
PipelinesEnabled bool: Enable pipelines for the project.
RemoveSourceBranchAfterMerge bool: Enable Delete source branch option by default for all new merge requests
RequestAccessEnabled bool: Allow users to request member access.
RunnersToken string: Registration token to use during runner setup.
SnippetsEnabled bool: Enable snippets for the project.
SshUrlToRepo string: URL that can be provided to git clone to clone the repository via SSH.
VisibilityLevel string: Repositories are created as private by default.
WebUrl string: URL that can be used to find the project in a browser.
WikiEnabled bool: Enable wiki for the project.

id number: The integer that uniquely identifies the project within the gitlab install.
archived boolean: Whether the project is in read-only mode (archived).
defaultBranch string: The default branch for the project.
description string: A description of the project.
httpUrlToRepo string: URL that can be provided to git clone to clone the repository via HTTP.
issuesEnabled boolean: Enable issue tracking for the project.
lfsEnabled boolean: Enable LFS for the project.
mergeRequestsEnabled boolean: Enable merge requests for the project.
name string
namespaceId number: The namespace (group or user) of the project. Defaults to your user. See gitlab..Group for an example.
path string: The path of the repository.
pipelinesEnabled boolean: Enable pipelines for the project.
removeSourceBranchAfterMerge boolean: Enable Delete source branch option by default for all new merge requests
requestAccessEnabled boolean: Allow users to request member access.
runnersToken string: Registration token to use during runner setup.
snippetsEnabled boolean: Enable snippets for the project.
sshUrlToRepo string: URL that can be provided to git clone to clone the repository via SSH.
visibilityLevel string: Repositories are created as private by default.
webUrl string: URL that can be used to find the project in a browser.
wikiEnabled boolean: Enable wiki for the project.

id float: The integer that uniquely identifies the project within the gitlab install.
archived bool: Whether the project is in read-only mode (archived).
default_branch str: The default branch for the project.
description str: A description of the project.
http_url_to_repo str: URL that can be provided to git clone to clone the repository via HTTP.
issues_enabled bool: Enable issue tracking for the project.
lfs_enabled bool: Enable LFS for the project.
merge_requests_enabled bool: Enable merge requests for the project.
name str
namespace_id float: The namespace (group or user) of the project. Defaults to your user. See gitlab..Group for an example.
path str: The path of the repository.
pipelines_enabled bool: Enable pipelines for the project.
remove_source_branch_after_merge bool: Enable Delete source branch option by default for all new merge requests
request_access_enabled bool: Allow users to request member access.
runners_token str: Registration token to use during runner setup.
snippets_enabled bool: Enable snippets for the project.
ssh_url_to_repo str: URL that can be provided to git clone to clone the repository via SSH.
visibility_level str: Repositories are created as private by default.
web_url str: URL that can be used to find the project in a browser.
wiki_enabled bool: Enable wiki for the project.

GetProject Result

The following output properties are available:

Archived bool: Whether the project is in read-only mode (archived).
DefaultBranch string: The default branch for the project.
Description string: A description of the project.
HttpUrlToRepo string: URL that can be provided to git clone to clone the repository via HTTP.
Id int: Integer that uniquely identifies the project within the gitlab install.
IssuesEnabled bool: Enable issue tracking for the project.
LfsEnabled bool: Enable LFS for the project.
MergeRequestsEnabled bool: Enable merge requests for the project.
Name string
NamespaceId int: The namespace (group or user) of the project. Defaults to your user. See gitlab..Group for an example.
Path string: The path of the repository.
PipelinesEnabled bool: Enable pipelines for the project.
RemoveSourceBranchAfterMerge bool: Enable Delete source branch option by default for all new merge requests
RequestAccessEnabled bool: Allow users to request member access.
RunnersToken string: Registration token to use during runner setup.
SnippetsEnabled bool: Enable snippets for the project.
SshUrlToRepo string: URL that can be provided to git clone to clone the repository via SSH.
VisibilityLevel string: Repositories are created as private by default.
WebUrl string: URL that can be used to find the project in a browser.
WikiEnabled bool: Enable wiki for the project.

Archived bool: Whether the project is in read-only mode (archived).
DefaultBranch string: The default branch for the project.
Description string: A description of the project.
HttpUrlToRepo string: URL that can be provided to git clone to clone the repository via HTTP.
Id int: Integer that uniquely identifies the project within the gitlab install.
IssuesEnabled bool: Enable issue tracking for the project.
LfsEnabled bool: Enable LFS for the project.
MergeRequestsEnabled bool: Enable merge requests for the project.
Name string
NamespaceId int: The namespace (group or user) of the project. Defaults to your user. See gitlab..Group for an example.
Path string: The path of the repository.
PipelinesEnabled bool: Enable pipelines for the project.
RemoveSourceBranchAfterMerge bool: Enable Delete source branch option by default for all new merge requests
RequestAccessEnabled bool: Allow users to request member access.
RunnersToken string: Registration token to use during runner setup.
SnippetsEnabled bool: Enable snippets for the project.
SshUrlToRepo string: URL that can be provided to git clone to clone the repository via SSH.
VisibilityLevel string: Repositories are created as private by default.
WebUrl string: URL that can be used to find the project in a browser.
WikiEnabled bool: Enable wiki for the project.

archived boolean: Whether the project is in read-only mode (archived).
defaultBranch string: The default branch for the project.
description string: A description of the project.
httpUrlToRepo string: URL that can be provided to git clone to clone the repository via HTTP.
id number: Integer that uniquely identifies the project within the gitlab install.
issuesEnabled boolean: Enable issue tracking for the project.
lfsEnabled boolean: Enable LFS for the project.
mergeRequestsEnabled boolean: Enable merge requests for the project.
name string
namespaceId number: The namespace (group or user) of the project. Defaults to your user. See gitlab..Group for an example.
path string: The path of the repository.
pipelinesEnabled boolean: Enable pipelines for the project.
removeSourceBranchAfterMerge boolean: Enable Delete source branch option by default for all new merge requests
requestAccessEnabled boolean: Allow users to request member access.
runnersToken string: Registration token to use during runner setup.
snippetsEnabled boolean: Enable snippets for the project.
sshUrlToRepo string: URL that can be provided to git clone to clone the repository via SSH.
visibilityLevel string: Repositories are created as private by default.
webUrl string: URL that can be used to find the project in a browser.
wikiEnabled boolean: Enable wiki for the project.

archived bool: Whether the project is in read-only mode (archived).
default_branch str: The default branch for the project.
description str: A description of the project.
http_url_to_repo str: URL that can be provided to git clone to clone the repository via HTTP.
id float: Integer that uniquely identifies the project within the gitlab install.
issues_enabled bool: Enable issue tracking for the project.
lfs_enabled bool: Enable LFS for the project.
merge_requests_enabled bool: Enable merge requests for the project.
name str
namespace_id float: The namespace (group or user) of the project. Defaults to your user. See gitlab..Group for an example.
path str: The path of the repository.
pipelines_enabled bool: Enable pipelines for the project.
remove_source_branch_after_merge bool: Enable Delete source branch option by default for all new merge requests
request_access_enabled bool: Allow users to request member access.
runners_token str: Registration token to use during runner setup.
snippets_enabled bool: Enable snippets for the project.
ssh_url_to_repo str: URL that can be provided to git clone to clone the repository via SSH.
visibility_level str: Repositories are created as private by default.
web_url str: URL that can be used to find the project in a browser.
wiki_enabled bool: Enable wiki for the project.

Package Details

Repository: https://github.com/pulumi/pulumi-gitlab
License: Apache-2.0
Notes: This Pulumi package is based on the gitlab Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetProject

Example Usage

Using GetProject

GetProject Result

Package Details

On This Page