Partager via

LocationsRestClient class

Paquet:
azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des API REST VSS

Extends
RestClientBase

Constructeurs

LocationsRestClient(IVssRestClientOptions)

Méthodes

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

Ceci a été copié et adapté de 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)

Recherche une définition de service donnée.
getServiceDefinitions(string)
updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>)

Détails du constructeur

LocationsRestClient(IVssRestClientOptions) 

new LocationsRestClient(options: IVssRestClientOptions)

Paramètres

options
IVssRestClientOptions

Détails de la méthode

deleteServiceDefinition(string, string) 

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

Paramètres

serviceType

string

identifier

string

Retours

Promise<void>

getConnectionData(ConnectOptions, number, number)

Ceci a été copié et adapté de TeamFoundationConnectionService.Connect()

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

Paramètres

connectOptions
ConnectOptions
lastChangeId

number

LastChangeId 32 bits obsolète

lastChangeId64

number

LastChangeId 64 bits non tronqué

Retours

Promise<ConnectionData>

getResourceArea(string, string, string, string) 

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

Paramètres

areaId

string

enterpriseName

string

organizationName

string

accessMapping

string

Retours

Promise<ResourceAreaInfo>

getResourceAreaByHost(string, string, string) 

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

Paramètres

areaId

string

hostId

string

accessMapping

string

Retours

Promise<ResourceAreaInfo>

getResourceAreaByInstanceId(string, string, string) 

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

Paramètres

areaId

string

instanceId

string

accessMapping

string

Retours

Promise<ResourceAreaInfo>

getResourceAreas(string, string) 

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

Paramètres

enterpriseName

string

organizationName

string

Retours

Promise<ResourceAreaInfo[]>

getResourceAreasByHost(string) 

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

Paramètres

hostId

string

Retours

Promise<ResourceAreaInfo[]>

getServiceDefinition(string, string, boolean, boolean)

Recherche une définition de service donnée.

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

Paramètres

serviceType

string

identifier

string

allowFaultIn

boolean

Si la valeur est true, nous tenterons de corriger le mappage d’une instance d’hôte si elle est dans SPS.

previewFaultIn

boolean

Si la valeur est true, nous calculerons et renverrons un mappage d’instance d’hôte, mais nous ne le conserverons pas.

Retours

Promise<ServiceDefinition>

getServiceDefinitions(string) 

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

Paramètres

serviceType

string

Retours

Promise<ServiceDefinition[]>

updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>) 

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

Paramètres

serviceDefinitions

VssJsonCollectionWrapperV<ServiceDefinition[]>

Retours

Promise<void>