LocationsRestClient class

程序包:

azure-devops-extension-api

应使用基类（派生自）向 VSS REST API 发出请求

扩展

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>