1. Packages
  2. Azuredevops Provider
  3. API Docs
  4. getUsers
Azure DevOps v3.3.0 published on Wednesday, Sep 4, 2024 by Pulumi

azuredevops.getUsers

Explore with Pulumi AI

azuredevops logo
Azure DevOps v3.3.0 published on Wednesday, Sep 4, 2024 by Pulumi

    Use this data source to access information about an existing users within Azure DevOps.

    Using getUsers

    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 getUsers(args: GetUsersArgs, opts?: InvokeOptions): Promise<GetUsersResult>
    function getUsersOutput(args: GetUsersOutputArgs, opts?: InvokeOptions): Output<GetUsersResult>
    def get_users(features: Optional[GetUsersFeatures] = None,
                  origin: Optional[str] = None,
                  origin_id: Optional[str] = None,
                  principal_name: Optional[str] = None,
                  subject_types: Optional[Sequence[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> GetUsersResult
    def get_users_output(features: Optional[pulumi.Input[GetUsersFeaturesArgs]] = None,
                  origin: Optional[pulumi.Input[str]] = None,
                  origin_id: Optional[pulumi.Input[str]] = None,
                  principal_name: Optional[pulumi.Input[str]] = None,
                  subject_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetUsersResult]
    func GetUsers(ctx *Context, args *GetUsersArgs, opts ...InvokeOption) (*GetUsersResult, error)
    func GetUsersOutput(ctx *Context, args *GetUsersOutputArgs, opts ...InvokeOption) GetUsersResultOutput

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

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

    The following arguments are supported:

    Features Pulumi.AzureDevOps.Inputs.GetUsersFeatures

    A features block as defined below.

    DataSource without specifying any arguments will return all users inside an organization.

    List of possible subject types

    Origin string
    The type of source provider for the origin_id parameter (ex:AD, AAD, MSA) The supported origins are listed below.
    OriginId string
    The unique identifier from the system of origin.
    PrincipalName string
    The PrincipalName of this graph member from the source provider.
    SubjectTypes List<string>
    A list of user subject subtypes to reduce the retrieved results, e.g. msa, aad, svc (service identity), imp (imported identity), etc. The supported subject types are listed below.
    Features GetUsersFeatures

    A features block as defined below.

    DataSource without specifying any arguments will return all users inside an organization.

    List of possible subject types

    Origin string
    The type of source provider for the origin_id parameter (ex:AD, AAD, MSA) The supported origins are listed below.
    OriginId string
    The unique identifier from the system of origin.
    PrincipalName string
    The PrincipalName of this graph member from the source provider.
    SubjectTypes []string
    A list of user subject subtypes to reduce the retrieved results, e.g. msa, aad, svc (service identity), imp (imported identity), etc. The supported subject types are listed below.
    features GetUsersFeatures

    A features block as defined below.

    DataSource without specifying any arguments will return all users inside an organization.

    List of possible subject types

    origin String
    The type of source provider for the origin_id parameter (ex:AD, AAD, MSA) The supported origins are listed below.
    originId String
    The unique identifier from the system of origin.
    principalName String
    The PrincipalName of this graph member from the source provider.
    subjectTypes List<String>
    A list of user subject subtypes to reduce the retrieved results, e.g. msa, aad, svc (service identity), imp (imported identity), etc. The supported subject types are listed below.
    features GetUsersFeatures

    A features block as defined below.

    DataSource without specifying any arguments will return all users inside an organization.

    List of possible subject types

    origin string
    The type of source provider for the origin_id parameter (ex:AD, AAD, MSA) The supported origins are listed below.
    originId string
    The unique identifier from the system of origin.
    principalName string
    The PrincipalName of this graph member from the source provider.
    subjectTypes string[]
    A list of user subject subtypes to reduce the retrieved results, e.g. msa, aad, svc (service identity), imp (imported identity), etc. The supported subject types are listed below.
    features GetUsersFeatures

    A features block as defined below.

    DataSource without specifying any arguments will return all users inside an organization.

    List of possible subject types

    origin str
    The type of source provider for the origin_id parameter (ex:AD, AAD, MSA) The supported origins are listed below.
    origin_id str
    The unique identifier from the system of origin.
    principal_name str
    The PrincipalName of this graph member from the source provider.
    subject_types Sequence[str]
    A list of user subject subtypes to reduce the retrieved results, e.g. msa, aad, svc (service identity), imp (imported identity), etc. The supported subject types are listed below.
    features Property Map

    A features block as defined below.

    DataSource without specifying any arguments will return all users inside an organization.

    List of possible subject types

    origin String
    The type of source provider for the origin_id parameter (ex:AD, AAD, MSA) The supported origins are listed below.
    originId String
    The unique identifier from the system of origin.
    principalName String
    The PrincipalName of this graph member from the source provider.
    subjectTypes List<String>
    A list of user subject subtypes to reduce the retrieved results, e.g. msa, aad, svc (service identity), imp (imported identity), etc. The supported subject types are listed below.

    getUsers Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Users List<Pulumi.AzureDevOps.Outputs.GetUsersUser>
    A set of existing users in your Azure DevOps Organization with details about every single user which includes:
    Features Pulumi.AzureDevOps.Outputs.GetUsersFeatures
    Origin string
    The type of source provider for the origin identifier (ex:AD, AAD, MSA)
    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.
    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.
    SubjectTypes List<string>
    Id string
    The provider-assigned unique ID for this managed resource.
    Users []GetUsersUser
    A set of existing users in your Azure DevOps Organization with details about every single user which includes:
    Features GetUsersFeatures
    Origin string
    The type of source provider for the origin identifier (ex:AD, AAD, MSA)
    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.
    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.
    SubjectTypes []string
    id String
    The provider-assigned unique ID for this managed resource.
    users List<GetUsersUser>
    A set of existing users in your Azure DevOps Organization with details about every single user which includes:
    features GetUsersFeatures
    origin String
    The type of source provider for the origin identifier (ex:AD, AAD, MSA)
    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.
    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.
    subjectTypes List<String>
    id string
    The provider-assigned unique ID for this managed resource.
    users GetUsersUser[]
    A set of existing users in your Azure DevOps Organization with details about every single user which includes:
    features GetUsersFeatures
    origin string
    The type of source provider for the origin identifier (ex:AD, AAD, MSA)
    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.
    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.
    subjectTypes string[]
    id str
    The provider-assigned unique ID for this managed resource.
    users Sequence[GetUsersUser]
    A set of existing users in your Azure DevOps Organization with details about every single user which includes:
    features GetUsersFeatures
    origin str
    The type of source provider for the origin identifier (ex:AD, AAD, MSA)
    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.
    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.
    subject_types Sequence[str]
    id String
    The provider-assigned unique ID for this managed resource.
    users List<Property Map>
    A set of existing users in your Azure DevOps Organization with details about every single user which includes:
    features Property Map
    origin String
    The type of source provider for the origin identifier (ex:AD, AAD, MSA)
    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.
    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.
    subjectTypes List<String>

    Supporting Types

    GetUsersFeatures

    ConcurrentWorkers int

    Number of workers to process user data concurrently.

    Note Setting concurrent_workers to a value greater than 1 can greatly decrease the time it takes to read the data source.

    ConcurrentWorkers int

    Number of workers to process user data concurrently.

    Note Setting concurrent_workers to a value greater than 1 can greatly decrease the time it takes to read the data source.

    concurrentWorkers Integer

    Number of workers to process user data concurrently.

    Note Setting concurrent_workers to a value greater than 1 can greatly decrease the time it takes to read the data source.

    concurrentWorkers number

    Number of workers to process user data concurrently.

    Note Setting concurrent_workers to a value greater than 1 can greatly decrease the time it takes to read the data source.

    concurrent_workers int

    Number of workers to process user data concurrently.

    Note Setting concurrent_workers to a value greater than 1 can greatly decrease the time it takes to read the data source.

    concurrentWorkers Number

    Number of workers to process user data concurrently.

    Note Setting concurrent_workers to a value greater than 1 can greatly decrease the time it takes to read the data source.

    GetUsersUser

    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.
    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.
    Id string
    The user ID.
    MailAddress string
    The email address of record for a given graph member. This may be different than the principal name.
    Origin string
    The type of source provider for the origin_id parameter (ex:AD, AAD, MSA) The supported origins are listed below.
    PrincipalName string
    The PrincipalName of this graph member from the source provider.
    OriginId string
    The unique identifier from the system of origin.
    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.
    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.
    Id string
    The user ID.
    MailAddress string
    The email address of record for a given graph member. This may be different than the principal name.
    Origin string
    The type of source provider for the origin_id parameter (ex:AD, AAD, MSA) The supported origins are listed below.
    PrincipalName string
    The PrincipalName of this graph member from the source provider.
    OriginId string
    The unique identifier from the system of origin.
    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.
    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.
    id String
    The user ID.
    mailAddress String
    The email address of record for a given graph member. This may be different than the principal name.
    origin String
    The type of source provider for the origin_id parameter (ex:AD, AAD, MSA) The supported origins are listed below.
    principalName String
    The PrincipalName of this graph member from the source provider.
    originId String
    The unique identifier from the system of origin.
    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.
    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.
    id string
    The user ID.
    mailAddress string
    The email address of record for a given graph member. This may be different than the principal name.
    origin string
    The type of source provider for the origin_id parameter (ex:AD, AAD, MSA) The supported origins are listed below.
    principalName string
    The PrincipalName of this graph member from the source provider.
    originId string
    The unique identifier from the system of origin.
    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.
    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.
    id str
    The user ID.
    mail_address str
    The email address of record for a given graph member. This may be different than the principal name.
    origin str
    The type of source provider for the origin_id parameter (ex:AD, AAD, MSA) The supported origins are listed below.
    principal_name str
    The PrincipalName of this graph member from the source provider.
    origin_id str
    The unique identifier from the system of origin.
    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.
    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.
    id String
    The user ID.
    mailAddress String
    The email address of record for a given graph member. This may be different than the principal name.
    origin String
    The type of source provider for the origin_id parameter (ex:AD, AAD, MSA) The supported origins are listed below.
    principalName String
    The PrincipalName of this graph member from the source provider.
    originId String
    The unique identifier from the system of origin.

    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.3.0 published on Wednesday, Sep 4, 2024 by Pulumi