LocationsRestClient class

Пакет:

azure-devops-extension-api

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

Extends

RestClientBase

Конструкторы

LocationsRestClient(IVssRestClientOptions)

Методы

deleteServiceDefinition(string, string)
getConnectionData(ConnectOptions, number, number)	Это было скопировано и адаптировано из 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)	Находит заданное определение службы.
getServiceDefinitions(string)
updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>)

Сведения о конструкторе

LocationsRestClient(IVssRestClientOptions)

new LocationsRestClient(options: IVssRestClientOptions)

Параметры

options

IVssRestClientOptions

Сведения о методе

deleteServiceDefinition(string, string)

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

Параметры

serviceType

string

identifier

string

Возвращаемое значение

Promise<void>

getConnectionData(ConnectOptions, number, number)

Это было скопировано и адаптировано из TeamFoundationConnectionService.Connect()

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

Параметры

connectOptions

ConnectOptions

lastChangeId

number

Устаревший 32-разрядный LastChangeId

lastChangeId64

number

Не усеченный 64-разрядный LastChangeId

Возвращаемое значение

Promise<ConnectionData>

getResourceArea(string, string, string, string)

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

Параметры

areaId

string

enterpriseName

string

organizationName

string

accessMapping

string

Возвращаемое значение

Promise<ResourceAreaInfo>

getResourceAreaByHost(string, string, string)

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

Параметры

areaId

string

hostId

string

accessMapping

string

Возвращаемое значение

Promise<ResourceAreaInfo>

getResourceAreaByInstanceId(string, string, string)

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

Параметры

areaId

string

instanceId

string

accessMapping

string

Возвращаемое значение

Promise<ResourceAreaInfo>

getResourceAreas(string, string)

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

Параметры

enterpriseName

string

organizationName

string

Возвращаемое значение

Promise<ResourceAreaInfo[]>

getResourceAreasByHost(string)

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

Параметры

hostId

string

Возвращаемое значение

Promise<ResourceAreaInfo[]>

getServiceDefinition(string, string, boolean, boolean)

Находит заданное определение службы.

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

Параметры

serviceType

string

identifier

string

allowFaultIn

boolean

Если значение true, мы попытаемся выполнить ошибку в сопоставлении экземпляра узла, если в SPS.

previewFaultIn

boolean

Если значение true, мы вычислим и возвращаем сопоставление экземпляра узла, но не сохраняем его.

Возвращаемое значение

Promise<ServiceDefinition>

getServiceDefinitions(string)

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

Параметры

serviceType

string

Возвращаемое значение

Promise<ServiceDefinition[]>

updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>)

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

Параметры

serviceDefinitions

VssJsonCollectionWrapperV<ServiceDefinition[]>

Возвращаемое значение

Promise<void>