/
CosmosClientOptions.yml
186 lines (179 loc) · 5.58 KB
/
CosmosClientOptions.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
### YamlMime:TSType
name: CosmosClientOptions
uid: '@azure/cosmos.CosmosClientOptions'
package: '@azure/cosmos'
summary: ''
fullName: CosmosClientOptions
remarks: ''
isDeprecated: false
type: interface
properties:
- name: aadCredentials
uid: '@azure/cosmos.CosmosClientOptions.aadCredentials'
package: '@azure/cosmos'
summary: >-
AAD token from `@azure/identity`
Obtain a credential object by creating an `@azure/identity` credential
object
We will then use your credential object and a scope URL (your cosmos db
endpoint)
to authenticate requests to Cosmos
fullName: aadCredentials
remarks: ''
isDeprecated: false
syntax:
content: 'aadCredentials?: TokenCredential'
return:
description: ''
type: <xref uid="@azure/core-auth.TokenCredential" />
- name: agent
uid: '@azure/cosmos.CosmosClientOptions.agent'
package: '@azure/cosmos'
summary: >-
An optional custom http(s) Agent to be used in NodeJS enironments
Use an agent such as https://github.com/TooTallNate/node-proxy-agent if
you need to connect to Cosmos via a proxy
fullName: agent
remarks: ''
isDeprecated: false
syntax:
content: 'agent?: Agent'
return:
description: ''
type: <xref uid="@azure/cosmos.Agent" />
- name: connectionPolicy
uid: '@azure/cosmos.CosmosClientOptions.connectionPolicy'
package: '@azure/cosmos'
summary: >-
An instance of [ConnectionPolicy](xref:@azure/cosmos.ConnectionPolicy)
class.
This parameter is optional and the default connectionPolicy will be used
if omitted.
fullName: connectionPolicy
remarks: ''
isDeprecated: false
syntax:
content: 'connectionPolicy?: ConnectionPolicy'
return:
description: ''
type: <xref uid="@azure/cosmos.ConnectionPolicy" />
- name: consistencyLevel
uid: '@azure/cosmos.CosmosClientOptions.consistencyLevel'
package: '@azure/cosmos'
summary: >-
An optional parameter that represents the consistency level.
It can take any value from
[ConsistencyLevel](xref:@azure/cosmos.ConsistencyLevel).
fullName: consistencyLevel
remarks: ''
isDeprecated: false
syntax:
content: >-
consistencyLevel?: "Strong" | "BoundedStaleness" | "Session" |
"Eventual" | "ConsistentPrefix"
return:
description: ''
type: >-
"Strong" | "BoundedStaleness" | "Session" | "Eventual" |
"ConsistentPrefix"
- name: defaultHeaders
uid: '@azure/cosmos.CosmosClientOptions.defaultHeaders'
package: '@azure/cosmos'
summary: ''
fullName: defaultHeaders
remarks: ''
isDeprecated: false
syntax:
content: 'defaultHeaders?: CosmosHeaders_2'
return:
description: ''
type: CosmosHeaders_2
- name: diagnosticLevel
uid: '@azure/cosmos.CosmosClientOptions.diagnosticLevel'
package: '@azure/cosmos'
summary: ''
fullName: diagnosticLevel
remarks: ''
isDeprecated: false
syntax:
content: 'diagnosticLevel?: CosmosDbDiagnosticLevel'
return:
description: ''
type: <xref uid="@azure/cosmos.CosmosDbDiagnosticLevel" />
- name: endpoint
uid: '@azure/cosmos.CosmosClientOptions.endpoint'
package: '@azure/cosmos'
summary: The service endpoint to use to create the client.
fullName: endpoint
remarks: ''
isDeprecated: false
syntax:
content: 'endpoint: string'
return:
description: ''
type: string
- name: key
uid: '@azure/cosmos.CosmosClientOptions.key'
package: '@azure/cosmos'
summary: The account master or readonly key
fullName: key
remarks: ''
isDeprecated: false
syntax:
content: 'key?: string'
return:
description: ''
type: string
- name: permissionFeed
uid: '@azure/cosmos.CosmosClientOptions.permissionFeed'
package: '@azure/cosmos'
summary: An array of [Permission](xref:@azure/cosmos.Permission) objects.
fullName: permissionFeed
remarks: ''
isDeprecated: false
syntax:
content: 'permissionFeed?: PermissionDefinition[]'
return:
description: ''
type: <xref uid="@azure/cosmos.PermissionDefinition" />[]
- name: resourceTokens
uid: '@azure/cosmos.CosmosClientOptions.resourceTokens'
package: '@azure/cosmos'
summary: |-
An object that contains resources tokens.
Keys for the object are resource Ids and values are the resource tokens.
fullName: resourceTokens
remarks: ''
isDeprecated: false
syntax:
content: 'resourceTokens?: {[resourcePath: string]: string}'
return:
description: ''
type: '{[resourcePath: string]: string}'
- name: tokenProvider
uid: '@azure/cosmos.CosmosClientOptions.tokenProvider'
package: '@azure/cosmos'
summary: >-
A user supplied function for resolving header authorization tokens.
Allows users to generating their own auth tokens, potentially using a
separate service
fullName: tokenProvider
remarks: ''
isDeprecated: false
syntax:
content: 'tokenProvider?: TokenProvider'
return:
description: ''
type: <xref uid="@azure/cosmos.TokenProvider" />
- name: userAgentSuffix
uid: '@azure/cosmos.CosmosClientOptions.userAgentSuffix'
package: '@azure/cosmos'
summary: A custom string to append to the default SDK user agent.
fullName: userAgentSuffix
remarks: ''
isDeprecated: false
syntax:
content: 'userAgentSuffix?: string'
return:
description: ''
type: string