Skip to content

Commit c6b038d

Browse files
CI Update
Build.Reason:Manual by azure-sdk-internal-msdocs-apidrop-connection Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=559782&view=results source_repo.branch:main source_repo.csvPath:bundlepackages source_repo.url:https://github.com/MicrosoftDocs/azure-docs-sdk-dotnet
1 parent 8bd479a commit c6b038d

File tree

410 files changed

+12340
-10084
lines changed

Some content is hidden

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

410 files changed

+12340
-10084
lines changed

xml/Azure.Cosmos.Fluent/CosmosClientBuilder.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -226,8 +226,8 @@
226226
<remarks>
227227
For more information, see <see href="https://docs.microsoft.com/azure/documentdb/documentdb-performance-tips#direct-connection">Connection policy: Use direct connection mode</see>.
228228
</remarks>
229-
<altmember cref="P:Azure.Cosmos.CosmosClientOptions.GatewayModeMaxConnectionLimit" />
230229
<altmember cref="P:Azure.Cosmos.CosmosClientOptions.ConnectionMode" />
230+
<altmember cref="P:Azure.Cosmos.CosmosClientOptions.GatewayModeMaxConnectionLimit" />
231231
</Docs>
232232
</Member>
233233
<Member MemberName="WithConsistencyLevel">
@@ -281,8 +281,8 @@
281281
</summary>
282282
<returns>The <see cref="T:Azure.Cosmos.Fluent.CosmosClientBuilder" /> object</returns>
283283
<remarks>To be added.</remarks>
284-
<altmember cref="P:Azure.Cosmos.CosmosClientOptions.Serializer" />
285284
<altmember cref="T:Azure.Cosmos.Serialization.CosmosSerializer" />
285+
<altmember cref="P:Azure.Cosmos.CosmosClientOptions.Serializer" />
286286
</Docs>
287287
</Member>
288288
<Member MemberName="WithLimitToEndpoint">
@@ -375,8 +375,8 @@
375375
</summary>
376376
<returns>The <see cref="T:Azure.Cosmos.Fluent.CosmosClientBuilder" /> object</returns>
377377
<remarks>To be added.</remarks>
378-
<altmember cref="P:Azure.Cosmos.CosmosClientOptions.SerializerOptions" />
379378
<altmember cref="T:Azure.Cosmos.Serialization.CosmosSerializer" />
379+
<altmember cref="P:Azure.Cosmos.CosmosClientOptions.SerializerOptions" />
380380
</Docs>
381381
</Member>
382382
<Member MemberName="WithThrottlingRetryOptions">
@@ -405,7 +405,7 @@
405405
</summary>
406406
<returns>The current <see cref="T:Azure.Cosmos.Fluent.CosmosClientBuilder" />.</returns>
407407
<remarks>To be added.</remarks>
408-
<altmember cref="P:Azure.Cosmos.CosmosClientOptions.MaxRetryAttemptsOnRateLimitedRequests" />
408+
<altmember cref="P:Azure.Cosmos.CosmosClientOptions.MaxRetryWaitTimeOnRateLimitedRequests" />
409409
<para>
410410
When a request fails due to a rate limiting error, the service sends back a response that
411411
contains a value indicating the client should not retry before the time period has
@@ -415,7 +415,7 @@
415415
<para>
416416
For more information, see <see href="https://docs.microsoft.com/azure/documentdb/documentdb-performance-tips#429">Handle rate limiting/request rate too large</see>.
417417
</para>
418-
<altmember cref="P:Azure.Cosmos.CosmosClientOptions.MaxRetryWaitTimeOnRateLimitedRequests" />
418+
<altmember cref="P:Azure.Cosmos.CosmosClientOptions.MaxRetryAttemptsOnRateLimitedRequests" />
419419
</Docs>
420420
</Member>
421421
</Members>

