Class LocationsApi

Hierarchy (View Summary)

ClientApiBase
- LocationsApi

Implements

ILocationsApi

Index

Constructors

constructor

new LocationsApi(
    baseUrl: string,
    handlers: IRequestHandler[],
    options?: IRequestOptions,
): LocationsApi
Parameters
- baseUrl: string
- handlers: IRequestHandler[]
- Optionaloptions: IRequestOptions
Returns LocationsApi
Overrides ClientApiBase.constructor
- Defined in repos/azure-devops-node-api/api/LocationsApi.ts:33

Properties

baseUrl

baseUrl: string

http

http: HttpClient

rest

rest: RestClient

userAgent

userAgent: string

vsoClient

vsoClient: VsoClient

Methods

createAcceptHeader

createAcceptHeader(type: string, apiVersion?: string): string
Parameters
- type: string
- OptionalapiVersion: string
Returns string
Implementation of ILocationsApi.createAcceptHeader
Inherited from ClientApiBase.createAcceptHeader
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:30

createRequestOptions

createRequestOptions(type: string, apiVersion?: string): IRequestOptions
Parameters
- type: string
- OptionalapiVersion: string
Returns IRequestOptions
Implementation of ILocationsApi.createRequestOptions
Inherited from ClientApiBase.createRequestOptions
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:34

deleteServiceDefinition

deleteServiceDefinition(serviceType: string, identifier: string): Promise<void>
Parameters
- serviceType: string
- identifier: string
Returns Promise<void>
Implementation of ILocationsApi.deleteServiceDefinition
- Defined in repos/azure-devops-node-api/api/LocationsApi.ts:282

formatResponse

formatResponse(data: any, responseTypeMetadata: any, isCollection: boolean): any
Parameters
- data: any
- responseTypeMetadata: any
- isCollection: boolean
Returns any
Implementation of ILocationsApi.formatResponse
Inherited from ClientApiBase.formatResponse
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:40

getConnectionData

getConnectionData(
    connectOptions?: ConnectOptions,
    lastChangeId?: number,
    lastChangeId64?: number,
): Promise<ConnectionData>
This was copied and adapted from TeamFoundationConnectionService.Connect()
Parameters
- OptionalconnectOptions: ConnectOptions
- OptionallastChangeId: number
  Obsolete 32-bit LastChangeId
- OptionallastChangeId64: number
  Non-truncated 64-bit LastChangeId
Returns Promise<ConnectionData>
Implementation of ILocationsApi.getConnectionData
- Defined in repos/azure-devops-node-api/api/LocationsApi.ts:44

getResourceArea

getResourceArea(
    areaId: string,
    enterpriseName?: string,
    organizationName?: string,
): Promise<ResourceAreaInfo>
Parameters
- areaId: string
- OptionalenterpriseName: string
- OptionalorganizationName: string
Returns Promise<ResourceAreaInfo>
Implementation of ILocationsApi.getResourceArea
- Defined in repos/azure-devops-node-api/api/LocationsApi.ts:93

getResourceAreaByHost

getResourceAreaByHost(areaId: string, hostId: string): Promise<ResourceAreaInfo>
Parameters
- areaId: string
- hostId: string
Returns Promise<ResourceAreaInfo>
Implementation of ILocationsApi.getResourceAreaByHost
- Defined in repos/azure-devops-node-api/api/LocationsApi.ts:141

getResourceAreas

getResourceAreas(
enterpriseName?: string,
organizationName?: string,
): Promise<ResourceAreaInfo[]>
Parameters
- OptionalenterpriseName: string
- OptionalorganizationName: string
Returns Promise<ResourceAreaInfo[]>
Implementation of ILocationsApi.getResourceAreas
- Defined in repos/azure-devops-node-api/api/LocationsApi.ts:190

getResourceAreasByHost

getResourceAreasByHost(hostId: string): Promise<ResourceAreaInfo[]>
Parameters
- hostId: string
Returns Promise<ResourceAreaInfo[]>
Implementation of ILocationsApi.getResourceAreasByHost
- Defined in repos/azure-devops-node-api/api/LocationsApi.ts:235

getServiceDefinition

getServiceDefinition(
    serviceType: string,
    identifier: string,
    allowFaultIn?: boolean,
    previewFaultIn?: boolean,
): Promise<ServiceDefinition>
Finds a given service definition.
Parameters
- serviceType: string
- identifier: string
- OptionalallowFaultIn: boolean
  If true, we will attempt to fault in a host instance mapping if in SPS.
- OptionalpreviewFaultIn: boolean
  If true, we will calculate and return a host instance mapping, but not persist it.
Returns Promise<ServiceDefinition>
Implementation of ILocationsApi.getServiceDefinition
- Defined in repos/azure-devops-node-api/api/LocationsApi.ts:328

getServiceDefinitions

getServiceDefinitions(serviceType?: string): Promise<ServiceDefinition[]>
Parameters
- OptionalserviceType: string
Returns Promise<ServiceDefinition[]>
Implementation of ILocationsApi.getServiceDefinitions
- Defined in repos/azure-devops-node-api/api/LocationsApi.ts:377

updateServiceDefinitions

updateServiceDefinitions(
serviceDefinitions: VssJsonCollectionWrapperV<ServiceDefinition[]>,
): Promise<void>
Parameters
- serviceDefinitions: VssJsonCollectionWrapperV<ServiceDefinition[]>
Returns Promise<void>
Implementation of ILocationsApi.updateServiceDefinitions
- Defined in repos/azure-devops-node-api/api/LocationsApi.ts:416

Class LocationsApi

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LocationsApi

Properties

baseUrl

http

rest

userAgent

vsoClient

Methods

createAcceptHeader

Parameters

Returns string

createRequestOptions

Parameters

Returns IRequestOptions

deleteServiceDefinition

Parameters

Returns Promise<void>

formatResponse

Parameters

Returns any

getConnectionData

Parameters

Returns Promise<ConnectionData>

getResourceArea

Parameters

Returns Promise<ResourceAreaInfo>

getResourceAreaByHost

Parameters

Returns Promise<ResourceAreaInfo>

getResourceAreas

Parameters

Returns Promise<ResourceAreaInfo[]>

getResourceAreasByHost

Parameters

Returns Promise<ResourceAreaInfo[]>

getServiceDefinition

Parameters

Returns Promise<ServiceDefinition>

getServiceDefinitions

Parameters

Returns Promise<ServiceDefinition[]>

updateServiceDefinitions

Parameters

Returns Promise<void>

Settings

On This Page