LocationsRestClient class

  • Referência
Pacote:
azure-devops-extension-api

Classe base que deve ser usada (derivada de) para fazer solicitações para apis REST do VSS

Extends
RestClientBase

Construtores

LocationsRestClient(IVssRestClientOptions)

Métodos

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

Isso foi copiado e adaptado de TeamFoundationConnectionService.Connect()
getResourceArea(string, string, string, string)
getResourceAreaByHost(string, string, string)
getResourceAreas(string, string)
getResourceAreasByHost(string)
getServiceDefinition(string, string, boolean, boolean)

Localiza uma determinada definição de serviço.
getServiceDefinitions(string)
updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>)

Detalhes do construtor

LocationsRestClient(IVssRestClientOptions) 

new LocationsRestClient(options: IVssRestClientOptions)

Parâmetros

options
IVssRestClientOptions

Detalhes do método

deleteServiceDefinition(string, string) 

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

Parâmetros

serviceType

string

identifier

string

Retornos

Promise<void>

getConnectionData(ConnectOptions, number, number)

Isso foi copiado e adaptado 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 não truncado de 64 bits

Retornos

Promise<ConnectionData>

getResourceArea(string, string, string, string) 

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

Parâmetros

areaId

string

enterpriseName

string

organizationName

string

accessMapping

string

Retornos

Promise<ResourceAreaInfo>

getResourceAreaByHost(string, string, string) 

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

Parâmetros

areaId

string

hostId

string

accessMapping

string

Retornos

Promise<ResourceAreaInfo>

getResourceAreas(string, string) 

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

Parâmetros

enterpriseName

string

organizationName

string

Retornos

Promise<ResourceAreaInfo[]>

getResourceAreasByHost(string) 

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

Parâmetros

hostId

string

Retornos

Promise<ResourceAreaInfo[]>

getServiceDefinition(string, string, boolean, boolean)

Localiza uma determinada definição de serviço.

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

Parâmetros

serviceType

string

identifier

string

allowFaultIn

boolean

Se for true, tentaremos falhar em um mapeamento de instância de host se estiver no SPS.

previewFaultIn

boolean

Se for true, calcularemos e retornaremos um mapeamento de instância de host, mas não o persistiremos.

Retornos

Promise<ServiceDefinition>

getServiceDefinitions(string) 

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

Parâmetros

serviceType

string

Retornos

Promise<ServiceDefinition[]>

updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>) 

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

Parâmetros

serviceDefinitions

VssJsonCollectionWrapperV<ServiceDefinition[]>

Retornos

Promise<void>