xml/Azure.Cosmos.Scripts/CosmosScripts.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@
1717
Represents script operations on an Azure Cosmos container.
1818
</summary>
1919
<remarks>To be added.</remarks>
20-
<altmember cref="T:Azure.Cosmos.Scripts.TriggerProperties" />
2120
<altmember cref="T:Azure.Cosmos.Scripts.UserDefinedFunctionProperties" />
2221
<altmember cref="T:Azure.Cosmos.Scripts.StoredProcedureProperties" />
22+
<altmember cref="T:Azure.Cosmos.Scripts.TriggerProperties" />
2323
</Docs>
2424
<Members>
2525
<Member MemberName=".ctor">

xml/Azure.Cosmos/ContainerProperties.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
they can be authorized using either the master key or resource keys.
2929
Refer to <see>http://azure.microsoft.com/documentation/articles/documentdb-resources/#collections</see> for more details on containers.
3030
</remarks>
31-
<altmember cref="P:Azure.Cosmos.ContainerProperties.IndexingPolicy" />
31+
<altmember cref="P:Azure.Cosmos.ContainerProperties.UniqueKeyPolicy" />
3232
<example>
3333
The example below creates a new partitioned container with 50000 Request-per-Unit throughput.
3434
The partition key is the first level 'country' property in all the documents within this container.
@@ -52,7 +52,7 @@
5252
Container container = client.GetDatabase("dbName"].Containers["MyCollection"];
5353
await container.DeleteAsync();
5454
]]></code></example>
55-
<altmember cref="P:Azure.Cosmos.ContainerProperties.UniqueKeyPolicy" />
55+
<altmember cref="P:Azure.Cosmos.ContainerProperties.IndexingPolicy" />
5656
</Docs>
5757
<Members>
5858
<Member MemberName=".ctor">

xml/Azure.Cosmos/CosmosClientOptions.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,8 @@
129129
<remarks>
130130
For more information, see <see href="https://docs.microsoft.com/azure/documentdb/documentdb-performance-tips#direct-connection">Connection policy: Use direct connection mode</see>.
131131
</remarks>
132-
<altmember cref="M:Azure.Cosmos.Fluent.CosmosClientBuilder.WithConnectionModeGateway(System.Nullable{System.Int32},System.Net.IWebProxy)" />
133132
<altmember cref="M:Azure.Cosmos.Fluent.CosmosClientBuilder.WithConnectionModeDirect" />
133+
<altmember cref="M:Azure.Cosmos.Fluent.CosmosClientBuilder.WithConnectionModeGateway(System.Nullable{System.Int32},System.Net.IWebProxy)" />
134134
</Docs>
135135
</Member>
136136
<Member MemberName="ConsistencyLevel">

xml/Azure.Cosmos/ItemRequestOptions.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@
8585
The indexing directive to use with a request.
8686
</value>
8787
<remarks>To be added.</remarks>
88-
<altmember cref="P:Azure.Cosmos.ItemRequestOptions.IndexingDirective" />
8988
<altmember cref="T:Azure.Cosmos.IndexingPolicy" />
89+
<altmember cref="P:Azure.Cosmos.ItemRequestOptions.IndexingDirective" />
9090
</Docs>
9191
</Member>
9292
<Member MemberName="PostTriggers">

xml/Azure.Messaging.EventHubs.Consumer/EventHubConsumerClient.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -834,12 +834,12 @@
834834
Each reader of events is presented with an independent iterator; if there are multiple readers, each receive their own copy of an event to
835835
process, rather than competing for them.
836836
</remarks>
837-
<altmember cref="M:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient.ReadEventsAsync(Azure.Messaging.EventHubs.Consumer.ReadEventOptions,System.Threading.CancellationToken)" />
837+
<altmember cref="M:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient.ReadEventsAsync(System.Threading.CancellationToken)" />
838838
<exception cref="T:Azure.Messaging.EventHubs.EventHubsException">
839839
Occurs when an <see cref="T:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient" /> is unable to read from the Event Hub due to another reader having asserted exclusive ownership. In
840840
this case, the <see cref="T:Azure.Messaging.EventHubs.EventHubsException.FailureReason" /> will be set to <see cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />.
841841
</exception>
842-
<altmember cref="M:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient.ReadEventsAsync(System.Threading.CancellationToken)" />
842+
<altmember cref="M:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient.ReadEventsAsync(Azure.Messaging.EventHubs.Consumer.ReadEventOptions,System.Threading.CancellationToken)" />
843843
</Docs>
844844
</Member>
845845
<Member MemberName="ReadEventsFromPartitionAsync">

