LocationsRestClient class

  • Reference
Package:
azure-devops-extension-api

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

Extends
RestClientBase

Constructors

LocationsRestClient(IVssRestClientOptions)

Methods

deleteServiceDefinition(string, string)
getConnectionData(ConnectOptions, number, number)

This was copied and adapted from TeamFoundationConnectionService.Connect()
getResourceArea(string, string, string, string)
getResourceAreaByHost(string, string, string)
getResourceAreas(string, string)
getResourceAreasByHost(string)
getServiceDefinition(string, string, boolean, boolean)

Finds a given service definition.
getServiceDefinitions(string)
updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>)

Constructor Details

LocationsRestClient(IVssRestClientOptions) 

new LocationsRestClient(options: IVssRestClientOptions)

Parameters

options
IVssRestClientOptions

Method Details

deleteServiceDefinition(string, string) 

function deleteServiceDefinition(serviceType: string, identifier: string): Promise<void>

Parameters

serviceType

string

identifier

string

Returns

Promise<void>

getConnectionData(ConnectOptions, number, number)

This was copied and adapted from TeamFoundationConnectionService.Connect()

function getConnectionData(connectOptions?: ConnectOptions, lastChangeId?: number, lastChangeId64?: number): Promise<ConnectionData>

Parameters

connectOptions
ConnectOptions
lastChangeId

number

Obsolete 32-bit LastChangeId

lastChangeId64

number

Non-truncated 64-bit LastChangeId

Returns

Promise<ConnectionData>

getResourceArea(string, string, string, string) 

function getResourceArea(areaId: string, enterpriseName?: string, organizationName?: string, accessMapping?: string): Promise<ResourceAreaInfo>

Parameters

areaId

string

enterpriseName

string

organizationName

string

accessMapping

string

Returns

Promise<ResourceAreaInfo>

getResourceAreaByHost(string, string, string) 

function getResourceAreaByHost(areaId: string, hostId: string, accessMapping?: string): Promise<ResourceAreaInfo>

Parameters

areaId

string

hostId

string

accessMapping

string

Returns

Promise<ResourceAreaInfo>

getResourceAreas(string, string) 

function getResourceAreas(enterpriseName?: string, organizationName?: string): Promise<ResourceAreaInfo[]>

Parameters

enterpriseName

string

organizationName

string

Returns

Promise<ResourceAreaInfo[]>

getResourceAreasByHost(string) 

function getResourceAreasByHost(hostId: string): Promise<ResourceAreaInfo[]>

Parameters

hostId

string

Returns

Promise<ResourceAreaInfo[]>

getServiceDefinition(string, string, boolean, boolean)

Finds a given service definition.

function getServiceDefinition(serviceType: string, identifier: string, allowFaultIn?: boolean, previewFaultIn?: boolean): Promise<ServiceDefinition>

Parameters

serviceType

string

identifier

string

allowFaultIn

boolean

If true, we will attempt to fault in a host instance mapping if in SPS.

previewFaultIn

boolean

If true, we will calculate and return a host instance mapping, but not persist it.

Returns

Promise<ServiceDefinition>

getServiceDefinitions(string) 

function getServiceDefinitions(serviceType?: string): Promise<ServiceDefinition[]>

Parameters

serviceType

string

Returns

Promise<ServiceDefinition[]>

updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>) 

function updateServiceDefinitions(serviceDefinitions: VssJsonCollectionWrapperV<ServiceDefinition[]>): Promise<void>

Parameters

serviceDefinitions

VssJsonCollectionWrapperV<ServiceDefinition[]>

Returns

Promise<void>