Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProjectsApi

Hierarchy

  • ProjectsApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

getProject

  • getProject(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<TeamProject>

  • Get project with the specified id or name, optionally including capabilities.

    Parameters

    • params: object
      • apiVersion: string
      • Optional includeCapabilities?: boolean
      • Optional includeHistory?: boolean
      • organization: string
      • projectId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<TeamProject>

getProjectProperties

  • Get a collection of team project properties.

    Parameters

    • params: object
      • apiVersion: string
      • Optional keys?: string
      • organization: string
      • projectId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<ProjectProperty>>

getProjects

  • Get all projects in the organization that the authenticated user has access to.

    Parameters

    • params: object
      • Optional $Skip?: number
      • Optional $Top?: number
      • apiVersion: string
      • Optional continuationToken?: string
      • Optional getDefaultTeamImageUrl?: boolean
      • organization: string
      • Optional stateFilter?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<TeamProjectReference>>

queueCreateProject

  • queueCreateProject(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<OperationReference>

  • Queues a project to be created. Use the GetOperation to periodically check for create project status.

    Parameters

    • params: object
      • apiVersion: string
      • body: TeamProject
      • organization: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<OperationReference>

queueDeleteProject

  • queueDeleteProject(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<OperationReference>

  • Queues a project to be deleted. Use the GetOperation to periodically check for delete project status.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • projectId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<OperationReference>

setProjectProperties

  • setProjectProperties(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

  • Create, update, and delete team project properties.

    Parameters

    • params: object
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

updateProject

  • updateProject(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<OperationReference>

  • Update an existing project's name, abbreviation, description, or restore a project.

    Parameters

    • params: object
      • apiVersion: string
      • body: TeamProject
      • organization: string
      • projectId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<OperationReference>

Generated using TypeDoc