ChangeFeedIteratorOptions interface
Specifies options for the change feed
If none of those options are set, it will start reading changes from now for the entire container.
Properties
| change |
Signals the mode in which the change feed needs to start. |
| change |
Signals where to start from in the change feed. |
| excluded |
Excludes one or more Azure regions for the operation. This option is only applied when enableEndPointDiscovery is set to true. |
| max |
Max amount of items to return per page |
| session |
The session token to use. If not specified, will use the most recent captured session token to start with. |
Property Details
changeFeedMode
Signals the mode in which the change feed needs to start.
changeFeedMode?: ChangeFeedMode
Property Value
changeFeedStartFrom
Signals where to start from in the change feed.
changeFeedStartFrom?: ChangeFeedStartFrom
Property Value
excludedLocations
Excludes one or more Azure regions for the operation.
This option is only applied when enableEndPointDiscovery is set to true.
excludedLocations?: string[]
Property Value
string[]
maxItemCount
Max amount of items to return per page
maxItemCount?: number
Property Value
number
sessionToken
The session token to use. If not specified, will use the most recent captured session token to start with.
sessionToken?: string
Property Value
string