xml/Azure.Messaging.EventHubs.Consumer/ReadEventOptions.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -231,12 +231,12 @@
231231
requested Event Hub partition for the given consumer group. In this case, the <see cref="T:Azure.Messaging.EventHubs.EventHubsException.FailureReason" />
232232
will be set to <see cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />.
233233
</remarks>
234-
<altmember cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />
234+
<altmember cref="T:Azure.Messaging.EventHubs.EventHubsException" />
235235
<exception cref="T:Azure.Messaging.EventHubs.EventHubsException">
236236
Occurs when the owner level is set and the <see cref="T:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient" /> is unable to read from the requested Event Hub partition due to being denied
237237
ownership. In this case, the <see cref="T:Azure.Messaging.EventHubs.EventHubsException.FailureReason" /> will be set to <see cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />.
238238
</exception>
239-
<altmember cref="T:Azure.Messaging.EventHubs.EventHubsException" />
239+
<altmember cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />
240240
</Docs>
241241
</Member>
242242
<Member MemberName="PrefetchCount">

xml/Azure.Messaging.EventHubs.Primitives/PartitionReceiver.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@
5959
<see cref="M:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.CloseAsync(System.Threading.CancellationToken)" /> or <see cref="M:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.DisposeAsync" /> as the application is shutting down will ensure that network resources and other unmanaged
6060
objects are properly cleaned up.</para>
6161
</remarks>
62-
<altmember cref="M:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient.ReadEventsFromPartitionAsync(System.String,Azure.Messaging.EventHubs.Consumer.EventPosition,Azure.Messaging.EventHubs.Consumer.ReadEventOptions,System.Threading.CancellationToken)" />
6362
<altmember cref="M:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient.ReadEventsFromPartitionAsync(System.String,Azure.Messaging.EventHubs.Consumer.EventPosition,System.Threading.CancellationToken)" />
63+
<altmember cref="M:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient.ReadEventsFromPartitionAsync(System.String,Azure.Messaging.EventHubs.Consumer.EventPosition,Azure.Messaging.EventHubs.Consumer.ReadEventOptions,System.Threading.CancellationToken)" />
6464
</Docs>
6565
<Members>
6666
<Member MemberName=".ctor">

xml/Azure.Messaging.EventHubs.Primitives/PartitionReceiverOptions.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -236,12 +236,12 @@
236236
requested Event Hub partition for the given consumer group. In this case, the <see cref="T:Azure.Messaging.EventHubs.EventHubsException.FailureReason" />
237237
will be set to <see cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />.
238238
</remarks>
239-
<altmember cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />
239+
<altmember cref="T:Azure.Messaging.EventHubs.EventHubsException" />
240240
<exception cref="T:Azure.Messaging.EventHubs.EventHubsException">
241241
Occurs when the owner level is set and the <see cref="T:Azure.Messaging.EventHubs.Primitives.PartitionReceiver" /> is unable to read from the requested Event Hub partition due to being denied
242242
ownership. In this case, the <see cref="T:Azure.Messaging.EventHubs.EventHubsException.FailureReason" /> will be set to <see cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />.
243243
</exception>
244-
<altmember cref="T:Azure.Messaging.EventHubs.EventHubsException" />
244+
<altmember cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />
245245
</Docs>
246246
</Member>
247247
<Member MemberName="PrefetchCount">

