Sdílet prostřednictvím

LocationsRestClient class

  • Reference
Balíček:
azure-devops-extension-api

Základní třída, která by se měla používat (odvozená z) k vytváření požadavků na rozhraní REST api služby VSS

Extends
RestClientBase

Konstruktory

LocationsRestClient(IVssRestClientOptions)

Metody

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

To bylo zkopírováno a upraveno z TeamFoundationConnectionService.Connect().
getResourceArea(string, string, string, string)
getResourceAreaByHost(string, string, string)
getResourceAreas(string, string)
getResourceAreasByHost(string)
getServiceDefinition(string, string, boolean, boolean)

Vyhledá definici dané služby.
getServiceDefinitions(string)
updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>)

Podrobnosti konstruktoru

LocationsRestClient(IVssRestClientOptions) 

new LocationsRestClient(options: IVssRestClientOptions)

Parametry

options
IVssRestClientOptions

Podrobnosti metody

deleteServiceDefinition(string, string) 

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

Parametry

serviceType

string

identifier

string

Návraty

Promise<void>

getConnectionData(ConnectOptions, number, number)

To bylo zkopírováno a upraveno z TeamFoundationConnectionService.Connect().

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

Parametry

connectOptions
ConnectOptions
lastChangeId

number

Zastaralé 32bitové LastChangeId

lastChangeId64

number

Neoříznuté 64bitové LastChangeId

Návraty

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

Návraty

Promise<ResourceAreaInfo>

getResourceAreaByHost(string, string, string) 

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

Parametry

areaId

string

hostId

string

accessMapping

string

Návraty

Promise<ResourceAreaInfo>

getResourceAreas(string, string) 

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

Parametry

enterpriseName

string

organizationName

string

Návraty

Promise<ResourceAreaInfo[]>

getResourceAreasByHost(string) 

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

Parametry

hostId

string

Návraty

Promise<ResourceAreaInfo[]>

getServiceDefinition(string, string, boolean, boolean)

Vyhledá definici dané služby.

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

Parametry

serviceType

string

identifier

string

allowFaultIn

boolean

Pokud ano, pokusíme se chybu při mapování instance hostitele, pokud je ve službě SPS.

previewFaultIn

boolean

Pokud je to pravda, vypočítáme a vrátíme mapování instance hostitele, ale neuchováváme ho.

Návraty

Promise<ServiceDefinition>

getServiceDefinitions(string) 

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

Parametry

serviceType

string

Návraty

Promise<ServiceDefinition[]>

updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>) 

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

Parametry

serviceDefinitions

VssJsonCollectionWrapperV<ServiceDefinition[]>

Návraty

Promise<void>