FavoritesListOptionalParams interface

Package:

@azure/arm-appinsights

Optional Parameters.

Extends

RequestOptionsBase

Properties

canFetchContent	Flag indicating whether or not to return the full content for each applicable favorite. If false, only return summary content for favorites.
favoriteType	The type of favorite. Value can be either shared or user. Possible values include: 'shared', 'user'. Default value: 'shared'.
sourceType	Source type of favorite to return. When left out, the source type defaults to 'other' (not present in this enum). Possible values include: 'retention', 'notebook', 'sessions', 'events', 'userflows', 'funnel', 'impact', 'segmentation'
tags	Tags that must be present on each favorite returned.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
customHeaders	User defined custom request headers that will be applied before the request is sent.
onDownloadProgress	Callback which fires upon download progress.
onUploadProgress	Callback which fires upon upload progress.
timeout	The number of milliseconds a request can take before automatically being terminated.

Property Details

canFetchContent

Flag indicating whether or not to return the full content for each applicable favorite. If false, only return summary content for favorites.

canFetchContent?: boolean

Property Value

boolean

favoriteType

The type of favorite. Value can be either shared or user. Possible values include: 'shared', 'user'. Default value: 'shared'.

favoriteType?: FavoriteType

Property Value

FavoriteType

sourceType

Source type of favorite to return. When left out, the source type defaults to 'other' (not present in this enum). Possible values include: 'retention', 'notebook', 'sessions', 'events', 'userflows', 'funnel', 'impact', 'segmentation'

sourceType?: FavoriteSourceType

Property Value

FavoriteSourceType

tags

Tags that must be present on each favorite returned.

tags?: string[]

Property Value

string[]

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From msRest.RequestOptionsBase.abortSignal

customHeaders

User defined custom request headers that will be applied before the request is sent.

customHeaders?: {[key: string]: string}

Property Value

{[key: string]: string}

Inherited From msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From msRest.RequestOptionsBase.onUploadProgress

timeout

The number of milliseconds a request can take before automatically being terminated.

timeout?: number

Property Value

number

Inherited From msRest.RequestOptionsBase.timeout