Skip to content

Commit aab45cc

Browse files
author
JiayueHu
authored
Merge pull request MicrosoftDocs#436 from MicrosoftDocs/smoke-test
onboarding msal - CI
2 parents 53e4a79 + f7a74c5 commit aab45cc

File tree

673 files changed

+17020
-4544
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

673 files changed

+17020
-4544
lines changed

‎docs-ref-autogen/@azure/cosmos/AuthOptions.yml

+16
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ items:
44
name: AuthOptions
55
fullName: AuthOptions
66
children:
7+
- '@azure/cosmos.AuthOptions.key'
78
- '@azure/cosmos.AuthOptions.masterKey'
89
- '@azure/cosmos.AuthOptions.permissionFeed'
910
- '@azure/cosmos.AuthOptions.resourceTokens'
@@ -13,6 +14,21 @@ items:
1314
type: interface
1415
summary: ''
1516
package: '@azure/cosmos'
17+
- uid: '@azure/cosmos.AuthOptions.key'
18+
name: key
19+
fullName: key
20+
children: []
21+
langs:
22+
- typeScript
23+
type: property
24+
summary: Account master key or read only key
25+
optional: true
26+
syntax:
27+
content: 'key?: string'
28+
return:
29+
type:
30+
- string
31+
package: '@azure/cosmos'
1632
- uid: '@azure/cosmos.AuthOptions.masterKey'
1733
name: masterKey
1834
fullName: masterKey

‎docs-ref-autogen/@azure/cosmos/ChangeFeedIterator.yml

+104
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
### YamlMime:UniversalReference
2+
items:
3+
- uid: '@azure/cosmos.ChangeFeedIterator'
4+
name: ChangeFeedIterator
5+
fullName: ChangeFeedIterator<T>
6+
children:
7+
- '@azure/cosmos.ChangeFeedIterator.executeNext'
8+
- '@azure/cosmos.ChangeFeedIterator.getAsyncIterator'
9+
- '@azure/cosmos.ChangeFeedIterator.hasMoreResults'
10+
langs:
11+
- typeScript
12+
type: class
13+
summary: |
14+
Provides iterator for change feed.
15+
Use `Items.readChangeFeed()` to get an instance of the iterator.
16+
package: '@azure/cosmos'
17+
- uid: '@azure/cosmos.ChangeFeedIterator.executeNext'
18+
name: executeNext()
19+
children: []
20+
type: method
21+
langs:
22+
- typeScript
23+
summary: Read feed and retrieves the next page of results in Azure Cosmos DB.
24+
syntax:
25+
content: function executeNext()
26+
parameters: []
27+
return:
28+
type:
29+
- >-
30+
Promise<@azure/cosmos.ChangeFeedResponse<Array<T &
31+
@azure/cosmos.Resource>>>
32+
package: '@azure/cosmos'
33+
- uid: '@azure/cosmos.ChangeFeedIterator.getAsyncIterator'
34+
name: getAsyncIterator()
35+
children: []
36+
type: method
37+
langs:
38+
- typeScript
39+
summary: >-
40+
Gets an async iterator which will yield pages of results from Azure Cosmos
41+
DB.
42+
syntax:
43+
content: function getAsyncIterator()
44+
parameters: []
45+
return:
46+
type:
47+
- >-
48+
AsyncIterable<@azure/cosmos.ChangeFeedResponse<Array<T &
49+
@azure/cosmos.Resource>>>
50+
package: '@azure/cosmos'
51+
- uid: '@azure/cosmos.ChangeFeedIterator.hasMoreResults'
52+
name: hasMoreResults
53+
fullName: hasMoreResults
54+
children: []
55+
langs:
56+
- typeScript
57+
type: property
58+
summary: >
59+
Gets a value indicating whether there are potentially additional results
60+
that can be retrieved.
61+
62+
Initially returns true. This value is set based on whether the last
63+
execution returned a continuation token.
64+
syntax:
65+
content: 'hasMoreResults: boolean'
66+
return:
67+
type:
68+
- boolean
69+
package: '@azure/cosmos'
70+
references:
71+
- uid: >-
72+
Promise<@azure/cosmos.ChangeFeedResponse<Array<T &
73+
@azure/cosmos.Resource>>>
74+
name: Resource>>>
75+
spec.typeScript:
76+
- name: Promise<
77+
fullName: Promise<
78+
- name: ChangeFeedResponse
79+
fullName: ChangeFeedResponse
80+
uid: '@azure/cosmos.ChangeFeedResponse'
81+
- name: '<Array<T & '
82+
fullName: '<Array<T & '
83+
- name: Resource
84+
fullName: Resource
85+
uid: '@azure/cosmos.Resource'
86+
- name: '>>>'
87+
fullName: '>>>'
88+
- uid: >-
89+
AsyncIterable<@azure/cosmos.ChangeFeedResponse<Array<T &
90+
@azure/cosmos.Resource>>>
91+
name: Resource>>>
92+
spec.typeScript:
93+
- name: AsyncIterable<
94+
fullName: AsyncIterable<
95+
- name: ChangeFeedResponse
96+
fullName: ChangeFeedResponse
97+
uid: '@azure/cosmos.ChangeFeedResponse'
98+
- name: '<Array<T & '
99+
fullName: '<Array<T & '
100+
- name: Resource
101+
fullName: Resource
102+
uid: '@azure/cosmos.Resource'
103+
- name: '>>>'
104+
fullName: '>>>'

