Class WebApi

Constructors

constructor

new WebApi(
    defaultUrl: string,
    authHandler: IRequestHandler,
    options?: IRequestOptions,
    requestSettings?: IWebApiRequestSettings,
): WebApi
Parameters
- defaultUrl: string
- authHandler: IRequestHandler
- Optionaloptions: IRequestOptions
- OptionalrequestSettings: IWebApiRequestSettings
Returns WebApi
- Defined in repos/azure-devops-node-api/api/WebApi.ts:106

Properties

authHandler

authHandler: IRequestHandler

isNoProxyHost

isNoProxyHost: (_url: string) => boolean = ...

Determines if the domain is exluded for proxy via the no_proxy env var

options

options: IRequestOptions

rest

rest: RestClient

serverUrl

serverUrl: string

vsoClient

vsoClient: VsoClient

Methods

connect

connect(): Promise<ConnectionData>
Returns Promise<ConnectionData>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:184

getAlertApi

getAlertApi(
serverUrl?: string,
handlers?: IRequestHandler[],
): Promise<IAlertApi>
Each factory method can take a serverUrl and a list of handlers if these aren't provided, the default url and auth handler given to the constructor for this class will be used
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<IAlertApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:202

getBuildApi

getBuildApi(
serverUrl?: string,
handlers?: IRequestHandler[],
): Promise<IBuildApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<IBuildApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:208

getCixApi

getCixApi(serverUrl?: string, handlers?: IRequestHandler[]): Promise<ICixApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<ICixApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:402

getCoreApi

getCoreApi(serverUrl?: string, handlers?: IRequestHandler[]): Promise<ICoreApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<ICoreApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:214

getDashboardApi

getDashboardApi(
serverUrl?: string,
handlers?: IRequestHandler[],
): Promise<IDashboardApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<IDashboardApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:221

getExtensionManagementApi

getExtensionManagementApi(
serverUrl?: string,
handlers?: IRequestHandler[],
): Promise<IExtensionManagementApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<IExtensionManagementApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:228

getFeatureManagementApi

getFeatureManagementApi(
serverUrl?: string,
handlers?: IRequestHandler[],
): Promise<IFeatureManagementApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<IFeatureManagementApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:235

getFileContainerApi

getFileContainerApi(
serverUrl?: string,
handlers?: IRequestHandler[],
): Promise<IFileContainerApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<IFileContainerApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:242

getGalleryApi

getGalleryApi(
serverUrl?: string,
handlers?: IRequestHandler[],
): Promise<IGalleryApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<IGalleryApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:249

getGitApi

getGitApi(serverUrl?: string, handlers?: IRequestHandler[]): Promise<IGitApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<IGitApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:255

getLocationsApi

getLocationsApi(
serverUrl?: string,
handlers?: IRequestHandler[],
): Promise<ILocationsApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<ILocationsApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:262

getManagementApi

getManagementApi(
serverUrl?: string,
handlers?: IRequestHandler[],
): Promise<IManagementApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<IManagementApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:271

getNotificationApi

getNotificationApi(
serverUrl?: string,
handlers?: IRequestHandler[],
): Promise<INotificationApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<INotificationApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:277

getPipelinesApi

getPipelinesApi(
serverUrl?: string,
handlers?: IRequestHandler[],
): Promise<IPipelinesApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<IPipelinesApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:395

getPolicyApi

getPolicyApi(
serverUrl?: string,
handlers?: IRequestHandler[],
): Promise<IPolicyApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<IPolicyApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:284

getProfileApi

getProfileApi(
serverUrl?: string,
handlers?: IRequestHandler[],
): Promise<IProfileApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<IProfileApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:291

getProjectAnalysisApi

getProjectAnalysisApi(
serverUrl?: string,
handlers?: IRequestHandler[],
): Promise<IProjectAnalysisApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<IProjectAnalysisApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:298

getReleaseApi

getReleaseApi(
serverUrl?: string,
handlers?: IRequestHandler[],
): Promise<IReleaseApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<IReleaseApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:312

getSecurityRolesApi

getSecurityRolesApi(
serverUrl?: string,
handlers?: IRequestHandler[],
): Promise<ISecurityRolesApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<ISecurityRolesApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:305

getTaskAgentApi

getTaskAgentApi(
serverUrl?: string,
handlers?: IRequestHandler[],
): Promise<ITaskAgentApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<ITaskAgentApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:326

getTaskApi

getTaskApi(serverUrl?: string, handlers?: IRequestHandler[]): Promise<ITaskApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<ITaskApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:319

getTestApi

getTestApi(serverUrl?: string, handlers?: IRequestHandler[]): Promise<ITestApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<ITestApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:333

getTestPlanApi

getTestPlanApi(
serverUrl?: string,
handlers?: IRequestHandler[],
): Promise<ITestPlanApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<ITestPlanApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:340

getTestResultsApi

getTestResultsApi(
serverUrl?: string,
handlers?: IRequestHandler[],
): Promise<ITestResultsApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<ITestResultsApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:347

getTfvcApi

getTfvcApi(serverUrl?: string, handlers?: IRequestHandler[]): Promise<ITfvcApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<ITfvcApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:354

getWikiApi

getWikiApi(serverUrl?: string, handlers?: IRequestHandler[]): Promise<IWikiApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<IWikiApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:361

getWorkApi

getWorkApi(serverUrl?: string, handlers?: IRequestHandler[]): Promise<IWorkApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<IWorkApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:368

getWorkItemTrackingApi

getWorkItemTrackingApi(
serverUrl?: string,
handlers?: IRequestHandler[],
): Promise<IWorkItemTrackingApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<IWorkItemTrackingApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:375

getWorkItemTrackingProcessApi

getWorkItemTrackingProcessApi(
serverUrl?: string,
handlers?: IRequestHandler[],
): Promise<IWorkItemTrackingProcessApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<IWorkItemTrackingProcessApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:381

getWorkItemTrackingProcessDefinitionApi

getWorkItemTrackingProcessDefinitionApi(
serverUrl?: string,
handlers?: IRequestHandler[],
): Promise<IWorkItemTrackingProcessDefinitionsApi>
Parameters
- OptionalserverUrl: string
- Optionalhandlers: IRequestHandler[]
Returns Promise<IWorkItemTrackingProcessDefinitionsApi>
- Defined in repos/azure-devops-node-api/api/WebApi.ts:388

`Static`createWithBearerToken

createWithBearerToken(
    defaultUrl: string,
    token: string,
    options?: IRequestOptions,
): WebApi
Convenience factory to create with a bearer token.
Parameters
- defaultUrl: string
- token: string
- Optionaloptions: IRequestOptions
Returns WebApi
- Defined in repos/azure-devops-node-api/api/WebApi.ts:179