DataProviderResult interface

Package:

azure-devops-extension-api

Result structure from calls to GetDataProviderData

Properties

clientProviders	This is the set of data providers that were requested, but either they were defined as client providers, or as remote providers that failed and may be retried by the client.
data	Property bag of data keyed off of the data provider contribution id
exceptions	Set of exceptions that occurred resolving the data providers.
resolvedProviders	List of data providers resolved in the data-provider query
scopeName	Scope name applied to this data provider result.
scopeValue	Scope value applied to this data provider result.
sharedData	Property bag of shared data that was contributed to by any of the individual data providers

Property Details

clientProviders

This is the set of data providers that were requested, but either they were defined as client providers, or as remote providers that failed and may be retried by the client.

clientProviders: {[key: string]: ClientDataProviderQuery}

Property Value

{[key: string]: ClientDataProviderQuery}

data

Property bag of data keyed off of the data provider contribution id

data: {[key: string]: any}

Property Value

{[key: string]: any}

exceptions

Set of exceptions that occurred resolving the data providers.

exceptions: {[key: string]: DataProviderExceptionDetails}

Property Value

{[key: string]: DataProviderExceptionDetails}

resolvedProviders

List of data providers resolved in the data-provider query

resolvedProviders: ResolvedDataProvider[]

Property Value

ResolvedDataProvider[]

scopeName

Scope name applied to this data provider result.

scopeName: string

Property Value

string

scopeValue

Scope value applied to this data provider result.

scopeValue: string

Property Value

string

sharedData

Property bag of shared data that was contributed to by any of the individual data providers

sharedData: {[key: string]: any}

Property Value

{[key: string]: any}