‎docs-ref-autogen/@azure/cosmos/ChangeFeedOptions.yml

+111
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
### YamlMime:UniversalReference
2+
items:
3+
- uid: '@azure/cosmos.ChangeFeedOptions'
4+
name: ChangeFeedOptions
5+
fullName: ChangeFeedOptions
6+
children:
7+
- '@azure/cosmos.ChangeFeedOptions.continuation'
8+
- '@azure/cosmos.ChangeFeedOptions.maxItemCount'
9+
- '@azure/cosmos.ChangeFeedOptions.sessionToken'
10+
- '@azure/cosmos.ChangeFeedOptions.startFromBeginning'
11+
- '@azure/cosmos.ChangeFeedOptions.startTime'
12+
langs:
13+
- typeScript
14+
type: interface
15+
summary: >
16+
Specifies options for the change feed
17+
18+
Some of these options control where and when to start reading from the
19+
change feed. The order of precedence is:
20+
21+
- continuation
22+
23+
- startTime
24+
25+
- startFromBeginning
26+
27+
28+
If none of those options are set, it will start reading changes from the
29+
first `ChangeFeedIterator.executeNext()` call.
30+
package: '@azure/cosmos'
31+
- uid: '@azure/cosmos.ChangeFeedOptions.continuation'
32+
name: continuation
33+
fullName: continuation
34+
children: []
35+
langs:
36+
- typeScript
37+
type: property
38+
summary: >
39+
The continuation token to start from.
40+
41+
This is equivalent to the etag and continuation value from the
42+
`ChangeFeedResponse`
43+
optional: true
44+
syntax:
45+
content: 'continuation?: string'
46+
return:
47+
type:
48+
- string
49+
package: '@azure/cosmos'
50+
- uid: '@azure/cosmos.ChangeFeedOptions.maxItemCount'
51+
name: maxItemCount
52+
fullName: maxItemCount
53+
children: []
54+
langs:
55+
- typeScript
56+
type: property
57+
summary: Max amount of items to return per page
58+
optional: true
59+
syntax:
60+
content: 'maxItemCount?: number'
61+
return:
62+
type:
63+
- number
64+
package: '@azure/cosmos'
65+
- uid: '@azure/cosmos.ChangeFeedOptions.sessionToken'
66+
name: sessionToken
67+
fullName: sessionToken
68+
children: []
69+
langs:
70+
- typeScript
71+
type: property
72+
summary: >-
73+
The session token to use. If not specified, will use the most recent
74+
captured session token to start with.
75+
optional: true
76+
syntax:
77+
content: 'sessionToken?: string'
78+
return:
79+
type:
80+
- string
81+
package: '@azure/cosmos'
82+
- uid: '@azure/cosmos.ChangeFeedOptions.startFromBeginning'
83+
name: startFromBeginning
84+
fullName: startFromBeginning
85+
children: []
86+
langs:
87+
- typeScript
88+
type: property
89+
summary: Signals whether to start from the beginning or not.
90+
optional: true
91+
syntax:
92+
content: 'startFromBeginning?: boolean'
93+
return:
94+
type:
95+
- boolean
96+
package: '@azure/cosmos'
97+
- uid: '@azure/cosmos.ChangeFeedOptions.startTime'
98+
name: startTime
99+
fullName: startTime
100+
children: []
101+
langs:
102+
- typeScript
103+
type: property
104+
summary: Specified the start time to start reading changes from.
105+
optional: true
106+
syntax:
107+
content: 'startTime?: Date'
108+
return:
109+
type:
110+
- Date
111+
package: '@azure/cosmos'

0 commit comments

Comments
 (0)