LocationsRestClient class

Paket:
azure-devops-extension-api

Basklass som ska användas (härledd från) för att göra begäranden till VSS REST-API:er

Extends
RestClientBase

Konstruktorer

LocationsRestClient(IVssRestClientOptions)

Metoder

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

Detta kopierades och anpassades från 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)

Söker efter en viss tjänstdefinition.
getServiceDefinitions(string)
updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>)

Konstruktorinformation

LocationsRestClient(IVssRestClientOptions) 

new LocationsRestClient(options: IVssRestClientOptions)

Parametrar

options
IVssRestClientOptions

Metodinformation

deleteServiceDefinition(string, string) 

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

Parametrar

serviceType

string

identifier

string

Returer

Promise<void>

getConnectionData(ConnectOptions, number, number)

Detta kopierades och anpassades från TeamFoundationConnectionService.Connect()

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

Parametrar

connectOptions
ConnectOptions
lastChangeId

number

Föråldrad 32-bitars LastChangeId

lastChangeId64

number

Icke-trunkerad 64-bitars LastChangeId

Returer

Promise<ConnectionData>

getResourceArea(string, string, string, string) 

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

Parametrar

areaId

string

enterpriseName

string

organizationName

string

accessMapping

string

Returer

Promise<ResourceAreaInfo>

getResourceAreaByHost(string, string, string) 

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

Parametrar

areaId

string

hostId

string

accessMapping

string

Returer

Promise<ResourceAreaInfo>

getResourceAreaByInstanceId(string, string, string) 

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

Parametrar

areaId

string

instanceId

string

accessMapping

string

Returer

Promise<ResourceAreaInfo>

getResourceAreas(string, string) 

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

Parametrar

enterpriseName

string

organizationName

string

Returer

Promise<ResourceAreaInfo[]>

getResourceAreasByHost(string) 

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

Parametrar

hostId

string

Returer

Promise<ResourceAreaInfo[]>

getServiceDefinition(string, string, boolean, boolean)

Söker efter en viss tjänstdefinition.

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

Parametrar

serviceType

string

identifier

string

allowFaultIn

boolean

Om det är sant kommer vi att försöka fela i en värdinstansmappning om det är i SPS.

previewFaultIn

boolean

Om det är sant beräknar och returnerar vi en mappning av värdinstansen, men bevarar den inte.

Returer

Promise<ServiceDefinition>

getServiceDefinitions(string) 

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

Parametrar

serviceType

string

Returer

Promise<ServiceDefinition[]>

updateServiceDefinitions(VssJsonCollectionWrapperV<ServiceDefinition[]>) 

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

Parametrar

serviceDefinitions

VssJsonCollectionWrapperV<ServiceDefinition[]>

Returer

Promise<void>