AzureDevOps

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

getGroups

Use this data source to access information about existing Groups within Azure DevOps

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_all_groups = Output.Create(AzureDevOps.GetGroups.InvokeAsync());
        var example_project_groups = example.Apply(example => Output.Create(AzureDevOps.GetGroups.InvokeAsync(new AzureDevOps.GetGroupsArgs
        {
            ProjectId = example.Id,
        })));
    }

}
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.GetGroups(ctx, nil, nil)
		if err != nil {
			return err
		}
		_, err = azuredevops.GetGroups(ctx, &GetGroupsArgs{
			ProjectId: pulumi.StringRef(example.Id),
		}, 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.GetGroupsArgs;
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-all-groups = AzuredevopsFunctions.getGroups();

        final var example-project-groups = AzuredevopsFunctions.getGroups(GetGroupsArgs.builder()
            .projectId(example.applyValue(getProjectResult -> getProjectResult.id()))
            .build());

    }
}
import pulumi
import pulumi_azuredevops as azuredevops

example = azuredevops.get_project(name="Example Project")
example_all_groups = azuredevops.get_groups()
example_project_groups = azuredevops.get_groups(project_id=example.id)
import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";

const example = azuredevops.getProject({
    name: "Example Project",
});
const example-all-groups = azuredevops.getGroups({});
const example-project-groups = example.then(example => azuredevops.getGroups({
    projectId: example.id,
}));
variables:
  example:
    Fn::Invoke:
      Function: azuredevops:getProject
      Arguments:
        name: Example Project
  example-all-groups:
    Fn::Invoke:
      Function: azuredevops:getGroups
      Arguments: {}
  example-project-groups:
    Fn::Invoke:
      Function: azuredevops:getGroups
      Arguments:
        projectId: ${example.id}

