Condividi tramite

LocationsRestClient class

  • Riferimento
Pacchetto:
azure-devops-extension-api

Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST vss

Extends
RestClientBase

Costruttori

LocationsRestClient(IVssRestClientOptions)

Metodi

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

Questa operazione è stata copiata e adattata da TeamFoundationConnectionService.Connect()
getResourceArea(string, string, string, string)
getResourceAreaByHost(string, string, string)
getResourceAreas(string, string)
getResourceAreasByHost(string)
getServiceDefinition(string, string, boolean, boolean)

Trova una determinata definizione di servizio.
getServiceDefinitions(string)
updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>)

Dettagli costruttore

LocationsRestClient(IVssRestClientOptions) 

new LocationsRestClient(options: IVssRestClientOptions)

Parametri

options
IVssRestClientOptions

Dettagli metodo

deleteServiceDefinition(string, string) 

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

Parametri

serviceType

string

identifier

string

Restituisce

Promise<void>

getConnectionData(ConnectOptions, number, number)

Questa operazione è stata copiata e adattata da TeamFoundationConnectionService.Connect()

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

Parametri

connectOptions
ConnectOptions
lastChangeId

number

LastChangeId obsoleto a 32 bit

lastChangeId64

number

LastChangeId a 64 bit non troncato

Restituisce

Promise<ConnectionData>

getResourceArea(string, string, string, string) 

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

Parametri

areaId

string

enterpriseName

string

organizationName

string

accessMapping

string

Restituisce

Promise<ResourceAreaInfo>

getResourceAreaByHost(string, string, string) 

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

Parametri

areaId

string

hostId

string

accessMapping

string

Restituisce

Promise<ResourceAreaInfo>

getResourceAreas(string, string) 

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

Parametri

enterpriseName

string

organizationName

string

Restituisce

Promise<ResourceAreaInfo[]>

getResourceAreasByHost(string) 

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

Parametri

hostId

string

Restituisce

Promise<ResourceAreaInfo[]>

getServiceDefinition(string, string, boolean, boolean)

Trova una determinata definizione di servizio.

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

Parametri

serviceType

string

identifier

string

allowFaultIn

boolean

Se true, si tenterà di eseguire un errore nel mapping di un'istanza host se in SPS.

previewFaultIn

boolean

Se true, verrà calcolato e restituito un mapping dell'istanza host, ma non verrà reso persistente.

Restituisce

Promise<ServiceDefinition>

getServiceDefinitions(string) 

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

Parametri

serviceType

string

Restituisce

Promise<ServiceDefinition[]>

updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>) 

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

Parametri

serviceDefinitions

VssJsonCollectionWrapperV<ServiceDefinition[]>

Restituisce

Promise<void>