Compartir a través de

LocationsRestClient class

  • Referencia
Paquete:
azure-devops-extension-api

Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS

Extends
RestClientBase

Constructores

LocationsRestClient(IVssRestClientOptions)

Métodos

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

Se copió y adaptó de TeamFoundationConnectionService.Connect()
getResourceArea(string, string, string)
getResourceAreaByHost(string, string)
getResourceAreas(string, string)
getResourceAreasByHost(string)
getServiceDefinition(string, string, boolean, boolean)

Busca una definición de servicio determinada.
getServiceDefinitions(string)
updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>)

Detalles del constructor

LocationsRestClient(IVssRestClientOptions) 

new LocationsRestClient(options: IVssRestClientOptions)

Parámetros

options
IVssRestClientOptions

Detalles del método

deleteServiceDefinition(string, string) 

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

Parámetros

serviceType

string

identifier

string

Devoluciones

Promise<void>

getConnectionData(ConnectOptions, number, number)

Se copió y adaptó de TeamFoundationConnectionService.Connect()

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

Parámetros

connectOptions
ConnectOptions
lastChangeId

number

LastChangeId obsoleto de 32 bits

lastChangeId64

number

LastChangeId no truncado de 64 bits

Devoluciones

Promise<ConnectionData>

getResourceArea(string, string, string) 

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

Parámetros

areaId

string

enterpriseName

string

organizationName

string

Devoluciones

Promise<ResourceAreaInfo>

getResourceAreaByHost(string, string) 

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

Parámetros

areaId

string

hostId

string

Devoluciones

Promise<ResourceAreaInfo>

getResourceAreas(string, string) 

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

Parámetros

enterpriseName

string

organizationName

string

Devoluciones

Promise<ResourceAreaInfo[]>

getResourceAreasByHost(string) 

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

Parámetros

hostId

string

Devoluciones

Promise<ResourceAreaInfo[]>

getServiceDefinition(string, string, boolean, boolean)

Busca una definición de servicio determinada.

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

Parámetros

serviceType

string

identifier

string

allowFaultIn

boolean

Si es true, intentaremos que se produzca un error en una asignación de instancia de host si se encuentra en SPS.

previewFaultIn

boolean

Si es true, calcularemos y devolveremos una asignación de instancia de host, pero no la conservaremos.

Devoluciones

Promise<ServiceDefinition>

getServiceDefinitions(string) 

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

Parámetros

serviceType

string

Devoluciones

Promise<ServiceDefinition[]>

updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>) 

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

Parámetros

serviceDefinitions

VssJsonCollectionWrapperV<ServiceDefinition[]>

Devoluciones

Promise<void>