LocationsRestClient class

Pakiet:
azure-devops-extension-api

Klasa bazowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Rozszerzenie
RestClientBase

Konstruktory

LocationsRestClient(IVssRestClientOptions)

Metody

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

Zostało to skopiowane i dostosowane z pliku 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)

Znajduje daną definicję usługi.
getServiceDefinitions(string)
updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>)

Szczegóły konstruktora

LocationsRestClient(IVssRestClientOptions) 

new LocationsRestClient(options: IVssRestClientOptions)

Parametry

options
IVssRestClientOptions

Szczegóły metody

deleteServiceDefinition(string, string) 

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

Parametry

serviceType

string

identifier

string

Zwraca

Promise<void>

getConnectionData(ConnectOptions, number, number)

Zostało to skopiowane i dostosowane z pliku TeamFoundationConnectionService.Connect()

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

Parametry

connectOptions
ConnectOptions
lastChangeId

number

Przestarzałe 32-bitowe identyfikatory LastChangeId

lastChangeId64

number

Nie obcięte 64-bitowe identyfikatory LastChangeId

Zwraca

Promise<ConnectionData>

getResourceArea(string, string, string, string) 

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

Parametry

areaId

string

enterpriseName

string

organizationName

string

accessMapping

string

Zwraca

Promise<ResourceAreaInfo>

getResourceAreaByHost(string, string, string) 

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

Parametry

areaId

string

hostId

string

accessMapping

string

Zwraca

Promise<ResourceAreaInfo>

getResourceAreaByInstanceId(string, string, string) 

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

Parametry

areaId

string

instanceId

string

accessMapping

string

Zwraca

Promise<ResourceAreaInfo>

getResourceAreas(string, string) 

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

Parametry

enterpriseName

string

organizationName

string

Zwraca

Promise<ResourceAreaInfo[]>

getResourceAreasByHost(string) 

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

Parametry

hostId

string

Zwraca

Promise<ResourceAreaInfo[]>

getServiceDefinition(string, string, boolean, boolean)

Znajduje daną definicję usługi.

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

Parametry

serviceType

string

identifier

string

allowFaultIn

boolean

Jeśli to prawda, spróbujemy podjąć próbę błędu w mapowaniu wystąpienia hosta, jeśli w usłudze SPS.

previewFaultIn

boolean

Jeśli wartość true, obliczymy i zwrócimy mapowanie wystąpienia hosta, ale nie będziemy go utrwalać.

Zwraca

Promise<ServiceDefinition>

getServiceDefinitions(string) 

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

Parametry

serviceType

string

Zwraca

Promise<ServiceDefinition[]>

updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>) 

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

Parametry

serviceDefinitions

VssJsonCollectionWrapperV<ServiceDefinition[]>

Zwraca

Promise<void>