Using getGroups

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 getGroups(args: GetGroupsArgs, opts?: InvokeOptions): Promise<GetGroupsResult>
function getGroupsOutput(args: GetGroupsOutputArgs, opts?: InvokeOptions): Output<GetGroupsResult>
def get_groups(project_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetGroupsResult
def get_groups_output(project_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetGroupsResult]
func GetGroups(ctx *Context, args *GetGroupsArgs, opts ...InvokeOption) (*GetGroupsResult, error)
func GetGroupsOutput(ctx *Context, args *GetGroupsOutputArgs, opts ...InvokeOption) GetGroupsResultOutput

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

public static class GetGroups 
{
    public static Task<GetGroupsResult> InvokeAsync(GetGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupsResult> Invoke(GetGroupsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azuredevops:index/getGroups:getGroups
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ProjectId string

The Project ID. If no project ID is specified all groups of an organization will be returned

ProjectId string

The Project ID. If no project ID is specified all groups of an organization will be returned

projectId String

The Project ID. If no project ID is specified all groups of an organization will be returned

projectId string

The Project ID. If no project ID is specified all groups of an organization will be returned

project_id str

The Project ID. If no project ID is specified all groups of an organization will be returned

projectId String

The Project ID. If no project ID is specified all groups of an organization will be returned

getGroups Result

The following output properties are available:

Groups List<Pulumi.AzureDevOps.Outputs.GetGroupsGroup>

A set of existing groups in your Azure DevOps Organization or project with details about every single group which includes:

Id string

The provider-assigned unique ID for this managed resource.

ProjectId string
Groups []GetGroupsGroup

A set of existing groups in your Azure DevOps Organization or project with details about every single group which includes:

Id string

The provider-assigned unique ID for this managed resource.

ProjectId string
groups List<GetGroupsGroup>

A set of existing groups in your Azure DevOps Organization or project with details about every single group which includes:

id String

The provider-assigned unique ID for this managed resource.

projectId String
groups GetGroupsGroup[]

A set of existing groups in your Azure DevOps Organization or project with details about every single group which includes:

id string

The provider-assigned unique ID for this managed resource.

projectId string
groups Sequence[GetGroupsGroup]

A set of existing groups in your Azure DevOps Organization or project with details about every single group which includes:

id str

The provider-assigned unique ID for this managed resource.

project_id str
groups List<Property Map>

A set of existing groups in your Azure DevOps Organization or project with details about every single group which includes:

id String

The provider-assigned unique ID for this managed resource.

projectId String

Supporting Types

GetGroupsGroup

Descriptor string

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.

Domain string

This represents the name of the container of origin for a graph member. (For MSA this is "Windows Live ID", for AD the name of the domain, for AAD the tenantID of the directory, for VSTS groups the ScopeId, etc)

Origin string

The type of source provider for the origin identifier (ex:AD, AAD, MSA)

PrincipalName string

This is the PrincipalName of this graph member from the source provider. The source provider may change this field over time and it is not guaranteed to be immutable for the life of the graph member by VSTS.

Url string

This url is the full route to the source resource of this graph subject.

Description string

A short phrase to help human readers disambiguate groups with similar names

DisplayName string

This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.

MailAddress string

The email address of record for a given graph member. This may be different than the principal name.

OriginId string

The unique identifier from the system of origin. Typically a sid, object id or Guid. Linking and unlinking operations can cause this value to change for a user because the user is not backed by a different provider and has a different unique id in the new provider.

Descriptor string

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.

Domain string

This represents the name of the container of origin for a graph member. (For MSA this is "Windows Live ID", for AD the name of the domain, for AAD the tenantID of the directory, for VSTS groups the ScopeId, etc)

Origin string

The type of source provider for the origin identifier (ex:AD, AAD, MSA)

PrincipalName string

This is the PrincipalName of this graph member from the source provider. The source provider may change this field over time and it is not guaranteed to be immutable for the life of the graph member by VSTS.

Url string

This url is the full route to the source resource of this graph subject.

Description string

A short phrase to help human readers disambiguate groups with similar names

DisplayName string

This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.

MailAddress string

The email address of record for a given graph member. This may be different than the principal name.

OriginId string

The unique identifier from the system of origin. Typically a sid, object id or Guid. Linking and unlinking operations can cause this value to change for a user because the user is not backed by a different provider and has a different unique id in the new provider.

descriptor String

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.

domain String

This represents the name of the container of origin for a graph member. (For MSA this is "Windows Live ID", for AD the name of the domain, for AAD the tenantID of the directory, for VSTS groups the ScopeId, etc)

origin String

The type of source provider for the origin identifier (ex:AD, AAD, MSA)

principalName String

This is the PrincipalName of this graph member from the source provider. The source provider may change this field over time and it is not guaranteed to be immutable for the life of the graph member by VSTS.

url String

This url is the full route to the source resource of this graph subject.

description String

A short phrase to help human readers disambiguate groups with similar names

displayName String

This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.

mailAddress String

The email address of record for a given graph member. This may be different than the principal name.

originId String

The unique identifier from the system of origin. Typically a sid, object id or Guid. Linking and unlinking operations can cause this value to change for a user because the user is not backed by a different provider and has a different unique id in the new provider.

descriptor string

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.

domain string

This represents the name of the container of origin for a graph member. (For MSA this is "Windows Live ID", for AD the name of the domain, for AAD the tenantID of the directory, for VSTS groups the ScopeId, etc)

origin string

The type of source provider for the origin identifier (ex:AD, AAD, MSA)

principalName string

This is the PrincipalName of this graph member from the source provider. The source provider may change this field over time and it is not guaranteed to be immutable for the life of the graph member by VSTS.

url string

This url is the full route to the source resource of this graph subject.

description string

A short phrase to help human readers disambiguate groups with similar names

displayName string

This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.

mailAddress string

The email address of record for a given graph member. This may be different than the principal name.

originId string

The unique identifier from the system of origin. Typically a sid, object id or Guid. Linking and unlinking operations can cause this value to change for a user because the user is not backed by a different provider and has a different unique id in the new provider.

descriptor str

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.

domain str

This represents the name of the container of origin for a graph member. (For MSA this is "Windows Live ID", for AD the name of the domain, for AAD the tenantID of the directory, for VSTS groups the ScopeId, etc)

origin str

The type of source provider for the origin identifier (ex:AD, AAD, MSA)

principal_name str

This is the PrincipalName of this graph member from the source provider. The source provider may change this field over time and it is not guaranteed to be immutable for the life of the graph member by VSTS.

url str

This url is the full route to the source resource of this graph subject.

description str

A short phrase to help human readers disambiguate groups with similar names

display_name str

This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.

mail_address str

The email address of record for a given graph member. This may be different than the principal name.

origin_id str

The unique identifier from the system of origin. Typically a sid, object id or Guid. Linking and unlinking operations can cause this value to change for a user because the user is not backed by a different provider and has a different unique id in the new provider.

descriptor String

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.

domain String

This represents the name of the container of origin for a graph member. (For MSA this is "Windows Live ID", for AD the name of the domain, for AAD the tenantID of the directory, for VSTS groups the ScopeId, etc)

origin String

The type of source provider for the origin identifier (ex:AD, AAD, MSA)

principalName String

This is the PrincipalName of this graph member from the source provider. The source provider may change this field over time and it is not guaranteed to be immutable for the life of the graph member by VSTS.

url String

This url is the full route to the source resource of this graph subject.

description String

A short phrase to help human readers disambiguate groups with similar names

displayName String

This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.

mailAddress String

The email address of record for a given graph member. This may be different than the principal name.

originId String

The unique identifier from the system of origin. Typically a sid, object id or Guid. Linking and unlinking operations can cause this value to change for a user because the user is not backed by a different provider and has a different unique id in the new provider.

Package Details

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

This Pulumi package is based on the azuredevops Terraform Provider.