AccountsRestClient class

Package:

azure-devops-extension-api

Base class that should be used (derived from) to make requests to VSS REST apis

Extends

RestClientBase

Constructors

AccountsRestClient(IVssRestClientOptions)

Properties

RESOURCE_AREA_ID

Methods

createAccount(AccountCreateInfoInternal, boolean)
getAccount(string)
getAccounts(string, string, string)	Get a list of accounts for a specific owner or a specific member. One of the following parameters is required: ownerId, memberId.

Constructor Details

AccountsRestClient(IVssRestClientOptions)

new AccountsRestClient(options: IVssRestClientOptions)

Parameters

options

IVssRestClientOptions

Property Details

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Property Value

string

Method Details

createAccount(AccountCreateInfoInternal, boolean)

function createAccount(info: AccountCreateInfoInternal, usePrecreated?: boolean): Promise<Account>

Parameters

info

AccountCreateInfoInternal

usePrecreated

boolean

Returns

Promise<Account>

getAccount(string)

function getAccount(accountId: string): Promise<Account>

Parameters

accountId

string

Returns

Promise<Account>

getAccounts(string, string, string)

Get a list of accounts for a specific owner or a specific member. One of the following parameters is required: ownerId, memberId.

function getAccounts(ownerId?: string, memberId?: string, properties?: string): Promise<Account[]>

Parameters

ownerId

string

ID for the owner of the accounts.

memberId

string

ID for a member of the accounts.

properties

string

Returns

Promise<Account[]>