AzureDevOps

v2.5.0 published on Monday, Jul 25, 2022 by Pulumi

getGitRepository

Use this data source to access information about a single (existing) Git Repository within Azure DevOps. To read information about multiple Git Repositories use the data source azuredevops.getRepositories

Example Usage

using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(AzureDevOps.GetProject.InvokeAsync(new AzureDevOps.GetProjectArgs
        {
            Name = "Example Project",
        }));
        var example_single_repo = example.Apply(example => Output.Create(AzureDevOps.GetGitRepository.InvokeAsync(new AzureDevOps.GetGitRepositoryArgs
        {
            ProjectId = example.Id,
            Name = "Example Repository",
        })));
    }

}
package main

import (
	"github.com/pulumi/pulumi-azuredevops/sdk/v2/go/azuredevops"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := azuredevops.LookupProject(ctx, &GetProjectArgs{
			Name: pulumi.StringRef("Example Project"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = azuredevops.GetGitRepository(ctx, &GetGitRepositoryArgs{
			ProjectId: example.Id,
			Name:      "Example Repository",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuredevops.AzuredevopsFunctions;
import com.pulumi.azuredevops.Core.inputs.GetProjectArgs;
import com.pulumi.azuredevops.inputs.GetGitRepositoryArgs;
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 example = AzuredevopsFunctions.getProject(GetProjectArgs.builder()
            .name("Example Project")
            .build());

        final var example-single-repo = AzuredevopsFunctions.getGitRepository(GetGitRepositoryArgs.builder()
            .projectId(example.applyValue(getProjectResult -> getProjectResult.id()))
            .name("Example Repository")
            .build());

    }
}
import pulumi
import pulumi_azuredevops as azuredevops

example = azuredevops.get_project(name="Example Project")
example_single_repo = azuredevops.get_git_repository(project_id=example.id,
    name="Example Repository")
import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";

const example = azuredevops.getProject({
    name: "Example Project",
});
const example-single-repo = example.then(example => azuredevops.getGitRepository({
    projectId: example.id,
    name: "Example Repository",
}));
variables:
  example:
    Fn::Invoke:
      Function: azuredevops:getProject
      Arguments:
        name: Example Project
  example-single-repo:
    Fn::Invoke:
      Function: azuredevops:getGitRepository
      Arguments:
        projectId: ${example.id}
        name: Example Repository

Using getGitRepository

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 getGitRepository(args: GetGitRepositoryArgs, opts?: InvokeOptions): Promise<GetGitRepositoryResult>
function getGitRepositoryOutput(args: GetGitRepositoryOutputArgs, opts?: InvokeOptions): Output<GetGitRepositoryResult>
def get_git_repository(name: Optional[str] = None,
                       project_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetGitRepositoryResult
def get_git_repository_output(name: Optional[pulumi.Input[str]] = None,
                       project_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetGitRepositoryResult]
func GetGitRepository(ctx *Context, args *GetGitRepositoryArgs, opts ...InvokeOption) (*GetGitRepositoryResult, error)
func GetGitRepositoryOutput(ctx *Context, args *GetGitRepositoryOutputArgs, opts ...InvokeOption) GetGitRepositoryResultOutput

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

public static class GetGitRepository 
{
    public static Task<GetGitRepositoryResult> InvokeAsync(GetGitRepositoryArgs args, InvokeOptions? opts = null)
    public static Output<GetGitRepositoryResult> Invoke(GetGitRepositoryInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGitRepositoryResult> getGitRepository(GetGitRepositoryArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: azuredevops:index/getGitRepository:getGitRepository
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string

Name of the Git repository to retrieve

ProjectId string

ID of project to list Git repositories

Name string

Name of the Git repository to retrieve

ProjectId string

ID of project to list Git repositories

name String

Name of the Git repository to retrieve

projectId String

ID of project to list Git repositories

name string

Name of the Git repository to retrieve

projectId string

ID of project to list Git repositories

name str

Name of the Git repository to retrieve

project_id str

ID of project to list Git repositories

name String

Name of the Git repository to retrieve

projectId String

ID of project to list Git repositories

getGitRepository Result

The following output properties are available:

DefaultBranch string

The ref of the default branch.

Id string

The provider-assigned unique ID for this managed resource.

IsFork bool
Name string

Git repository name.

ProjectId string

Project identifier to which the Git repository belongs.

RemoteUrl string

HTTPS Url to clone the Git repository

Size int

Compressed size (bytes) of the repository.

SshUrl string

SSH Url to clone the Git repository

Url string

Details REST API endpoint for the Git Repository.

WebUrl string

Url of the Git repository web view

DefaultBranch string

The ref of the default branch.

Id string

The provider-assigned unique ID for this managed resource.

IsFork bool
Name string

Git repository name.

ProjectId string

Project identifier to which the Git repository belongs.

RemoteUrl string

HTTPS Url to clone the Git repository

Size int

Compressed size (bytes) of the repository.

SshUrl string

SSH Url to clone the Git repository

Url string

Details REST API endpoint for the Git Repository.

WebUrl string

Url of the Git repository web view

defaultBranch String

The ref of the default branch.

id String

The provider-assigned unique ID for this managed resource.

isFork Boolean
name String

Git repository name.

projectId String

Project identifier to which the Git repository belongs.

remoteUrl String

HTTPS Url to clone the Git repository

size Integer

Compressed size (bytes) of the repository.

sshUrl String

SSH Url to clone the Git repository

url String

Details REST API endpoint for the Git Repository.

webUrl String

Url of the Git repository web view

defaultBranch string

The ref of the default branch.

id string

The provider-assigned unique ID for this managed resource.

isFork boolean
name string

Git repository name.

projectId string

Project identifier to which the Git repository belongs.

remoteUrl string

HTTPS Url to clone the Git repository

size number

Compressed size (bytes) of the repository.

sshUrl string

SSH Url to clone the Git repository

url string

Details REST API endpoint for the Git Repository.

webUrl string

Url of the Git repository web view

default_branch str

The ref of the default branch.

id str

The provider-assigned unique ID for this managed resource.

is_fork bool
name str

Git repository name.

project_id str

Project identifier to which the Git repository belongs.

remote_url str

HTTPS Url to clone the Git repository

size int

Compressed size (bytes) of the repository.

ssh_url str

SSH Url to clone the Git repository

url str

Details REST API endpoint for the Git Repository.

web_url str

Url of the Git repository web view

defaultBranch String

The ref of the default branch.

id String

The provider-assigned unique ID for this managed resource.

isFork Boolean
name String

Git repository name.

projectId String

Project identifier to which the Git repository belongs.

remoteUrl String

HTTPS Url to clone the Git repository

size Number

Compressed size (bytes) of the repository.

sshUrl String

SSH Url to clone the Git repository

url String

Details REST API endpoint for the Git Repository.

webUrl String

Url of the Git repository web view

Package Details

Repository
https://github.com/pulumi/pulumi-azuredevops
License
Apache-2.0
Notes

This Pulumi package is based on the azuredevops Terraform Provider.