Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PropertiesApi

Hierarchy

  • PropertiesApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

getBuildProperties

  • getBuildProperties(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<PropertiesCollection>

  • Gets properties for a build.

    Parameters

    • params: object
      • apiVersion: string
      • buildId: number
      • Optional filter?: string
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<PropertiesCollection>

getDefinitionProperties

  • getDefinitionProperties(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<PropertiesCollection>

  • Gets properties for a definition.

    Parameters

    • params: object
      • apiVersion: string
      • definitionId: number
      • Optional filter?: string
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<PropertiesCollection>

updateBuildProperties

  • updateBuildProperties(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<PropertiesCollection>

  • Updates properties for a build.

    Parameters

    • params: object
      • apiVersion: string
      • body: JsonPatchDocument
      • buildId: number
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<PropertiesCollection>

updateDefinitionProperties

  • updateDefinitionProperties(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<PropertiesCollection>

  • Updates properties for a definition.

    Parameters

    • params: object
      • apiVersion: string
      • body: JsonPatchDocument
      • definitionId: number
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<PropertiesCollection>

Generated using TypeDoc