Delen via


LocationsRestClient class

Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen naar VSS REST API's

Uitbreiding

Constructors

LocationsRestClient(IVssRestClientOptions)

Methoden

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

Dit is gekopieerd en aangepast van TeamFoundationConnectionService.Connect()

getResourceArea(string, string, string, string)
getResourceAreaByHost(string, string, string)
getResourceAreaByInstanceId(string, string, string)
getResourceAreas(string, string)
getResourceAreasByHost(string)
getServiceDefinition(string, string, boolean, boolean)

Hiermee wordt een bepaalde servicedefinitie gevonden.

getServiceDefinitions(string)
updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>)

Constructordetails

LocationsRestClient(IVssRestClientOptions)

new LocationsRestClient(options: IVssRestClientOptions)

Parameters

Methodedetails

deleteServiceDefinition(string, string)

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

Parameters

serviceType

string

identifier

string

Retouren

Promise<void>

getConnectionData(ConnectOptions, number, number)

Dit is gekopieerd en aangepast van TeamFoundationConnectionService.Connect()

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

Parameters

connectOptions
ConnectOptions
lastChangeId

number

Verouderde 32-bits LastChangeId

lastChangeId64

number

Niet-afgekapte 64-bits LastChangeId

Retouren

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

Retouren

Promise<ResourceAreaInfo>

getResourceAreaByHost(string, string, string)

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

Parameters

areaId

string

hostId

string

accessMapping

string

Retouren

Promise<ResourceAreaInfo>

getResourceAreaByInstanceId(string, string, string)

function getResourceAreaByInstanceId(areaId: string, instanceId: string, accessMapping: string): Promise<ResourceAreaInfo>

Parameters

areaId

string

instanceId

string

accessMapping

string

Retouren

Promise<ResourceAreaInfo>

getResourceAreas(string, string)

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

Parameters

enterpriseName

string

organizationName

string

Retouren

Promise<ResourceAreaInfo[]>

getResourceAreasByHost(string)

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

Parameters

hostId

string

Retouren

Promise<ResourceAreaInfo[]>

getServiceDefinition(string, string, boolean, boolean)

Hiermee wordt een bepaalde servicedefinitie gevonden.

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

Parameters

serviceType

string

identifier

string

allowFaultIn

boolean

Als dit waar is, zullen we proberen een fout te maken in de toewijzing van een hostinstantie in SPS.

previewFaultIn

boolean

Als dit waar is, berekenen we de toewijzing van een hostinstantie en retourneren deze, maar behouden we deze niet.

Retouren

getServiceDefinitions(string)

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

Parameters

serviceType

string

Retouren

Promise<ServiceDefinition[]>

updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>)

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

Parameters

Retouren

Promise<void>