Partilhar via

LocationsRestClient class

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

Classe base que deve ser utilizada (derivada de) para fazer pedidos às apis REST do VSS

Extends
RestClientBase

Construtores

LocationsRestClient(IVssRestClientOptions)

Métodos

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

Isto foi copiado e adaptado a partir 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 de Método

deleteServiceDefinition(string, string) 

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

Parâmetros

serviceType

string

identifier

string

Devoluções

Promise<void>

getConnectionData(ConnectOptions, number, number)

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

Devoluções

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

Devoluções

Promise<ResourceAreaInfo>

getResourceAreaByHost(string, string, string) 

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

Parâmetros

areaId

string

hostId

string

accessMapping

string

Devoluções

Promise<ResourceAreaInfo>

getResourceAreas(string, string) 

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

Parâmetros

enterpriseName

string

organizationName

string

Devoluções

Promise<ResourceAreaInfo[]>

getResourceAreasByHost(string) 

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

Parâmetros

hostId

string

Devoluções

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 verdade, tentaremos falhar num mapeamento de instância de anfitrião se estiver no SPS.

previewFaultIn

boolean

Se for verdade, vamos calcular e devolver um mapeamento de instância de anfitrião, mas não o manteremos.

Devoluções

Promise<ServiceDefinition>

getServiceDefinitions(string) 

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

Parâmetros

serviceType

string

Devoluções

Promise<ServiceDefinition[]>

updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>) 

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

Parâmetros

serviceDefinitions

VssJsonCollectionWrapperV<ServiceDefinition[]>

Devoluções

Promise<void>