-
Notifications
You must be signed in to change notification settings - Fork 40
/
CosmosDbContextOptionsExtensions.xml
295 lines (295 loc) · 30.2 KB
/
CosmosDbContextOptionsExtensions.xml
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
<Type Name="CosmosDbContextOptionsExtensions" FullName="Microsoft.EntityFrameworkCore.CosmosDbContextOptionsExtensions">
<TypeSignature Language="C#" Value="public static class CosmosDbContextOptionsExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit CosmosDbContextOptionsExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.EntityFrameworkCore.CosmosDbContextOptionsExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module CosmosDbContextOptionsExtensions" />
<TypeSignature Language="F#" Value="type CosmosDbContextOptionsExtensions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Cosmos</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Cosmos-specific extension methods for <see cref="T:Microsoft.EntityFrameworkCore.DbContextOptionsBuilder" />.
</summary>
<remarks>
See <see href="https://aka.ms/efcore-docs-dbcontext-options">Using DbContextOptions</see>, and
<see href="https://aka.ms/efcore-docs-cosmos">Accessing Azure Cosmos DB with EF Core</see> for more information and examples.
</remarks>
</Docs>
<Members>
<Member MemberName="UseCosmos">
<MemberSignature Language="C#" Value="public static Microsoft.EntityFrameworkCore.DbContextOptionsBuilder UseCosmos (this Microsoft.EntityFrameworkCore.DbContextOptionsBuilder optionsBuilder, string connectionString, string databaseName, Action<Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder> cosmosOptionsAction = default);" FrameworkAlternate="efcore-5.0" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.EntityFrameworkCore.DbContextOptionsBuilder UseCosmos(class Microsoft.EntityFrameworkCore.DbContextOptionsBuilder optionsBuilder, string connectionString, string databaseName, class System.Action`1<class Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder> cosmosOptionsAction) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.CosmosDbContextOptionsExtensions.UseCosmos(Microsoft.EntityFrameworkCore.DbContextOptionsBuilder,System.String,System.String,System.Action{Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder})" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function UseCosmos (optionsBuilder As DbContextOptionsBuilder, connectionString As String, databaseName As String, Optional cosmosOptionsAction As Action(Of CosmosDbContextOptionsBuilder) = Nothing) As DbContextOptionsBuilder" />
<MemberSignature Language="F#" Value="static member UseCosmos : Microsoft.EntityFrameworkCore.DbContextOptionsBuilder * string * string * Action<Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder> -> Microsoft.EntityFrameworkCore.DbContextOptionsBuilder" Usage="Microsoft.EntityFrameworkCore.CosmosDbContextOptionsExtensions.UseCosmos (optionsBuilder, connectionString, databaseName, cosmosOptionsAction)" />
<MemberSignature Language="C#" Value="public static Microsoft.EntityFrameworkCore.DbContextOptionsBuilder UseCosmos (this Microsoft.EntityFrameworkCore.DbContextOptionsBuilder optionsBuilder, string connectionString, string databaseName, Action<Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder>? cosmosOptionsAction = default);" FrameworkAlternate="efcore-6.0;efcore-7.0;efcore-8.0" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Cosmos</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.DbContextOptionsBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="optionsBuilder" Type="Microsoft.EntityFrameworkCore.DbContextOptionsBuilder" RefType="this" Index="0" FrameworkAlternate="efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
<Parameter Name="connectionString" Type="System.String" Index="1" FrameworkAlternate="efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
<Parameter Name="databaseName" Type="System.String" Index="2" FrameworkAlternate="efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
<Parameter Name="cosmosOptionsAction" Type="System.Action<Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder>" Index="3" FrameworkAlternate="efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
</Parameters>
<Docs>
<param name="optionsBuilder">The builder being used to configure the context.</param>
<param name="connectionString">The connection string of the database to connect to.</param>
<param name="databaseName">The database name.</param>
<param name="cosmosOptionsAction">An optional action to allow additional Cosmos-specific configuration.</param>
<summary>
Configures the context to connect to an Azure Cosmos database.
</summary>
<returns>The options builder so that further configuration can be chained.</returns>
<remarks>
See <see href="https://aka.ms/efcore-docs-dbcontext-options">Using DbContextOptions</see>, and
<see href="https://aka.ms/efcore-docs-cosmos">Accessing Azure Cosmos DB with EF Core</see> for more information and examples.
</remarks>
</Docs>
</Member>
<Member MemberName="UseCosmos">
<MemberSignature Language="C#" Value="public static Microsoft.EntityFrameworkCore.DbContextOptionsBuilder UseCosmos (this Microsoft.EntityFrameworkCore.DbContextOptionsBuilder optionsBuilder, string accountEndpoint, Azure.Core.TokenCredential tokenCredential, string databaseName, Action<Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder>? cosmosOptionsAction = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.EntityFrameworkCore.DbContextOptionsBuilder UseCosmos(class Microsoft.EntityFrameworkCore.DbContextOptionsBuilder optionsBuilder, string accountEndpoint, class Azure.Core.TokenCredential tokenCredential, string databaseName, class System.Action`1<class Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder> cosmosOptionsAction) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.CosmosDbContextOptionsExtensions.UseCosmos(Microsoft.EntityFrameworkCore.DbContextOptionsBuilder,System.String,Azure.Core.TokenCredential,System.String,System.Action{Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder})" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function UseCosmos (optionsBuilder As DbContextOptionsBuilder, accountEndpoint As String, tokenCredential As TokenCredential, databaseName As String, Optional cosmosOptionsAction As Action(Of CosmosDbContextOptionsBuilder) = Nothing) As DbContextOptionsBuilder" />
<MemberSignature Language="F#" Value="static member UseCosmos : Microsoft.EntityFrameworkCore.DbContextOptionsBuilder * string * Azure.Core.TokenCredential * string * Action<Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder> -> Microsoft.EntityFrameworkCore.DbContextOptionsBuilder" Usage="Microsoft.EntityFrameworkCore.CosmosDbContextOptionsExtensions.UseCosmos (optionsBuilder, accountEndpoint, tokenCredential, databaseName, cosmosOptionsAction)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Cosmos</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.DbContextOptionsBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="optionsBuilder" Type="Microsoft.EntityFrameworkCore.DbContextOptionsBuilder" RefType="this" Index="0" FrameworkAlternate="efcore-7.0;efcore-8.0" />
<Parameter Name="accountEndpoint" Type="System.String" Index="1" FrameworkAlternate="efcore-7.0;efcore-8.0" />
<Parameter Name="tokenCredential" Type="Azure.Core.TokenCredential" Index="2" FrameworkAlternate="efcore-7.0;efcore-8.0" />
<Parameter Name="databaseName" Type="System.String" Index="3" FrameworkAlternate="efcore-7.0;efcore-8.0" />
<Parameter Name="cosmosOptionsAction" Type="System.Action<Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder>" Index="4" FrameworkAlternate="efcore-7.0;efcore-8.0" />
</Parameters>
<Docs>
<param name="optionsBuilder">The builder being used to configure the context.</param>
<param name="accountEndpoint">The account end-point to connect to.</param>
<param name="tokenCredential">The Azure authentication token.</param>
<param name="databaseName">The database name.</param>
<param name="cosmosOptionsAction">An optional action to allow additional Cosmos-specific configuration.</param>
<summary>
Configures the context to connect to an Azure Cosmos database.
</summary>
<returns>The options builder so that further configuration can be chained.</returns>
<remarks>
See <see href="https://aka.ms/efcore-docs-dbcontext-options">Using DbContextOptions</see>, and
<see href="https://aka.ms/efcore-docs-cosmos">Accessing Azure Cosmos DB with EF Core</see> for more information and examples.
</remarks>
</Docs>
</Member>
<Member MemberName="UseCosmos">
<MemberSignature Language="C#" Value="public static Microsoft.EntityFrameworkCore.DbContextOptionsBuilder UseCosmos (this Microsoft.EntityFrameworkCore.DbContextOptionsBuilder optionsBuilder, string accountEndpoint, string accountKey, string databaseName, Action<Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder> cosmosOptionsAction = default);" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.EntityFrameworkCore.DbContextOptionsBuilder UseCosmos(class Microsoft.EntityFrameworkCore.DbContextOptionsBuilder optionsBuilder, string accountEndpoint, string accountKey, string databaseName, class System.Action`1<class Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder> cosmosOptionsAction) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.CosmosDbContextOptionsExtensions.UseCosmos(Microsoft.EntityFrameworkCore.DbContextOptionsBuilder,System.String,System.String,System.String,System.Action{Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder})" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function UseCosmos (optionsBuilder As DbContextOptionsBuilder, accountEndpoint As String, accountKey As String, databaseName As String, Optional cosmosOptionsAction As Action(Of CosmosDbContextOptionsBuilder) = Nothing) As DbContextOptionsBuilder" />
<MemberSignature Language="F#" Value="static member UseCosmos : Microsoft.EntityFrameworkCore.DbContextOptionsBuilder * string * string * string * Action<Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder> -> Microsoft.EntityFrameworkCore.DbContextOptionsBuilder" Usage="Microsoft.EntityFrameworkCore.CosmosDbContextOptionsExtensions.UseCosmos (optionsBuilder, accountEndpoint, accountKey, databaseName, cosmosOptionsAction)" />
<MemberSignature Language="C#" Value="public static Microsoft.EntityFrameworkCore.DbContextOptionsBuilder UseCosmos (this Microsoft.EntityFrameworkCore.DbContextOptionsBuilder optionsBuilder, string accountEndpoint, string accountKey, string databaseName, Action<Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder>? cosmosOptionsAction = default);" FrameworkAlternate="efcore-6.0;efcore-7.0;efcore-8.0" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Cosmos</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.DbContextOptionsBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="optionsBuilder" Type="Microsoft.EntityFrameworkCore.DbContextOptionsBuilder" RefType="this" />
<Parameter Name="accountEndpoint" Type="System.String" />
<Parameter Name="accountKey" Type="System.String" />
<Parameter Name="databaseName" Type="System.String" />
<Parameter Name="cosmosOptionsAction" Type="System.Action<Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder>" />
</Parameters>
<Docs>
<param name="optionsBuilder">The builder being used to configure the context.</param>
<param name="accountEndpoint">The account end-point to connect to.</param>
<param name="accountKey">The account key.</param>
<param name="databaseName">The database name.</param>
<param name="cosmosOptionsAction">An optional action to allow additional Cosmos-specific configuration.</param>
<summary>
Configures the context to connect to an Azure Cosmos database.
</summary>
<returns>The options builder so that further configuration can be chained.</returns>
<remarks>
See <see href="https://aka.ms/efcore-docs-dbcontext-options">Using DbContextOptions</see>, and
<see href="https://aka.ms/efcore-docs-cosmos">Accessing Azure Cosmos DB with EF Core</see> for more information and examples.
</remarks>
</Docs>
</Member>
<Member MemberName="UseCosmos<TContext>">
<MemberSignature Language="C#" Value="public static Microsoft.EntityFrameworkCore.DbContextOptionsBuilder<TContext> UseCosmos<TContext> (this Microsoft.EntityFrameworkCore.DbContextOptionsBuilder<TContext> optionsBuilder, string connectionString, string databaseName, Action<Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder> cosmosOptionsAction = default) where TContext : Microsoft.EntityFrameworkCore.DbContext;" FrameworkAlternate="efcore-5.0" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.EntityFrameworkCore.DbContextOptionsBuilder`1<!!TContext> UseCosmos<(class Microsoft.EntityFrameworkCore.DbContext) TContext>(class Microsoft.EntityFrameworkCore.DbContextOptionsBuilder`1<!!TContext> optionsBuilder, string connectionString, string databaseName, class System.Action`1<class Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder> cosmosOptionsAction) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.CosmosDbContextOptionsExtensions.UseCosmos``1(Microsoft.EntityFrameworkCore.DbContextOptionsBuilder{``0},System.String,System.String,System.Action{Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder})" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function UseCosmos(Of TContext As DbContext) (optionsBuilder As DbContextOptionsBuilder(Of TContext), connectionString As String, databaseName As String, Optional cosmosOptionsAction As Action(Of CosmosDbContextOptionsBuilder) = Nothing) As DbContextOptionsBuilder(Of TContext)" />
<MemberSignature Language="F#" Value="static member UseCosmos : Microsoft.EntityFrameworkCore.DbContextOptionsBuilder<'Context (requires 'Context :> Microsoft.EntityFrameworkCore.DbContext)> * string * string * Action<Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder> -> Microsoft.EntityFrameworkCore.DbContextOptionsBuilder<'Context (requires 'Context :> Microsoft.EntityFrameworkCore.DbContext)> (requires 'Context :> Microsoft.EntityFrameworkCore.DbContext)" Usage="Microsoft.EntityFrameworkCore.CosmosDbContextOptionsExtensions.UseCosmos (optionsBuilder, connectionString, databaseName, cosmosOptionsAction)" />
<MemberSignature Language="C#" Value="public static Microsoft.EntityFrameworkCore.DbContextOptionsBuilder<TContext> UseCosmos<TContext> (this Microsoft.EntityFrameworkCore.DbContextOptionsBuilder<TContext> optionsBuilder, string connectionString, string databaseName, Action<Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder>? cosmosOptionsAction = default) where TContext : Microsoft.EntityFrameworkCore.DbContext;" FrameworkAlternate="efcore-6.0;efcore-7.0;efcore-8.0" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Cosmos</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.DbContextOptionsBuilder<TContext></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TContext">
<Constraints>
<BaseTypeName>Microsoft.EntityFrameworkCore.DbContext</BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="optionsBuilder" Type="Microsoft.EntityFrameworkCore.DbContextOptionsBuilder<TContext>" RefType="this" Index="0" FrameworkAlternate="efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
<Parameter Name="connectionString" Type="System.String" Index="1" FrameworkAlternate="efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
<Parameter Name="databaseName" Type="System.String" Index="2" FrameworkAlternate="efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
<Parameter Name="cosmosOptionsAction" Type="System.Action<Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder>" Index="3" FrameworkAlternate="efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
</Parameters>
<Docs>
<typeparam name="TContext">The type of context to be configured.</typeparam>
<param name="optionsBuilder">The builder being used to configure the context.</param>
<param name="connectionString">The connection string of the database to connect to.</param>
<param name="databaseName">The database name.</param>
<param name="cosmosOptionsAction">An optional action to allow additional Cosmos-specific configuration.</param>
<summary>
Configures the context to connect to an Azure Cosmos database.
</summary>
<returns>The options builder so that further configuration can be chained.</returns>
<remarks>
See <see href="https://aka.ms/efcore-docs-dbcontext-options">Using DbContextOptions</see>, and
<see href="https://aka.ms/efcore-docs-cosmos">Accessing Azure Cosmos DB with EF Core</see> for more information and examples.
</remarks>
</Docs>
</Member>
<Member MemberName="UseCosmos<TContext>">
<MemberSignature Language="C#" Value="public static Microsoft.EntityFrameworkCore.DbContextOptionsBuilder<TContext> UseCosmos<TContext> (this Microsoft.EntityFrameworkCore.DbContextOptionsBuilder<TContext> optionsBuilder, string accountEndpoint, Azure.Core.TokenCredential tokenCredential, string databaseName, Action<Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder>? cosmosOptionsAction = default) where TContext : Microsoft.EntityFrameworkCore.DbContext;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.EntityFrameworkCore.DbContextOptionsBuilder`1<!!TContext> UseCosmos<(class Microsoft.EntityFrameworkCore.DbContext) TContext>(class Microsoft.EntityFrameworkCore.DbContextOptionsBuilder`1<!!TContext> optionsBuilder, string accountEndpoint, class Azure.Core.TokenCredential tokenCredential, string databaseName, class System.Action`1<class Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder> cosmosOptionsAction) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.CosmosDbContextOptionsExtensions.UseCosmos``1(Microsoft.EntityFrameworkCore.DbContextOptionsBuilder{``0},System.String,Azure.Core.TokenCredential,System.String,System.Action{Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder})" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function UseCosmos(Of TContext As DbContext) (optionsBuilder As DbContextOptionsBuilder(Of TContext), accountEndpoint As String, tokenCredential As TokenCredential, databaseName As String, Optional cosmosOptionsAction As Action(Of CosmosDbContextOptionsBuilder) = Nothing) As DbContextOptionsBuilder(Of TContext)" />
<MemberSignature Language="F#" Value="static member UseCosmos : Microsoft.EntityFrameworkCore.DbContextOptionsBuilder<'Context (requires 'Context :> Microsoft.EntityFrameworkCore.DbContext)> * string * Azure.Core.TokenCredential * string * Action<Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder> -> Microsoft.EntityFrameworkCore.DbContextOptionsBuilder<'Context (requires 'Context :> Microsoft.EntityFrameworkCore.DbContext)> (requires 'Context :> Microsoft.EntityFrameworkCore.DbContext)" Usage="Microsoft.EntityFrameworkCore.CosmosDbContextOptionsExtensions.UseCosmos (optionsBuilder, accountEndpoint, tokenCredential, databaseName, cosmosOptionsAction)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Cosmos</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.DbContextOptionsBuilder<TContext></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TContext">
<Constraints>
<BaseTypeName>Microsoft.EntityFrameworkCore.DbContext</BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="optionsBuilder" Type="Microsoft.EntityFrameworkCore.DbContextOptionsBuilder<TContext>" RefType="this" Index="0" FrameworkAlternate="efcore-7.0;efcore-8.0" />
<Parameter Name="accountEndpoint" Type="System.String" Index="1" FrameworkAlternate="efcore-7.0;efcore-8.0" />
<Parameter Name="tokenCredential" Type="Azure.Core.TokenCredential" Index="2" FrameworkAlternate="efcore-7.0;efcore-8.0" />
<Parameter Name="databaseName" Type="System.String" Index="3" FrameworkAlternate="efcore-7.0;efcore-8.0" />
<Parameter Name="cosmosOptionsAction" Type="System.Action<Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder>" Index="4" FrameworkAlternate="efcore-7.0;efcore-8.0" />
</Parameters>
<Docs>
<typeparam name="TContext">The type of context to be configured.</typeparam>
<param name="optionsBuilder">The builder being used to configure the context.</param>
<param name="accountEndpoint">The account end-point to connect to.</param>
<param name="tokenCredential">The Azure authentication token.</param>
<param name="databaseName">The database name.</param>
<param name="cosmosOptionsAction">An optional action to allow additional Cosmos-specific configuration.</param>
<summary>
Configures the context to connect to an Azure Cosmos database.
</summary>
<returns>The options builder so that further configuration can be chained.</returns>
<remarks>
See <see href="https://aka.ms/efcore-docs-dbcontext-options">Using DbContextOptions</see>, and
<see href="https://aka.ms/efcore-docs-cosmos">Accessing Azure Cosmos DB with EF Core</see> for more information and examples.
</remarks>
</Docs>
</Member>
<Member MemberName="UseCosmos<TContext>">
<MemberSignature Language="C#" Value="public static Microsoft.EntityFrameworkCore.DbContextOptionsBuilder<TContext> UseCosmos<TContext> (this Microsoft.EntityFrameworkCore.DbContextOptionsBuilder<TContext> optionsBuilder, string accountEndpoint, string accountKey, string databaseName, Action<Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder> cosmosOptionsAction = default) where TContext : Microsoft.EntityFrameworkCore.DbContext;" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.EntityFrameworkCore.DbContextOptionsBuilder`1<!!TContext> UseCosmos<(class Microsoft.EntityFrameworkCore.DbContext) TContext>(class Microsoft.EntityFrameworkCore.DbContextOptionsBuilder`1<!!TContext> optionsBuilder, string accountEndpoint, string accountKey, string databaseName, class System.Action`1<class Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder> cosmosOptionsAction) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.CosmosDbContextOptionsExtensions.UseCosmos``1(Microsoft.EntityFrameworkCore.DbContextOptionsBuilder{``0},System.String,System.String,System.String,System.Action{Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder})" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function UseCosmos(Of TContext As DbContext) (optionsBuilder As DbContextOptionsBuilder(Of TContext), accountEndpoint As String, accountKey As String, databaseName As String, Optional cosmosOptionsAction As Action(Of CosmosDbContextOptionsBuilder) = Nothing) As DbContextOptionsBuilder(Of TContext)" />
<MemberSignature Language="F#" Value="static member UseCosmos : Microsoft.EntityFrameworkCore.DbContextOptionsBuilder<'Context (requires 'Context :> Microsoft.EntityFrameworkCore.DbContext)> * string * string * string * Action<Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder> -> Microsoft.EntityFrameworkCore.DbContextOptionsBuilder<'Context (requires 'Context :> Microsoft.EntityFrameworkCore.DbContext)> (requires 'Context :> Microsoft.EntityFrameworkCore.DbContext)" Usage="Microsoft.EntityFrameworkCore.CosmosDbContextOptionsExtensions.UseCosmos (optionsBuilder, accountEndpoint, accountKey, databaseName, cosmosOptionsAction)" />
<MemberSignature Language="C#" Value="public static Microsoft.EntityFrameworkCore.DbContextOptionsBuilder<TContext> UseCosmos<TContext> (this Microsoft.EntityFrameworkCore.DbContextOptionsBuilder<TContext> optionsBuilder, string accountEndpoint, string accountKey, string databaseName, Action<Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder>? cosmosOptionsAction = default) where TContext : Microsoft.EntityFrameworkCore.DbContext;" FrameworkAlternate="efcore-6.0;efcore-7.0;efcore-8.0" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Cosmos</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.DbContextOptionsBuilder<TContext></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TContext">
<Constraints>
<BaseTypeName>Microsoft.EntityFrameworkCore.DbContext</BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="optionsBuilder" Type="Microsoft.EntityFrameworkCore.DbContextOptionsBuilder<TContext>" RefType="this" />
<Parameter Name="accountEndpoint" Type="System.String" />
<Parameter Name="accountKey" Type="System.String" />
<Parameter Name="databaseName" Type="System.String" />
<Parameter Name="cosmosOptionsAction" Type="System.Action<Microsoft.EntityFrameworkCore.Infrastructure.CosmosDbContextOptionsBuilder>" />
</Parameters>
<Docs>
<typeparam name="TContext">The type of context to be configured.</typeparam>
<param name="optionsBuilder">The builder being used to configure the context.</param>
<param name="accountEndpoint">The account end-point to connect to.</param>
<param name="accountKey">The account key.</param>
<param name="databaseName">The database name.</param>
<param name="cosmosOptionsAction">An optional action to allow additional Cosmos-specific configuration.</param>
<summary>
Configures the context to connect to an Azure Cosmos database.
</summary>
<returns>The options builder so that further configuration can be chained.</returns>
<remarks>
See <see href="https://aka.ms/efcore-docs-dbcontext-options">Using DbContextOptions</see>, and
<see href="https://aka.ms/efcore-docs-cosmos">Accessing Azure Cosmos DB with EF Core</see> for more information and examples.
</remarks>
</Docs>
</Member>
</Members>
</Type>