1. Packages
  2. Azuredevops Provider
  3. API Docs
  4. getIdentityGroup
Azure DevOps v3.4.0 published on Wednesday, Oct 30, 2024 by Pulumi

azuredevops.getIdentityGroup

Explore with Pulumi AI

azuredevops logo
Azure DevOps v3.4.0 published on Wednesday, Oct 30, 2024 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",
    });
    
    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")
    
    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
    	})
    }
    
    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",
        });
    
    });
    
    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());
    
        }
    }
    
    variables:
      # load existing group with specific name
      example-project-group:
        fn::invoke:
          Function: azuredevops:getIdentityGroup
          Arguments:
            projectId: ${example.id}
            name: '[Project-Name]\Group-Name'
    

    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>
    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]
    func GetIdentityGroup(ctx *Context, args *GetIdentityGroupArgs, opts ...InvokeOption) (*GetIdentityGroupResult, error)
    func GetIdentityGroupOutput(ctx *Context, args *GetIdentityGroupOutputArgs, opts ...InvokeOption) GetIdentityGroupResultOutput

    > 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)
    }
    public static CompletableFuture<GetIdentityGroupResult> getIdentityGroup(GetIdentityGroupArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azuredevops:index/getIdentityGroup:getIdentityGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the group.
    ProjectId string
    The Project ID.
    Name string
    The name of the group.
    ProjectId string
    The Project ID.
    name String
    The name of the group.
    projectId String
    The Project ID.
    name string
    The name of the group.
    projectId string
    The Project ID.
    name str
    The name of the group.
    project_id str
    The Project ID.
    name String
    The name of the group.
    projectId String
    The Project ID.

    getIdentityGroup Result

    The following output properties are available:

    Descriptor string
    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
    Descriptor string
    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
    descriptor String
    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
    descriptor string
    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
    descriptor str
    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
    descriptor String
    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

    Package Details

    Repository
    Azure DevOps pulumi/pulumi-azuredevops
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azuredevops Terraform Provider.
    azuredevops logo
    Azure DevOps v3.4.0 published on Wednesday, Oct 30, 2024 by Pulumi