Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DefinitionsApi

Hierarchy

  • DefinitionsApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

createDefinition

  • createDefinition(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<BuildDefinition>

  • Creates a new definition.

    Parameters

    • params: object
      • apiVersion: string
      • body: BuildDefinition
      • Optional definitionToCloneId?: number
      • Optional definitionToCloneRevision?: number
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<BuildDefinition>

createReleaseDefinition

  • createReleaseDefinition(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ReleaseDefinition>

  • Create a release definition

    Parameters

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

    Returns Promise<ReleaseDefinition>

deleteDefinition

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

  • Deletes a definition and all associated builds.

    Parameters

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

    Returns Promise<__type>

deleteReleaseDefinition

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

  • Delete a release definition.

    Parameters

    • params: object
      • apiVersion: string
      • Optional comment?: string
      • definitionId: number
      • Optional forceDelete?: boolean
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

getDefinition

  • getDefinition(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<BuildDefinition>

  • Gets a definition, optionally at a specific revision.

    Parameters

    • params: object
      • apiVersion: string
      • definitionId: number
      • Optional includeLatestBuilds?: boolean
      • Optional minMetricsTime?: Date
      • organization: string
      • project: string
      • Optional propertyFilters?: string
      • Optional revision?: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<BuildDefinition>

getDefinitionRevision

  • getDefinitionRevision(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<string>

  • Get release definition for a given definitionId and revision

    Parameters

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

    Returns Promise<string>

getDefinitionRevisions

  • Gets all revisions of a definition.

    Parameters

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

    Returns Promise<ArrayWrapper<BuildDefinitionRevision>>

getDefinitions

  • Gets a list of definitions.

    Parameters

    • params: object
      • Optional $Top?: number
      • apiVersion: string
      • Optional builtAfter?: Date
      • Optional continuationToken?: string
      • Optional definitionIds?: string
      • Optional includeAllProperties?: boolean
      • Optional includeLatestBuilds?: boolean
      • Optional minMetricsTime?: Date
      • Optional name?: string
      • Optional notBuiltAfter?: Date
      • organization: string
      • Optional path?: string
      • Optional processType?: number
      • project: string
      • Optional queryOrder?: string
      • Optional repositoryId?: string
      • Optional repositoryType?: string
      • Optional taskIdFilter?: string
      • Optional yamlFilename?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<BuildDefinitionReference>>

getReleaseDefinition

  • getReleaseDefinition(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ReleaseDefinition>

  • Get a release definition.

    Parameters

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

    Returns Promise<ReleaseDefinition>

getReleaseDefinitionHistory

  • Get revision history for a release definition

    Parameters

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

    Returns Promise<ArrayWrapper<ReleaseDefinitionRevision>>

getReleaseDefinitions

  • Get a list of release definitions.

    Parameters

    • params: object
      • Optional $Expand?: string
      • Optional $Top?: number
      • apiVersion: string
      • Optional artifactSourceId?: string
      • Optional artifactType?: string
      • Optional continuationToken?: string
      • Optional definitionIdFilter?: string
      • Optional isDeleted?: boolean
      • Optional isExactNameMatch?: boolean
      • organization: string
      • Optional path?: string
      • project: string
      • Optional propertyFilters?: string
      • Optional queryOrder?: string
      • Optional searchText?: string
      • Optional searchTextContainsFolderName?: boolean
      • Optional tagFilter?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<ReleaseDefinition>>

restoreDefinition

  • restoreDefinition(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<BuildDefinition>

  • Restores a deleted definition

    Parameters

    • params: object
      • apiVersion: string
      • definitionId: number
      • deleted: boolean
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<BuildDefinition>

updateDefinition

  • updateDefinition(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<BuildDefinition>

  • Updates an existing definition.

    Parameters

    • params: object
      • apiVersion: string
      • body: BuildDefinition
      • definitionId: number
      • organization: string
      • project: string
      • Optional secretsSourceDefinitionId?: number
      • Optional secretsSourceDefinitionRevision?: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<BuildDefinition>

updateReleaseDefinition

  • updateReleaseDefinition(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ReleaseDefinition>

  • Update a release definition.

    Parameters

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

    Returns Promise<ReleaseDefinition>

Generated using TypeDoc