1. Docs
  2. Reference
  3. API
  4. @pulumi/azuredevops
  5. Entitlement

Module Entitlement

This page documents the language specification for the azuredevops package. If you're looking for help working with the inputs, outputs, or functions of azuredevops resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Others

Resources

Resource User

class User extends CustomResource

Manages a user entitlement within Azure DevOps.

Example Usage

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

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

PAT Permissions Required

  • Member Entitlement Management: Read & Write

constructor

new User(name: string, args?: UserArgs, opts?: pulumi.CustomResourceOptions)

Create a User resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UserState, opts?: pulumi.CustomResourceOptions): User

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is User

Returns true if the given object is an instance of User. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accountLicenseType

public accountLicenseType: pulumi.Output<string | undefined>;

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.

property descriptor

public descriptor: pulumi.Output<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.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property licensingSource

public licensingSource: pulumi.Output<string | undefined>;

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

property origin

public origin: pulumi.Output<string>;

The type of source provider for the origin identifier.

property originId

public originId: pulumi.Output<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.

property principalName

public principalName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface UserArgs

interface UserArgs

The set of arguments for constructing a User resource.

property accountLicenseType

accountLicenseType?: pulumi.Input<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.

property licensingSource

licensingSource?: pulumi.Input<string>;

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

property origin

origin?: pulumi.Input<string>;

The type of source provider for the origin identifier.

property originId

originId?: pulumi.Input<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.

property principalName

principalName?: pulumi.Input<string>;

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

interface UserState

interface UserState

Input properties used for looking up and filtering User resources.

property accountLicenseType

accountLicenseType?: pulumi.Input<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.

property descriptor

descriptor?: pulumi.Input<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.

property licensingSource

licensingSource?: pulumi.Input<string>;

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

property origin

origin?: pulumi.Input<string>;

The type of source provider for the origin identifier.

property originId

originId?: pulumi.Input<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.

property principalName

principalName?: pulumi.Input<string>;

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