LocationsRestClient class

الحزمة:

azure-devops-extension-api

الفئة الأساسية التي يجب استخدامها (مشتقة من) لتقديم طلبات إلى VSS REST apis

يمتد

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

LastChangeId قديم 32 بت

lastChangeId64

number

LastChangeId غير مقتطع 64 بت

المرتجعات

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

إذا كان صحيحا، سنحاول الخطأ في تعيين مثيل مضيف إذا كان في SPS.

previewFaultIn

boolean

إذا كان صحيحا، فسنحسب تعيين مثيل مضيف ونعيده، ولكن لا نستمر فيه.

المرتجعات

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>