1. Packages
  2. Azure DevOps Provider
  3. API Docs
  4. getIdentityGroup
Azure DevOps v3.8.0 published on Monday, Mar 17, 2025 by Pulumi

azuredevops.getIdentityGroup

Explore with Pulumi AI

Azure DevOps v3.8.0 published on Monday, Mar 17, 2025 by Pulumi

Use this data source to access information about an existing Group within Azure DevOps On-Premise(Azure DevOps Server).

Example Usage

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

// load existing group with specific name
const example_project_group = azuredevops.getIdentityGroup({
    projectId: example.id,
    name: "[Project-Name]\\Group-Name",
});
Copy
import pulumi
import pulumi_azuredevops as azuredevops

# load existing group with specific name
example_project_group = azuredevops.get_identity_group(project_id=example["id"],
    name="[Project-Name]\\Group-Name")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// load existing group with specific name
		_, err := azuredevops.GetIdentityGroup(ctx, &azuredevops.GetIdentityGroupArgs{
			ProjectId: example.Id,
			Name:      "[Project-Name]\\Group-Name",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;

return await Deployment.RunAsync(() => 
{
    // load existing group with specific name
    var example_project_group = AzureDevOps.GetIdentityGroup.Invoke(new()
    {
        ProjectId = example.Id,
        Name = "[Project-Name]\\Group-Name",
    });

});
Copy
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.inputs.GetIdentityGroupArgs;
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) {
        // load existing group with specific name
        final var example-project-group = AzuredevopsFunctions.getIdentityGroup(GetIdentityGroupArgs.builder()
            .projectId(example.id())
            .name("[Project-Name]\\Group-Name")
            .build());

    }
}
Copy
variables:
  # load existing group with specific name
  example-project-group:
    fn::invoke:
      function: azuredevops:getIdentityGroup
      arguments:
        projectId: ${example.id}
        name: '[Project-Name]\Group-Name'
Copy

Using getIdentityGroup

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 getIdentityGroup(args: GetIdentityGroupArgs, opts?: InvokeOptions): Promise<GetIdentityGroupResult>
function getIdentityGroupOutput(args: GetIdentityGroupOutputArgs, opts?: InvokeOptions): Output<GetIdentityGroupResult>
Copy
def get_identity_group(name: Optional[str] = None,
                       project_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetIdentityGroupResult
def get_identity_group_output(name: Optional[pulumi.Input[str]] = None,
                       project_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetIdentityGroupResult]
Copy
func GetIdentityGroup(ctx *Context, args *GetIdentityGroupArgs, opts ...InvokeOption) (*GetIdentityGroupResult, error)
func GetIdentityGroupOutput(ctx *Context, args *GetIdentityGroupOutputArgs, opts ...InvokeOption) GetIdentityGroupResultOutput
Copy

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

public static class GetIdentityGroup 
{
    public static Task<GetIdentityGroupResult> InvokeAsync(GetIdentityGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetIdentityGroupResult> Invoke(GetIdentityGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIdentityGroupResult> getIdentityGroup(GetIdentityGroupArgs args, InvokeOptions options)
public static Output<GetIdentityGroupResult> getIdentityGroup(GetIdentityGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azuredevops:index/getIdentityGroup:getIdentityGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The name of the group.
ProjectId This property is required. string
The Project ID.
Name This property is required. string
The name of the group.
ProjectId This property is required. string
The Project ID.
name This property is required. String
The name of the group.
projectId This property is required. String
The Project ID.
name This property is required. string
The name of the group.
projectId This property is required. string
The Project ID.
name This property is required. str
The name of the group.
project_id This property is required. str
The Project ID.
name This property is required. String
The name of the group.
projectId This property is required. String
The Project ID.

getIdentityGroup Result

The following output properties are available:

Descriptor string
The descriptor of the identity group.
Id string
The provider-assigned unique ID for this managed resource.
Name string
This is the non-unique display name of the identity subject. To change this field, you must alter its value in the source provider.
ProjectId string
SubjectDescriptor string
The subject descriptor of the identity group.
Descriptor string
The descriptor of the identity group.
Id string
The provider-assigned unique ID for this managed resource.
Name string
This is the non-unique display name of the identity subject. To change this field, you must alter its value in the source provider.
ProjectId string
SubjectDescriptor string
The subject descriptor of the identity group.
descriptor String
The descriptor of the identity group.
id String
The provider-assigned unique ID for this managed resource.
name String
This is the non-unique display name of the identity subject. To change this field, you must alter its value in the source provider.
projectId String
subjectDescriptor String
The subject descriptor of the identity group.
descriptor string
The descriptor of the identity group.
id string
The provider-assigned unique ID for this managed resource.
name string
This is the non-unique display name of the identity subject. To change this field, you must alter its value in the source provider.
projectId string
subjectDescriptor string
The subject descriptor of the identity group.
descriptor str
The descriptor of the identity group.
id str
The provider-assigned unique ID for this managed resource.
name str
This is the non-unique display name of the identity subject. To change this field, you must alter its value in the source provider.
project_id str
subject_descriptor str
The subject descriptor of the identity group.
descriptor String
The descriptor of the identity group.
id String
The provider-assigned unique ID for this managed resource.
name String
This is the non-unique display name of the identity subject. To change this field, you must alter its value in the source provider.
projectId String
subjectDescriptor String
The subject descriptor of the identity group.

Package Details

Repository
Azure DevOps pulumi/pulumi-azuredevops
License
Apache-2.0
Notes
This Pulumi package is based on the azuredevops Terraform Provider.
Azure DevOps v3.8.0 published on Monday, Mar 17, 2025 by Pulumi