-
Notifications
You must be signed in to change notification settings - Fork 533
Expand file tree
/
Copy pathAPI_3.59.0.txt
More file actions
1816 lines (1816 loc) · 106 KB
/
API_3.59.0.txt
File metadata and controls
1816 lines (1816 loc) · 106 KB
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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
namespace Microsoft.Azure.Cosmos
{
public class AccountConsistency
{
public AccountConsistency();
public ConsistencyLevel DefaultConsistencyLevel { get; }
public int MaxStalenessIntervalInSeconds { get; }
public int MaxStalenessPrefix { get; }
}
public class AccountProperties
{
public AccountConsistency Consistency { get; }
public string ETag { get; }
public string Id { get; }
public IEnumerable<AccountRegion> ReadableRegions { get; }
public IEnumerable<AccountRegion> WritableRegions { get; }
}
public class AccountRegion
{
public AccountRegion();
public string Endpoint { get; }
public string Name { get; }
}
public abstract class AvailabilityStrategy
{
public static AvailabilityStrategy CrossRegionHedgingStrategy(TimeSpan threshold, Nullable<TimeSpan> thresholdStep, bool enableMultiWriteRegionHedge=false);
public static AvailabilityStrategy DisabledStrategy();
}
public sealed class BoundingBoxProperties
{
public BoundingBoxProperties();
public double Xmax { get; set; }
public double Xmin { get; set; }
public double Ymax { get; set; }
public double Ymin { get; set; }
}
public abstract class ChangeFeedEstimator
{
protected ChangeFeedEstimator();
public abstract FeedIterator<ChangeFeedProcessorState> GetCurrentStateIterator(ChangeFeedEstimatorRequestOptions changeFeedEstimatorRequestOptions=null);
}
public sealed class ChangeFeedEstimatorRequestOptions
{
public ChangeFeedEstimatorRequestOptions();
public Nullable<int> MaxItemCount { get; set; }
}
public class ChangeFeedItem<T>
{
public ChangeFeedItem();
public T Current { get; set; }
public ChangeFeedMetadata Metadata { get; set; }
public T Previous { get; set; }
}
public class ChangeFeedMetadata
{
public ChangeFeedMetadata();
public DateTime ConflictResolutionTimestamp { get; }
public string Id { get; }
public bool IsTimeToLiveExpired { get; }
public long Lsn { get; }
public ChangeFeedOperationType OperationType { get; }
public Dictionary<string, object> PartitionKey { get; }
public long PreviousLsn { get; }
}
public abstract class ChangeFeedMode
{
public static ChangeFeedMode AllVersionsAndDeletes { get; }
public static ChangeFeedMode Incremental { get; }
public static ChangeFeedMode LatestVersion { get; }
}
public enum ChangeFeedOperationType
{
Create = 0,
Delete = 2,
Replace = 1,
}
public sealed class ChangeFeedPolicy
{
public ChangeFeedPolicy();
public static TimeSpan FullFidelityNoRetention { get; }
public TimeSpan FullFidelityRetention { get; set; }
}
public abstract class ChangeFeedProcessor
{
protected ChangeFeedProcessor();
public abstract Task StartAsync();
public abstract Task StopAsync();
}
public class ChangeFeedProcessorBuilder
{
public ChangeFeedProcessor Build();
public ChangeFeedProcessorBuilder WithErrorNotification(Container.ChangeFeedMonitorErrorDelegate errorDelegate);
public virtual ChangeFeedProcessorBuilder WithInMemoryLeaseContainer();
public virtual ChangeFeedProcessorBuilder WithInMemoryLeaseContainer(MemoryStream leaseState);
public ChangeFeedProcessorBuilder WithInstanceName(string instanceName);
public ChangeFeedProcessorBuilder WithLeaseAcquireNotification(Container.ChangeFeedMonitorLeaseAcquireDelegate acquireDelegate);
public ChangeFeedProcessorBuilder WithLeaseConfiguration(Nullable<TimeSpan> acquireInterval=default(Nullable<TimeSpan>), Nullable<TimeSpan> expirationInterval=default(Nullable<TimeSpan>), Nullable<TimeSpan> renewInterval=default(Nullable<TimeSpan>));
public ChangeFeedProcessorBuilder WithLeaseContainer(Container leaseContainer);
public ChangeFeedProcessorBuilder WithLeaseReleaseNotification(Container.ChangeFeedMonitorLeaseReleaseDelegate releaseDelegate);
public ChangeFeedProcessorBuilder WithMaxItems(int maxItemCount);
public ChangeFeedProcessorBuilder WithPollInterval(TimeSpan pollInterval);
public ChangeFeedProcessorBuilder WithStartTime(DateTime startTime);
}
public abstract class ChangeFeedProcessorContext
{
protected ChangeFeedProcessorContext();
public abstract CosmosDiagnostics Diagnostics { get; }
public abstract FeedRange FeedRange { get; }
public abstract Headers Headers { get; }
public abstract string LeaseToken { get; }
}
public sealed class ChangeFeedProcessorState
{
public ChangeFeedProcessorState(string leaseToken, long estimatedLag, string instanceName);
public long EstimatedLag { get; }
public string InstanceName { get; }
public string LeaseToken { get; }
}
public class ChangeFeedProcessorUserException : Exception
{
public ChangeFeedProcessorUserException(Exception originalException, ChangeFeedProcessorContext context);
protected ChangeFeedProcessorUserException(SerializationInfo info, StreamingContext context);
public ChangeFeedProcessorContext ChangeFeedProcessorContext { get; }
public override void GetObjectData(SerializationInfo info, StreamingContext context);
}
public sealed class ChangeFeedRequestOptions : RequestOptions
{
public ChangeFeedRequestOptions();
public new string IfMatchEtag { get; set; }
public new string IfNoneMatchEtag { get; set; }
public Nullable<int> PageSizeHint { get; set; }
}
public abstract class ChangeFeedStartFrom
{
public static ChangeFeedStartFrom Beginning();
public static ChangeFeedStartFrom Beginning(FeedRange feedRange);
public static ChangeFeedStartFrom ContinuationToken(string continuationToken);
public static ChangeFeedStartFrom Now();
public static ChangeFeedStartFrom Now(FeedRange feedRange);
public static ChangeFeedStartFrom Time(DateTime dateTimeUtc);
public static ChangeFeedStartFrom Time(DateTime dateTimeUtc, FeedRange feedRange);
}
public sealed class ClientEncryptionIncludedPath
{
public ClientEncryptionIncludedPath();
public string ClientEncryptionKeyId { get; set; }
public string EncryptionAlgorithm { get; set; }
public string EncryptionType { get; set; }
public string Path { get; set; }
}
public abstract class ClientEncryptionKey
{
protected ClientEncryptionKey();
public abstract string Id { get; }
public abstract Task<ClientEncryptionKeyResponse> ReadAsync(RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ClientEncryptionKeyResponse> ReplaceAsync(ClientEncryptionKeyProperties clientEncryptionKeyProperties, RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
}
public class ClientEncryptionKeyProperties : IEquatable<ClientEncryptionKeyProperties>
{
protected ClientEncryptionKeyProperties();
public ClientEncryptionKeyProperties(string id, string encryptionAlgorithm, byte[] wrappedDataEncryptionKey, EncryptionKeyWrapMetadata encryptionKeyWrapMetadata);
public Nullable<DateTime> CreatedTime { get; }
public string EncryptionAlgorithm { get; }
public EncryptionKeyWrapMetadata EncryptionKeyWrapMetadata { get; }
public string ETag { get; }
public string Id { get; }
public Nullable<DateTime> LastModified { get; }
public virtual string SelfLink { get; }
public byte[] WrappedDataEncryptionKey { get; }
public bool Equals(ClientEncryptionKeyProperties other);
public override bool Equals(object obj);
public override int GetHashCode();
}
public class ClientEncryptionKeyResponse : Response<ClientEncryptionKeyProperties>
{
protected ClientEncryptionKeyResponse();
public override string ActivityId { get; }
public virtual ClientEncryptionKey ClientEncryptionKey { get; }
public override CosmosDiagnostics Diagnostics { get; }
public override string ETag { get; }
public override Headers Headers { get; }
public override double RequestCharge { get; }
public override ClientEncryptionKeyProperties Resource { get; }
public override HttpStatusCode StatusCode { get; }
public static implicit operator ClientEncryptionKey (ClientEncryptionKeyResponse response);
}
public sealed class ClientEncryptionPolicy
{
public ClientEncryptionPolicy(IEnumerable<ClientEncryptionIncludedPath> includedPaths);
public ClientEncryptionPolicy(IEnumerable<ClientEncryptionIncludedPath> includedPaths, int policyFormatVersion);
public IEnumerable<ClientEncryptionIncludedPath> IncludedPaths { get; }
public int PolicyFormatVersion { get; }
}
public sealed class CompositePath
{
public CompositePath();
public CompositePathSortOrder Order { get; set; }
public string Path { get; set; }
}
public enum CompositePathSortOrder
{
Ascending = 0,
Descending = 1,
}
public sealed class ComputedProperty
{
public ComputedProperty();
public string Name { get; set; }
public string Query { get; set; }
}
public class ConflictProperties
{
public ConflictProperties();
public string Id { get; }
public OperationKind OperationKind { get; }
public string SelfLink { get; }
}
public enum ConflictResolutionMode
{
Custom = 1,
LastWriterWins = 0,
}
public class ConflictResolutionPolicy
{
public ConflictResolutionPolicy();
public ConflictResolutionMode Mode { get; set; }
public string ResolutionPath { get; set; }
public string ResolutionProcedure { get; set; }
}
public abstract class Conflicts
{
protected Conflicts();
public abstract Task<ResponseMessage> DeleteAsync(ConflictProperties conflict, PartitionKey partitionKey, CancellationToken cancellationToken=default(CancellationToken));
public abstract FeedIterator<T> GetConflictQueryIterator<T>(QueryDefinition queryDefinition, string continuationToken=null, QueryRequestOptions requestOptions=null);
public abstract FeedIterator<T> GetConflictQueryIterator<T>(string queryText=null, string continuationToken=null, QueryRequestOptions requestOptions=null);
public abstract FeedIterator GetConflictQueryStreamIterator(QueryDefinition queryDefinition, string continuationToken=null, QueryRequestOptions requestOptions=null);
public abstract FeedIterator GetConflictQueryStreamIterator(string queryText=null, string continuationToken=null, QueryRequestOptions requestOptions=null);
public abstract T ReadConflictContent<T>(ConflictProperties conflict);
public abstract Task<ItemResponse<T>> ReadCurrentAsync<T>(ConflictProperties conflict, PartitionKey partitionKey, CancellationToken cancellationToken=default(CancellationToken));
}
public enum ConnectionMode
{
Direct = 1,
Gateway = 0,
}
public enum ConsistencyLevel
{
BoundedStaleness = 1,
ConsistentPrefix = 4,
Eventual = 3,
Session = 2,
Strong = 0,
}
public abstract class Container
{
protected Container();
public abstract Conflicts Conflicts { get; }
public abstract Database Database { get; }
public abstract string Id { get; }
public abstract Scripts Scripts { get; }
public abstract Task<ItemResponse<T>> CreateItemAsync<T>(T item, Nullable<PartitionKey> partitionKey=default(Nullable<PartitionKey>), ItemRequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ResponseMessage> CreateItemStreamAsync(Stream streamPayload, PartitionKey partitionKey, ItemRequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract TransactionalBatch CreateTransactionalBatch(PartitionKey partitionKey);
public virtual Task<ResponseMessage> DeleteAllItemsByPartitionKeyStreamAsync(PartitionKey partitionKey, RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ContainerResponse> DeleteContainerAsync(ContainerRequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ResponseMessage> DeleteContainerStreamAsync(ContainerRequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ItemResponse<T>> DeleteItemAsync<T>(string id, PartitionKey partitionKey, ItemRequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ResponseMessage> DeleteItemStreamAsync(string id, PartitionKey partitionKey, ItemRequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract ChangeFeedEstimator GetChangeFeedEstimator(string processorName, Container leaseContainer);
public abstract ChangeFeedProcessorBuilder GetChangeFeedEstimatorBuilder(string processorName, Container.ChangesEstimationHandler estimationDelegate, Nullable<TimeSpan> estimationPeriod=default(Nullable<TimeSpan>));
public abstract FeedIterator<T> GetChangeFeedIterator<T>(ChangeFeedStartFrom changeFeedStartFrom, ChangeFeedMode changeFeedMode, ChangeFeedRequestOptions changeFeedRequestOptions=null);
public abstract ChangeFeedProcessorBuilder GetChangeFeedProcessorBuilder(string processorName, Container.ChangeFeedStreamHandler onChangesDelegate);
public abstract ChangeFeedProcessorBuilder GetChangeFeedProcessorBuilderWithAllVersionsAndDeletes<T>(string processorName, Container.ChangeFeedHandler<ChangeFeedItem<T>> onChangesDelegate);
public abstract ChangeFeedProcessorBuilder GetChangeFeedProcessorBuilderWithManualCheckpoint(string processorName, Container.ChangeFeedStreamHandlerWithManualCheckpoint onChangesDelegate);
public abstract ChangeFeedProcessorBuilder GetChangeFeedProcessorBuilderWithManualCheckpoint<T>(string processorName, Container.ChangeFeedHandlerWithManualCheckpoint<T> onChangesDelegate);
public abstract ChangeFeedProcessorBuilder GetChangeFeedProcessorBuilder<T>(string processorName, Container.ChangeFeedHandler<T> onChangesDelegate);
public abstract ChangeFeedProcessorBuilder GetChangeFeedProcessorBuilder<T>(string processorName, Container.ChangesHandler<T> onChangesDelegate);
public abstract FeedIterator GetChangeFeedStreamIterator(ChangeFeedStartFrom changeFeedStartFrom, ChangeFeedMode changeFeedMode, ChangeFeedRequestOptions changeFeedRequestOptions=null);
public abstract Task<IReadOnlyList<FeedRange>> GetFeedRangesAsync(CancellationToken cancellationToken=default(CancellationToken));
public abstract IOrderedQueryable<T> GetItemLinqQueryable<T>(bool allowSynchronousQueryExecution=false, string continuationToken=null, QueryRequestOptions requestOptions=null, CosmosLinqSerializerOptions linqSerializerOptions=null);
public abstract FeedIterator<T> GetItemQueryIterator<T>(FeedRange feedRange, QueryDefinition queryDefinition, string continuationToken=null, QueryRequestOptions requestOptions=null);
public abstract FeedIterator<T> GetItemQueryIterator<T>(QueryDefinition queryDefinition, string continuationToken=null, QueryRequestOptions requestOptions=null);
public abstract FeedIterator<T> GetItemQueryIterator<T>(string queryText=null, string continuationToken=null, QueryRequestOptions requestOptions=null);
public abstract FeedIterator GetItemQueryStreamIterator(FeedRange feedRange, QueryDefinition queryDefinition, string continuationToken, QueryRequestOptions requestOptions=null);
public abstract FeedIterator GetItemQueryStreamIterator(QueryDefinition queryDefinition, string continuationToken=null, QueryRequestOptions requestOptions=null);
public abstract FeedIterator GetItemQueryStreamIterator(string queryText=null, string continuationToken=null, QueryRequestOptions requestOptions=null);
public abstract Task<ItemResponse<T>> PatchItemAsync<T>(string id, PartitionKey partitionKey, IReadOnlyList<PatchOperation> patchOperations, PatchItemRequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ResponseMessage> PatchItemStreamAsync(string id, PartitionKey partitionKey, IReadOnlyList<PatchOperation> patchOperations, PatchItemRequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ContainerResponse> ReadContainerAsync(ContainerRequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ResponseMessage> ReadContainerStreamAsync(ContainerRequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ItemResponse<T>> ReadItemAsync<T>(string id, PartitionKey partitionKey, ItemRequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ResponseMessage> ReadItemStreamAsync(string id, PartitionKey partitionKey, ItemRequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<FeedResponse<T>> ReadManyItemsAsync<T>(IReadOnlyList<ValueTuple<string, PartitionKey>> items, ReadManyRequestOptions readManyRequestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ResponseMessage> ReadManyItemsStreamAsync(IReadOnlyList<ValueTuple<string, PartitionKey>> items, ReadManyRequestOptions readManyRequestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ThroughputResponse> ReadThroughputAsync(RequestOptions requestOptions, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<Nullable<int>> ReadThroughputAsync(CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ContainerResponse> ReplaceContainerAsync(ContainerProperties containerProperties, ContainerRequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ResponseMessage> ReplaceContainerStreamAsync(ContainerProperties containerProperties, ContainerRequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ItemResponse<T>> ReplaceItemAsync<T>(T item, string id, Nullable<PartitionKey> partitionKey=default(Nullable<PartitionKey>), ItemRequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ResponseMessage> ReplaceItemStreamAsync(Stream streamPayload, string id, PartitionKey partitionKey, ItemRequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ThroughputResponse> ReplaceThroughputAsync(ThroughputProperties throughputProperties, RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ThroughputResponse> ReplaceThroughputAsync(int throughput, RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ItemResponse<T>> UpsertItemAsync<T>(T item, Nullable<PartitionKey> partitionKey=default(Nullable<PartitionKey>), ItemRequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ResponseMessage> UpsertItemStreamAsync(Stream streamPayload, PartitionKey partitionKey, ItemRequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public delegate Task ChangeFeedHandlerWithManualCheckpoint<T>(ChangeFeedProcessorContext context, IReadOnlyCollection<T> changes, Func<Task> checkpointAsync, CancellationToken cancellationToken);
public delegate Task ChangeFeedHandler<T>(ChangeFeedProcessorContext context, IReadOnlyCollection<T> changes, CancellationToken cancellationToken);
public delegate Task ChangeFeedMonitorErrorDelegate(string leaseToken, Exception exception);
public delegate Task ChangeFeedMonitorLeaseAcquireDelegate(string leaseToken);
public delegate Task ChangeFeedMonitorLeaseReleaseDelegate(string leaseToken);
public delegate Task ChangeFeedStreamHandler(ChangeFeedProcessorContext context, Stream changes, CancellationToken cancellationToken);
public delegate Task ChangeFeedStreamHandlerWithManualCheckpoint(ChangeFeedProcessorContext context, Stream changes, Func<Task> checkpointAsync, CancellationToken cancellationToken);
public delegate Task ChangesEstimationHandler(long estimatedPendingChanges, CancellationToken cancellationToken);
public delegate Task ChangesHandler<T>(IReadOnlyCollection<T> changes, CancellationToken cancellationToken);
}
public class ContainerProperties
{
public ContainerProperties();
public ContainerProperties(string id, IReadOnlyList<string> partitionKeyPaths);
public ContainerProperties(string id, string partitionKeyPath);
public Nullable<int> AnalyticalStoreTimeToLiveInSeconds { get; set; }
public ChangeFeedPolicy ChangeFeedPolicy { get; set; }
public ClientEncryptionPolicy ClientEncryptionPolicy { get; set; }
public Collection<ComputedProperty> ComputedProperties { get; set; }
public ConflictResolutionPolicy ConflictResolutionPolicy { get; set; }
public Nullable<int> DefaultTimeToLive { get; set; }
public string ETag { get; }
public FullTextPolicy FullTextPolicy { get; set; }
public GeospatialConfig GeospatialConfig { get; set; }
public string Id { get; set; }
public IndexingPolicy IndexingPolicy { get; set; }
public Nullable<DateTime> LastModified { get; }
public Nullable<PartitionKeyDefinitionVersion> PartitionKeyDefinitionVersion { get; set; }
public string PartitionKeyPath { get; set; }
public IReadOnlyList<string> PartitionKeyPaths { get; set; }
public string SelfLink { get; }
public string TimeToLivePropertyPath { get; set; }
public UniqueKeyPolicy UniqueKeyPolicy { get; set; }
public VectorEmbeddingPolicy VectorEmbeddingPolicy { get; set; }
}
public class ContainerRequestOptions : RequestOptions
{
public ContainerRequestOptions();
public bool PopulateQuotaInfo { get; set; }
}
public class ContainerResponse : Response<ContainerProperties>
{
protected ContainerResponse();
public override string ActivityId { get; }
public virtual Container Container { get; }
public override CosmosDiagnostics Diagnostics { get; }
public override string ETag { get; }
public override Headers Headers { get; }
public override double RequestCharge { get; }
public override ContainerProperties Resource { get; }
public override HttpStatusCode StatusCode { get; }
public static implicit operator Container (ContainerResponse response);
}
public class CosmosClient : IDisposable
{
protected CosmosClient();
public CosmosClient(string accountEndpoint, AzureKeyCredential authKeyOrResourceTokenCredential, CosmosClientOptions clientOptions=null);
public CosmosClient(string accountEndpoint, TokenCredential tokenCredential, CosmosClientOptions clientOptions=null);
public CosmosClient(string connectionString, CosmosClientOptions clientOptions=null);
public CosmosClient(string accountEndpoint, string authKeyOrResourceToken, CosmosClientOptions clientOptions=null);
public virtual CosmosClientOptions ClientOptions { get; }
public virtual Uri Endpoint { get; }
public virtual CosmosResponseFactory ResponseFactory { get; }
public static Task<CosmosClient> CreateAndInitializeAsync(string accountEndpoint, AzureKeyCredential authKeyOrResourceTokenCredential, IReadOnlyList<ValueTuple<string, string>> containers, CosmosClientOptions cosmosClientOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public static Task<CosmosClient> CreateAndInitializeAsync(string accountEndpoint, TokenCredential tokenCredential, IReadOnlyList<ValueTuple<string, string>> containers, CosmosClientOptions cosmosClientOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public static Task<CosmosClient> CreateAndInitializeAsync(string connectionString, IReadOnlyList<ValueTuple<string, string>> containers, CosmosClientOptions cosmosClientOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public static Task<CosmosClient> CreateAndInitializeAsync(string accountEndpoint, string authKeyOrResourceToken, IReadOnlyList<ValueTuple<string, string>> containers, CosmosClientOptions cosmosClientOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public virtual Task<DatabaseResponse> CreateDatabaseAsync(string id, ThroughputProperties throughputProperties, RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public virtual Task<DatabaseResponse> CreateDatabaseAsync(string id, Nullable<int> throughput=default(Nullable<int>), RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public virtual Task<DatabaseResponse> CreateDatabaseIfNotExistsAsync(string id, ThroughputProperties throughputProperties, RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public virtual Task<DatabaseResponse> CreateDatabaseIfNotExistsAsync(string id, Nullable<int> throughput=default(Nullable<int>), RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public virtual Task<ResponseMessage> CreateDatabaseStreamAsync(DatabaseProperties databaseProperties, Nullable<int> throughput=default(Nullable<int>), RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public void Dispose();
protected virtual void Dispose(bool disposing);
public virtual Container GetContainer(string databaseId, string containerId);
public virtual Database GetDatabase(string id);
public virtual FeedIterator<T> GetDatabaseQueryIterator<T>(QueryDefinition queryDefinition, string continuationToken=null, QueryRequestOptions requestOptions=null);
public virtual FeedIterator<T> GetDatabaseQueryIterator<T>(string queryText=null, string continuationToken=null, QueryRequestOptions requestOptions=null);
public virtual FeedIterator GetDatabaseQueryStreamIterator(QueryDefinition queryDefinition, string continuationToken=null, QueryRequestOptions requestOptions=null);
public virtual FeedIterator GetDatabaseQueryStreamIterator(string queryText=null, string continuationToken=null, QueryRequestOptions requestOptions=null);
public virtual Task<AccountProperties> ReadAccountAsync();
}
public class CosmosClientOptions
{
public CosmosClientOptions();
public IEnumerable<Uri> AccountInitializationCustomEndpoints { get; set; }
public bool AllowBulkExecution { get; set; }
public string ApplicationName { get; set; }
public IReadOnlyList<string> ApplicationPreferredRegions { get; set; }
public string ApplicationRegion { get; set; }
public AvailabilityStrategy AvailabilityStrategy { get; set; }
public ConnectionMode ConnectionMode { get; set; }
public Nullable<ConsistencyLevel> ConsistencyLevel { get; set; }
public CosmosClientTelemetryOptions CosmosClientTelemetryOptions { get; set; }
public Collection<RequestHandler> CustomHandlers { get; }
public Nullable<bool> EnableContentResponseOnWrite { get; set; }
public bool EnableTcpConnectionEndpointRediscovery { get; set; }
public IFaultInjector FaultInjector { get; set; }
public int GatewayModeMaxConnectionLimit { get; set; }
public Func<HttpClient> HttpClientFactory { get; set; }
public Nullable<TimeSpan> IdleTcpConnectionTimeout { get; set; }
public bool LimitToEndpoint { get; set; }
public Nullable<int> MaxRequestsPerTcpConnection { get; set; }
public Nullable<int> MaxRetryAttemptsOnRateLimitedRequests { get; set; }
public Nullable<TimeSpan> MaxRetryWaitTimeOnRateLimitedRequests { get; set; }
public Nullable<int> MaxTcpConnectionsPerEndpoint { get; set; }
public Nullable<TimeSpan> OpenTcpConnectionTimeout { get; set; }
public Nullable<PortReuseMode> PortReuseMode { get; set; }
public Nullable<PriorityLevel> PriorityLevel { get; set; }
public TimeSpan RequestTimeout { get; set; }
public CosmosSerializer Serializer { get; set; }
public CosmosSerializationOptions SerializerOptions { get; set; }
public Func<X509Certificate2, X509Chain, SslPolicyErrors, bool> ServerCertificateCustomValidationCallback { get; set; }
public Nullable<TimeSpan> TokenCredentialBackgroundRefreshInterval { get; set; }
public JsonSerializerOptions UseSystemTextJsonSerializerWithOptions { get; set; }
public IWebProxy WebProxy { get; set; }
}
public class CosmosClientTelemetryOptions
{
public CosmosClientTelemetryOptions();
public CosmosThresholdOptions CosmosThresholdOptions { get; set; }
public bool DisableDistributedTracing { get; set; }
public bool DisableSendingMetricsToService { get; set; }
public QueryTextMode QueryTextMode { get; set; }
}
public abstract class CosmosDiagnostics
{
protected CosmosDiagnostics();
public virtual TimeSpan GetClientElapsedTime();
public abstract IReadOnlyList<ValueTuple<string, Uri>> GetContactedRegions();
public virtual int GetFailedRequestCount();
public virtual ServerSideCumulativeMetrics GetQueryMetrics();
public virtual Nullable<DateTime> GetStartTimeUtc();
public abstract override string ToString();
}
public class CosmosException : Exception, ICloneable
{
public CosmosException(string message, HttpStatusCode statusCode, int subStatusCode, string activityId, double requestCharge);
public virtual string ActivityId { get; }
public virtual CosmosDiagnostics Diagnostics { get; }
public virtual Headers Headers { get; }
public override string Message { get; }
public virtual double RequestCharge { get; }
public virtual string ResponseBody { get; }
public virtual Nullable<TimeSpan> RetryAfter { get; }
public override string StackTrace { get; }
public virtual HttpStatusCode StatusCode { get; }
public virtual int SubStatusCode { get; }
public object Clone();
public override string ToString();
public virtual bool TryGetHeader(string headerName, out string value);
}
public abstract class CosmosLinqSerializer : CosmosSerializer
{
protected CosmosLinqSerializer();
public abstract string SerializeMemberName(MemberInfo memberInfo);
}
public sealed class CosmosLinqSerializerOptions
{
public CosmosLinqSerializerOptions();
public CosmosPropertyNamingPolicy PropertyNamingPolicy { get; set; }
}
public class CosmosOperationCanceledException : OperationCanceledException, ICloneable
{
public CosmosOperationCanceledException(OperationCanceledException originalException, CosmosDiagnostics diagnostics);
protected CosmosOperationCanceledException(SerializationInfo info, StreamingContext context);
public override IDictionary Data { get; }
public CosmosDiagnostics Diagnostics { get; }
public override string HelpLink { get; set; }
public override string Message { get; }
public override string Source { get; set; }
public override string StackTrace { get; }
public object Clone();
public override Exception GetBaseException();
public override void GetObjectData(SerializationInfo info, StreamingContext context);
public override string ToString();
}
public enum CosmosPropertyNamingPolicy
{
CamelCase = 1,
Default = 0,
}
public abstract class CosmosResponseFactory
{
protected CosmosResponseFactory();
public abstract FeedResponse<T> CreateItemFeedResponse<T>(ResponseMessage responseMessage);
public abstract ItemResponse<T> CreateItemResponse<T>(ResponseMessage responseMessage);
public abstract StoredProcedureExecuteResponse<T> CreateStoredProcedureExecuteResponse<T>(ResponseMessage responseMessage);
}
public sealed class CosmosSerializationOptions
{
public CosmosSerializationOptions();
public bool IgnoreNullValues { get; set; }
public bool Indented { get; set; }
public CosmosPropertyNamingPolicy PropertyNamingPolicy { get; set; }
}
public abstract class CosmosSerializer
{
protected CosmosSerializer();
public abstract T FromStream<T>(Stream stream);
public abstract Stream ToStream<T>(T input);
}
public class CosmosThresholdOptions
{
public CosmosThresholdOptions();
public TimeSpan NonPointOperationLatencyThreshold { get; set; }
public Nullable<int> PayloadSizeThresholdInBytes { get; set; }
public TimeSpan PointOperationLatencyThreshold { get; set; }
public Nullable<double> RequestChargeThreshold { get; set; }
}
public abstract class Database
{
protected Database();
public abstract CosmosClient Client { get; }
public abstract string Id { get; }
public abstract Task<ClientEncryptionKeyResponse> CreateClientEncryptionKeyAsync(ClientEncryptionKeyProperties clientEncryptionKeyProperties, RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ContainerResponse> CreateContainerAsync(ContainerProperties containerProperties, ThroughputProperties throughputProperties, RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ContainerResponse> CreateContainerAsync(ContainerProperties containerProperties, Nullable<int> throughput=default(Nullable<int>), RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ContainerResponse> CreateContainerAsync(string id, string partitionKeyPath, Nullable<int> throughput=default(Nullable<int>), RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ContainerResponse> CreateContainerIfNotExistsAsync(ContainerProperties containerProperties, ThroughputProperties throughputProperties, RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ContainerResponse> CreateContainerIfNotExistsAsync(ContainerProperties containerProperties, Nullable<int> throughput=default(Nullable<int>), RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ContainerResponse> CreateContainerIfNotExistsAsync(string id, string partitionKeyPath, Nullable<int> throughput=default(Nullable<int>), RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ResponseMessage> CreateContainerStreamAsync(ContainerProperties containerProperties, ThroughputProperties throughputProperties, RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ResponseMessage> CreateContainerStreamAsync(ContainerProperties containerProperties, Nullable<int> throughput=default(Nullable<int>), RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<UserResponse> CreateUserAsync(string id, RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract ContainerBuilder DefineContainer(string name, string partitionKeyPath);
public abstract Task<DatabaseResponse> DeleteAsync(RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ResponseMessage> DeleteStreamAsync(RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract ClientEncryptionKey GetClientEncryptionKey(string id);
public abstract FeedIterator<ClientEncryptionKeyProperties> GetClientEncryptionKeyQueryIterator(QueryDefinition queryDefinition, string continuationToken=null, QueryRequestOptions requestOptions=null);
public abstract Container GetContainer(string id);
public abstract FeedIterator<T> GetContainerQueryIterator<T>(QueryDefinition queryDefinition, string continuationToken=null, QueryRequestOptions requestOptions=null);
public abstract FeedIterator<T> GetContainerQueryIterator<T>(string queryText=null, string continuationToken=null, QueryRequestOptions requestOptions=null);
public abstract FeedIterator GetContainerQueryStreamIterator(QueryDefinition queryDefinition, string continuationToken=null, QueryRequestOptions requestOptions=null);
public abstract FeedIterator GetContainerQueryStreamIterator(string queryText=null, string continuationToken=null, QueryRequestOptions requestOptions=null);
public abstract User GetUser(string id);
public abstract FeedIterator<T> GetUserQueryIterator<T>(QueryDefinition queryDefinition, string continuationToken=null, QueryRequestOptions requestOptions=null);
public abstract FeedIterator<T> GetUserQueryIterator<T>(string queryText=null, string continuationToken=null, QueryRequestOptions requestOptions=null);
public abstract Task<DatabaseResponse> ReadAsync(RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ResponseMessage> ReadStreamAsync(RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ThroughputResponse> ReadThroughputAsync(RequestOptions requestOptions, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<Nullable<int>> ReadThroughputAsync(CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ThroughputResponse> ReplaceThroughputAsync(ThroughputProperties throughputProperties, RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<ThroughputResponse> ReplaceThroughputAsync(int throughput, RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<UserResponse> UpsertUserAsync(string id, RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
}
public class DatabaseProperties
{
public DatabaseProperties();
public DatabaseProperties(string id);
public string ETag { get; }
public string Id { get; set; }
public Nullable<DateTime> LastModified { get; }
public string SelfLink { get; }
}
public class DatabaseResponse : Response<DatabaseProperties>
{
protected DatabaseResponse();
public override string ActivityId { get; }
public virtual Database Database { get; }
public override CosmosDiagnostics Diagnostics { get; }
public override string ETag { get; }
public override Headers Headers { get; }
public override double RequestCharge { get; }
public override DatabaseProperties Resource { get; }
public override HttpStatusCode StatusCode { get; }
public static implicit operator Database (DatabaseResponse response);
}
public enum DataType
{
LineString = 3,
MultiPolygon = 5,
Number = 0,
Point = 2,
Polygon = 4,
String = 1,
}
public class DedicatedGatewayRequestOptions
{
public DedicatedGatewayRequestOptions();
public Nullable<bool> BypassIntegratedCache { get; set; }
public Nullable<TimeSpan> MaxIntegratedCacheStaleness { get; set; }
}
public enum DistanceFunction
{
Cosine = 1,
DotProduct = 2,
Euclidean = 0,
}
public class Embedding : IEquatable<Embedding>
{
public Embedding();
public VectorDataType DataType { get; set; }
public int Dimensions { get; set; }
public DistanceFunction DistanceFunction { get; set; }
public string Path { get; set; }
public bool Equals(Embedding that);
public void ValidateEmbeddingPath();
}
public class EncryptionKeyWrapMetadata : IEquatable<EncryptionKeyWrapMetadata>
{
public EncryptionKeyWrapMetadata(EncryptionKeyWrapMetadata source);
public EncryptionKeyWrapMetadata(string type, string name, string value, string algorithm);
public string Algorithm { get; }
public string Name { get; }
public string Type { get; }
public string Value { get; }
public bool Equals(EncryptionKeyWrapMetadata other);
public override bool Equals(object obj);
public override int GetHashCode();
}
public sealed class ExcludedPath
{
public ExcludedPath();
public string Path { get; set; }
}
public abstract class FeedIterator : IDisposable
{
protected FeedIterator();
public abstract bool HasMoreResults { get; }
public void Dispose();
protected virtual void Dispose(bool disposing);
public abstract Task<ResponseMessage> ReadNextAsync(CancellationToken cancellationToken=default(CancellationToken));
}
public abstract class FeedIterator<T> : IDisposable
{
protected FeedIterator();
public abstract bool HasMoreResults { get; }
public void Dispose();
protected virtual void Dispose(bool disposing);
public abstract Task<FeedResponse<T>> ReadNextAsync(CancellationToken cancellationToken=default(CancellationToken));
}
public abstract class FeedRange
{
protected FeedRange();
public static FeedRange FromJsonString(string toStringValue);
public static FeedRange FromPartitionKey(PartitionKey partitionKey);
public abstract string ToJsonString();
}
public abstract class FeedResponse<T> : IEnumerable, IEnumerable<T>
{
protected FeedResponse();
public override string ActivityId { get; }
public abstract string ContinuationToken { get; }
public abstract int Count { get; }
public override string ETag { get; }
public abstract string IndexMetrics { get; }
public virtual string QueryAdvice { get; }
public override double RequestCharge { get; }
public abstract IEnumerator<T> GetEnumerator();
IEnumerator System.Collections.IEnumerable.GetEnumerator();
}
public sealed class FullTextIndexPath
{
public FullTextIndexPath();
public string Path { get; set; }
}
public class FullTextPath : IEquatable<FullTextPath>
{
public FullTextPath();
public string Language { get; set; }
public string Path { get; set; }
public bool Equals(FullTextPath that);
public void ValidateFullTextPath();
}
public sealed class FullTextPolicy
{
public FullTextPolicy();
public string DefaultLanguage { get; set; }
public Collection<FullTextPath> FullTextPaths { get; set; }
}
public enum FullTextScoreScope
{
Global = 0,
Local = 1,
}
public sealed class GeospatialConfig
{
public GeospatialConfig();
public GeospatialConfig(GeospatialType geospatialType);
public GeospatialType GeospatialType { get; set; }
}
public enum GeospatialType
{
Geography = 0,
Geometry = 1,
}
public class Headers : IEnumerable
{
public Headers();
public virtual string ActivityId { get; }
public virtual string ContentLength { get; set; }
public virtual string ContentType { get; }
public virtual string ContinuationToken { get; }
public virtual string ETag { get; }
public virtual string this[string headerName] { get; set; }
public virtual string Location { get; }
public virtual double RequestCharge { get; }
public virtual string Session { get; }
public virtual void Add(string headerName, IEnumerable<string> values);
public virtual void Add(string headerName, string value);
public virtual string[] AllKeys();
public virtual string Get(string headerName);
public virtual IEnumerator<string> GetEnumerator();
public virtual T GetHeaderValue<T>(string headerName);
public virtual string GetValueOrDefault(string headerName);
public virtual void Remove(string headerName);
public virtual void Set(string headerName, string value);
IEnumerator System.Collections.IEnumerable.GetEnumerator();
public virtual bool TryGetValue(string headerName, out string value);
}
public sealed class IncludedPath
{
public IncludedPath();
public string Path { get; set; }
}
public enum IndexingDirective
{
Default = 0,
Exclude = 2,
Include = 1,
}
public enum IndexingMode
{
Consistent = 0,
Lazy = 1,
None = 2,
}
public sealed class IndexingPolicy
{
public IndexingPolicy();
public bool Automatic { get; set; }
public Collection<Collection<CompositePath>> CompositeIndexes { get; }
public Collection<ExcludedPath> ExcludedPaths { get; }
public Collection<FullTextIndexPath> FullTextIndexes { get; set; }
public Collection<IncludedPath> IncludedPaths { get; }
public IndexingMode IndexingMode { get; set; }
public Collection<SpatialPath> SpatialIndexes { get; }
public Collection<VectorIndexPath> VectorIndexes { get; set; }
}
public enum IndexKind
{
Hash = 0,
Range = 1,
Spatial = 2,
}
public class ItemRequestOptions : RequestOptions
{
public ItemRequestOptions();
public Nullable<ConsistencyLevel> ConsistencyLevel { get; set; }
public DedicatedGatewayRequestOptions DedicatedGatewayRequestOptions { get; set; }
public Nullable<bool> EnableContentResponseOnWrite { get; set; }
public Nullable<IndexingDirective> IndexingDirective { get; set; }
public IEnumerable<string> PostTriggers { get; set; }
public IEnumerable<string> PreTriggers { get; set; }
public string SessionToken { get; set; }
}
public class ItemResponse<T> : Response<T>
{
protected ItemResponse();
public override string ActivityId { get; }
public override CosmosDiagnostics Diagnostics { get; }
public override string ETag { get; }
public override Headers Headers { get; }
public override double RequestCharge { get; }
public override T Resource { get; }
public override HttpStatusCode StatusCode { get; }
}
public enum OperationKind
{
Create = 1,
Delete = 3,
Invalid = 0,
Read = 4,
Replace = 2,
}
public struct PartitionKey : IEquatable<PartitionKey>
{
public static readonly PartitionKey None;
public static readonly PartitionKey Null;
public static readonly string SystemKeyName;
public static readonly string SystemKeyPath;
public PartitionKey(bool partitionKeyValue);
public PartitionKey(double partitionKeyValue);
public PartitionKey(string partitionKeyValue);
public bool Equals(PartitionKey other);
public override bool Equals(object obj);
public override int GetHashCode();
public static bool operator ==(PartitionKey left, PartitionKey right);
public static bool operator !=(PartitionKey left, PartitionKey right);
public override string ToString();
}
public sealed class PartitionKeyBuilder
{
public PartitionKeyBuilder();
public PartitionKeyBuilder Add(bool val);
public PartitionKeyBuilder Add(double val);
public PartitionKeyBuilder Add(string val);
public PartitionKeyBuilder AddNoneType();
public PartitionKeyBuilder AddNullValue();
public PartitionKey Build();
}
public enum PartitionKeyDefinitionVersion
{
V1 = 1,
V2 = 2,
}
public sealed class PatchItemRequestOptions : ItemRequestOptions
{
public PatchItemRequestOptions();
public string FilterPredicate { get; set; }
}
public abstract class PatchOperation
{
protected PatchOperation();
public virtual string From { get; set; }
public abstract PatchOperationType OperationType { get; }
public abstract string Path { get; }
public static PatchOperation Add<T>(string path, T value);
public static PatchOperation Increment(string path, double value);
public static PatchOperation Increment(string path, long value);
public static PatchOperation Move(string from, string path);
public static PatchOperation Remove(string path);
public static PatchOperation Replace<T>(string path, T value);
public static PatchOperation Set<T>(string path, T value);
public virtual bool TrySerializeValueParameter(CosmosSerializer cosmosSerializer, out Stream valueParam);
}
public enum PatchOperationType
{
Add = 0,
Increment = 4,
Move = 5,
Remove = 1,
Replace = 2,
Set = 3,
}
public abstract class PatchOperation<T> : PatchOperation
{
protected PatchOperation();
public abstract T Value { get; }
}
public abstract class Permission
{
protected Permission();
public abstract string Id { get; }
public abstract Task<PermissionResponse> DeleteAsync(RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<PermissionResponse> ReadAsync(Nullable<int> tokenExpiryInSeconds=default(Nullable<int>), RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
public abstract Task<PermissionResponse> ReplaceAsync(PermissionProperties permissionProperties, Nullable<int> tokenExpiryInSeconds=default(Nullable<int>), RequestOptions requestOptions=null, CancellationToken cancellationToken=default(CancellationToken));
}
public enum PermissionMode : byte
{
All = (byte)2,
Read = (byte)1,
}
public class PermissionProperties
{
public PermissionProperties(string id, PermissionMode permissionMode, Container container, PartitionKey resourcePartitionKey, string itemId);
public PermissionProperties(string id, PermissionMode permissionMode, Container container, Nullable<PartitionKey> resourcePartitionKey=default(Nullable<PartitionKey>));
public string ETag { get; }
public string Id { get; }
public Nullable<DateTime> LastModified { get; }
public PermissionMode PermissionMode { get; }
public Nullable<PartitionKey> ResourcePartitionKey { get; set; }
public string ResourceUri { get; }
public string SelfLink { get; }
public string Token { get; }
}
public class PermissionResponse : Response<PermissionProperties>
{
protected PermissionResponse();
public override string ActivityId { get; }
public override CosmosDiagnostics Diagnostics { get; }
public override string ETag { get; }
public override Headers Headers { get; }
public virtual Permission Permission { get; }
public override double RequestCharge { get; }
public override PermissionProperties Resource { get; }
public override HttpStatusCode StatusCode { get; }
public static implicit operator Permission (PermissionResponse response);
}
public enum PortReuseMode
{
PrivatePortPool = 1,
ReuseUnicastPort = 0,
}
public enum PriorityLevel
{
High = 1,
Low = 2,
}
public class QueryDefinition
{
public QueryDefinition(string query);
public string QueryText { get; }
public IReadOnlyList<ValueTuple<string, object>> GetQueryParameters();
public QueryDefinition WithParameter(string name, object value);
public QueryDefinition WithParameterStream(string name, Stream valueStream);
}
public class QueryRequestOptions : RequestOptions
{
public QueryRequestOptions();
public Nullable<ConsistencyLevel> ConsistencyLevel { get; set; }
public DedicatedGatewayRequestOptions DedicatedGatewayRequestOptions { get; set; }
public Nullable<bool> EnableLowPrecisionOrderBy { get; set; }
public bool EnableOptimisticDirectExecution { get; set; }
public Nullable<bool> EnableScanInQuery { get; set; }
public FullTextScoreScope FullTextScoreScope { get; set; }
public Nullable<int> MaxBufferedItemCount { get; set; }
public Nullable<int> MaxConcurrency { get; set; }
public Nullable<int> MaxItemCount { get; set; }
public Nullable<PartitionKey> PartitionKey { get; set; }
public Nullable<bool> PopulateIndexMetrics { get; set; }
public Nullable<bool> PopulateQueryAdvice { get; set; }
public QueryTextMode QueryTextMode { get; set; }
public Nullable<int> ResponseContinuationTokenLimitInKb { get; set; }
public string SessionToken { get; set; }
}
public enum QueryTextMode
{
All = 2,
None = 0,
ParameterizedOnly = 1,
}
public class ReadManyRequestOptions : RequestOptions
{
public ReadManyRequestOptions();
public Nullable<ConsistencyLevel> ConsistencyLevel { get; set; }
public string SessionToken { get; set; }
}
public static class Regions
{
public const string AustraliaCentral = "Australia Central";
public const string AustraliaCentral2 = "Australia Central 2";
public const string AustraliaEast = "Australia East";
public const string AustraliaSoutheast = "Australia Southeast";
public const string AustriaEast = "Austria East";
public const string BelgiumCentral = "Belgium Central";
public const string BleuFranceCentral = "Bleu France Central";
public const string BleuFranceSouth = "Bleu France South";
public const string BrazilSouth = "Brazil South";
public const string BrazilSoutheast = "Brazil Southeast";
public const string CanadaCentral = "Canada Central";
public const string CanadaEast = "Canada East";
public const string CentralIndia = "Central India";
public const string CentralUS = "Central US";
public const string CentralUSEUAP = "Central US EUAP";
public const string ChileCentral = "Chile Central";
public const string ChinaEast = "China East";
public const string ChinaEast2 = "China East 2";
public const string ChinaEast3 = "China East 3";
public const string ChinaNorth = "China North";
public const string ChinaNorth2 = "China North 2";
public const string ChinaNorth3 = "China North 3";
public const string DelosCloudGermanyCentral = "Delos Cloud Germany Central";
public const string DelosCloudGermanyNorth = "Delos Cloud Germany North";
public const string DenmarkEast = "Denmark East";
public const string EastAsia = "East Asia";
public const string EastUS = "East US";
public const string EastUS2 = "East US 2";
public const string EastUS2EUAP = "East US 2 EUAP";
public const string EastUS3 = "East US 3";
public const string EastUSSLV = "East US SLV";
public const string FranceCentral = "France Central";
public const string FranceSouth = "France South";
public const string GermanyNorth = "Germany North";
public const string GermanyWestCentral = "Germany West Central";
public const string IndiaSouthCentral = "India South Central";
public const string IndonesiaCentral = "Indonesia Central";
public const string IsraelCentral = "Israel Central";
public const string IsraelNorthwest = "Israel Northwest";
public const string ItalyNorth = "Italy North";
public const string JapanEast = "Japan East";
public const string JapanWest = "Japan West";
public const string JioIndiaCentral = "Jio India Central";
public const string JioIndiaWest = "Jio India West";
public const string KoreaCentral = "Korea Central";
public const string KoreaSouth = "Korea South";
public const string MalaysiaSouth = "Malaysia South";
public const string MalaysiaWest = "Malaysia West";
public const string MexicoCentral = "Mexico Central";
public const string NewZealandNorth = "New Zealand North";
public const string NorthCentralUS = "North Central US";
public const string NortheastUS5 = "Northeast US 5";
public const string NorthEurope = "North Europe";
public const string NorwayEast = "Norway East";
public const string NorwayWest = "Norway West";
public const string PolandCentral = "Poland Central";
public const string QatarCentral = "Qatar Central";
public const string SaudiArabiaEast = "Saudi Arabia East";
public const string SingaporeCentral = "Singapore Central";
public const string SingaporeNorth = "Singapore North";
public const string SouthAfricaNorth = "South Africa North";
public const string SouthAfricaWest = "South Africa West";
public const string SouthCentralUS = "South Central US";
public const string SouthCentralUS2 = "South Central US 2";
public const string SoutheastAsia = "Southeast Asia";