Share via

LocationsRestClient class

  • Referenz
Paket:
azure-devops-extension-api

Basisklasse, die verwendet (von abgeleitet) werden soll, um Anforderungen an VSS-REST-APIs zu senden

Extends
RestClientBase

Konstruktoren

LocationsRestClient(IVssRestClientOptions)

Methoden

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

Dies wurde aus TeamFoundationConnectionService.Connect() kopiert und angepasst.
getResourceArea(string, string, string)
getResourceAreaByHost(string, string)
getResourceAreas(string, string)
getResourceAreasByHost(string)
getServiceDefinition(string, string, boolean, boolean)

Sucht nach einer bestimmten Dienstdefinition.
getServiceDefinitions(string)
updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>)

Details zum Konstruktor

LocationsRestClient(IVssRestClientOptions) 

new LocationsRestClient(options: IVssRestClientOptions)

Parameter

options
IVssRestClientOptions

Details zur Methode

deleteServiceDefinition(string, string) 

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

Parameter

serviceType

string

identifier

string

Gibt zurück

Promise<void>

getConnectionData(ConnectOptions, number, number)

Dies wurde aus TeamFoundationConnectionService.Connect() kopiert und angepasst.

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

Parameter

connectOptions
ConnectOptions
lastChangeId

number

Veraltete 32-Bit-LastChangeId

lastChangeId64

number

Nicht abgeschnittene 64-Bit-LastChangeId

Gibt zurück

Promise<ConnectionData>

getResourceArea(string, string, string) 

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

Parameter

areaId

string

enterpriseName

string

organizationName

string

Gibt zurück

Promise<ResourceAreaInfo>

getResourceAreaByHost(string, string) 

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

Parameter

areaId

string

hostId

string

Gibt zurück

Promise<ResourceAreaInfo>

getResourceAreas(string, string) 

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

Parameter

enterpriseName

string

organizationName

string

Gibt zurück

Promise<ResourceAreaInfo[]>

getResourceAreasByHost(string) 

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

Parameter

hostId

string

Gibt zurück

Promise<ResourceAreaInfo[]>

getServiceDefinition(string, string, boolean, boolean)

Sucht nach einer bestimmten Dienstdefinition.

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

Parameter

serviceType

string

identifier

string

allowFaultIn

boolean

Wenn true, versuchen wir, einen Fehler in einem Host instance Zuordnung, wenn in SPS.

previewFaultIn

boolean

Wenn true, berechnen und geben wir eine Host-instance-Zuordnung zurück, aber nicht beibehalten.

Gibt zurück

Promise<ServiceDefinition>

getServiceDefinitions(string) 

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

Parameter

serviceType

string

Gibt zurück

Promise<ServiceDefinition[]>

updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>) 

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

Parameter

serviceDefinitions

VssJsonCollectionWrapperV<ServiceDefinition[]>

Gibt zurück

Promise<void>