xml/Azure.Messaging.EventHubs.Producer/EventHubProducerClient.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -401,8 +401,8 @@
401401
</summary>
402402
<returns>An <see cref="T:Azure.Messaging.EventHubs.Producer.EventDataBatch" /> with the default batch options.</returns>
403403
<remarks>To be added.</remarks>
404-
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" />
405404
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(Azure.Messaging.EventHubs.Producer.CreateBatchOptions,System.Threading.CancellationToken)" />
405+
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" />
406406
</Docs>
407407
</Member>
408408
<Member MemberName="CreateBatchAsync">
@@ -437,9 +437,9 @@
437437
</summary>
438438
<returns>An <see cref="T:Azure.Messaging.EventHubs.Producer.EventDataBatch" /> with the requested <paramref name="options" />.</returns>
439439
<remarks>To be added.</remarks>
440-
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(System.Threading.CancellationToken)" />
441-
<exception cref="T:System.InvalidOperationException">Occurs when both a partition identifier and partition key have been specified in the <paramref name="options" />.</exception>
442440
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" />
441+
<exception cref="T:System.InvalidOperationException">Occurs when both a partition identifier and partition key have been specified in the <paramref name="options" />.</exception>
442+
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(System.Threading.CancellationToken)" />
443443
</Docs>
444444
</Member>
445445
<Member MemberName="DisposeAsync">
@@ -833,8 +833,8 @@
833833
When published, the result is atomic; either all events that belong to the set were successful or all
834834
have failed. Partial success is not possible.
835835
</remarks>
836-
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(System.Threading.CancellationToken)" />
837836
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(System.Collections.Generic.IEnumerable{Azure.Messaging.EventHubs.EventData},Azure.Messaging.EventHubs.Producer.SendEventOptions,System.Threading.CancellationToken)" />
837+
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" />
838838
<exception cref="T:Azure.Messaging.EventHubs.EventHubsException">
839839
Occurs when the set of events exceeds the maximum size allowed in a single batch, as determined by the Event Hubs service. The <see cref="P:Azure.Messaging.EventHubs.EventHubsException.Reason" /> will be set to
840840
<see cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.MessageSizeExceeded" /> in this case.
@@ -843,7 +843,7 @@
843843
Occurs when one of the events in the <paramref name="eventBatch" /> has a member in the <see cref="P:Azure.Messaging.EventHubs.EventData.Properties" /> collection that is an
844844
unsupported type for serialization. See the <see cref="P:Azure.Messaging.EventHubs.EventData.Properties" /> remarks for details.
845845
</exception>
846-
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" />
846+
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(System.Threading.CancellationToken)" />
847847
</Docs>
848848
</Member>
849849
<Member MemberName="SendAsync">
@@ -886,8 +886,8 @@
886886
When published, the result is atomic; either all events that belong to the set were successful or all
887887
have failed. Partial success is not possible.
888888
</remarks>
889-
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(Azure.Messaging.EventHubs.Producer.CreateBatchOptions,System.Threading.CancellationToken)" />
890889
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(System.Collections.Generic.IEnumerable{Azure.Messaging.EventHubs.EventData},System.Threading.CancellationToken)" />
890+
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" />
891891
<exception cref="T:System.InvalidOperationException">Occurs when both a partition identifier and partition key have been specified in the <paramref name="options" />.</exception>
892892
<exception cref="T:Azure.Messaging.EventHubs.EventHubsException">
893893
Occurs when the set of events exceeds the maximum size allowed in a single batch, as determined by the Event Hubs service. The <see cref="P:Azure.Messaging.EventHubs.EventHubsException.Reason" /> will be set to
@@ -897,7 +897,7 @@
897897
Occurs when one of the events in the <paramref name="eventBatch" /> has a member in the <see cref="P:Azure.Messaging.EventHubs.EventData.Properties" /> collection that is an
898898
unsupported type for serialization. See the <see cref="P:Azure.Messaging.EventHubs.EventData.Properties" /> remarks for details.
899899
</exception>
900-
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" />
900+
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(Azure.Messaging.EventHubs.Producer.CreateBatchOptions,System.Threading.CancellationToken)" />
901901
</Docs>
902902
</Member>
903903
<Member MemberName="ToString">

0 commit comments

Comments
 (0)