Docs Packages
  1. Pulumi Registry
  2. AzureDevOps
  3. API Docs
  4. User
azuredevops logo
Azure DevOps v2.7.0, Mar 27 23

azuredevops.User

Explore with Pulumi AI

Manages a user entitlement within Azure DevOps.

PAT Permissions Required

  • Member Entitlement Management: Read & Write

Example Usage

using System.Collections.Generic;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;

return await Deployment.RunAsync(() => 
{
    var example = new AzureDevOps.User("example", new()
    {
        PrincipalName = "foo@contoso.com",
    });

});

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 {
		_, err := azuredevops.NewUser(ctx, "example", &azuredevops.UserArgs{
			PrincipalName: pulumi.String("foo@contoso.com"),
		})
		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.User;
import com.pulumi.azuredevops.UserArgs;
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) {
        var example = new User("example", UserArgs.builder()        
            .principalName("foo@contoso.com")
            .build());

    }
}

import pulumi
import pulumi_azuredevops as azuredevops

example = azuredevops.User("example", principal_name="foo@contoso.com")

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

const example = new azuredevops.User("example", {principalName: "foo@contoso.com"});

resources:
  example:
    type: azuredevops:User
    properties:
      principalName: foo@contoso.com

Create User Resource

new User(name: string, args?: UserArgs, opts?: CustomResourceOptions);
@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         account_license_type: Optional[str] = None,
         licensing_source: Optional[str] = None,
         origin: Optional[str] = None,
         origin_id: Optional[str] = None,
         principal_name: Optional[str] = None)
@overload
def User(resource_name: str,
         args: Optional[UserArgs] = None,
         opts: Optional[ResourceOptions] = None)
func NewUser(ctx *Context, name string, args *UserArgs, opts ...ResourceOption) (*User, error)
public User(string name, UserArgs? args = null, CustomResourceOptions? opts = null)
public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

type: azuredevops:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args UserArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args UserArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args UserArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

User Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The User resource accepts the following input properties:

AccountLicenseType string

Type of Account License. Valid values: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.

LicensingSource string

The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

Origin string

The type of source provider for the origin identifier.

OriginId string

The unique identifier from the system of origin. Typically a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.

PrincipalName string

The principal name is the PrincipalName of a graph member from the source provider. Usually, e-mail address.

AccountLicenseType string

Type of Account License. Valid values: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.

LicensingSource string

The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

Origin string

The type of source provider for the origin identifier.

OriginId string

The unique identifier from the system of origin. Typically a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.

PrincipalName string

The principal name is the PrincipalName of a graph member from the source provider. Usually, e-mail address.

accountLicenseType String

Type of Account License. Valid values: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.

licensingSource String

The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

origin String

The type of source provider for the origin identifier.

originId String

The unique identifier from the system of origin. Typically a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.

principalName String

The principal name is the PrincipalName of a graph member from the source provider. Usually, e-mail address.

accountLicenseType string

Type of Account License. Valid values: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.

licensingSource string

The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

origin string

The type of source provider for the origin identifier.

originId string

The unique identifier from the system of origin. Typically a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.

principalName string

The principal name is the PrincipalName of a graph member from the source provider. Usually, e-mail address.

account_license_type str

Type of Account License. Valid values: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.

licensing_source str

The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

origin str

The type of source provider for the origin identifier.

origin_id str

The unique identifier from the system of origin. Typically a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.

principal_name str

The principal name is the PrincipalName of a graph member from the source provider. Usually, e-mail address.

accountLicenseType String

Type of Account License. Valid values: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.

licensingSource String

The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

origin String

The type of source provider for the origin identifier.

originId String

The unique identifier from the system of origin. Typically a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.

principalName String

The principal name is the PrincipalName of a graph member from the source provider. Usually, e-mail address.

Outputs

All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:

Descriptor string

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.

Id string

The provider-assigned unique ID for this managed resource.

Descriptor string

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.

Id string

The provider-assigned unique ID for this managed resource.

descriptor String

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.

id String

The provider-assigned unique ID for this managed resource.

descriptor string

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.

id string

The provider-assigned unique ID for this managed resource.

descriptor str

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.

id str

The provider-assigned unique ID for this managed resource.

descriptor String

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing User Resource

Get an existing User resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: UserState, opts?: CustomResourceOptions): User
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_license_type: Optional[str] = None,
        descriptor: Optional[str] = None,
        licensing_source: Optional[str] = None,
        origin: Optional[str] = None,
        origin_id: Optional[str] = None,
        principal_name: Optional[str] = None) -> User
func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AccountLicenseType string

Type of Account License. Valid values: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.

Descriptor string

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.

LicensingSource string

The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

Origin string

The type of source provider for the origin identifier.

OriginId string

The unique identifier from the system of origin. Typically a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.

PrincipalName string

The principal name is the PrincipalName of a graph member from the source provider. Usually, e-mail address.

AccountLicenseType string

Type of Account License. Valid values: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.

Descriptor string

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.

LicensingSource string

The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

Origin string

The type of source provider for the origin identifier.

OriginId string

The unique identifier from the system of origin. Typically a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.

PrincipalName string

The principal name is the PrincipalName of a graph member from the source provider. Usually, e-mail address.

accountLicenseType String

Type of Account License. Valid values: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.

descriptor String

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.

licensingSource String

The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

origin String

The type of source provider for the origin identifier.

originId String

The unique identifier from the system of origin. Typically a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.

principalName String

The principal name is the PrincipalName of a graph member from the source provider. Usually, e-mail address.

accountLicenseType string

Type of Account License. Valid values: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.

descriptor string

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.

licensingSource string

The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

origin string

The type of source provider for the origin identifier.

originId string

The unique identifier from the system of origin. Typically a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.

principalName string

The principal name is the PrincipalName of a graph member from the source provider. Usually, e-mail address.

account_license_type str

Type of Account License. Valid values: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.

descriptor str

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.

licensing_source str

The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

origin str

The type of source provider for the origin identifier.

origin_id str

The unique identifier from the system of origin. Typically a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.

principal_name str

The principal name is the PrincipalName of a graph member from the source provider. Usually, e-mail address.

accountLicenseType String

Type of Account License. Valid values: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.

descriptor String

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.

licensingSource String

The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

origin String

The type of source provider for the origin identifier.

originId String

The unique identifier from the system of origin. Typically a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.

principalName String

The principal name is the PrincipalName of a graph member from the source provider. Usually, e-mail address.

Import

The resources allows the import via the UUID of a user entitlement or by using the principal name of a user owning an entitlement.

Package Details

Repository
Azure DevOps pulumi/pulumi-azuredevops
License
Apache-2.0
Notes

This Pulumi package is based on the azuredevops Terraform Provider.