Skip to content

Commit 727dfc4

Browse files
author
VSC-Service-Account
committed
CI Update
Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=386406&view=results source_repo.branch:main source_repo.csvPath:bundlepackages source_repo.url:https://github.com/Azure/azure-docs-sdk-dotnet
1 parent d615fbd commit 727dfc4

File tree

81 files changed

+3194
-488
lines changed

Some content is hidden

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

81 files changed

+3194
-488
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.UserDefinedFunctionProperties" />
2120
<altmember cref="T:Azure.Cosmos.Scripts.StoredProcedureProperties" />
2221
<altmember cref="T:Azure.Cosmos.Scripts.TriggerProperties" />
22+
<altmember cref="T:Azure.Cosmos.Scripts.UserDefinedFunctionProperties" />
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
@@ -1220,12 +1220,12 @@
12201220
Each reader of events is presented with an independent iterator; if there are multiple readers, each receive their own copy of an event to
12211221
process, rather than competing for them.
12221222
</remarks>
1223-
<altmember cref="M:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient.ReadEventsAsync(Azure.Messaging.EventHubs.Consumer.ReadEventOptions,System.Threading.CancellationToken)" />
1223+
<altmember cref="M:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient.ReadEventsAsync(System.Threading.CancellationToken)" />
12241224
<exception cref="T:Azure.Messaging.EventHubs.EventHubsException">
12251225
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
12261226
this case, the <see cref="T:Azure.Messaging.EventHubs.EventHubsException.FailureReason" /> will be set to <see cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />.
12271227
</exception>
1228-
<altmember cref="M:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient.ReadEventsAsync(System.Threading.CancellationToken)" />
1228+
<altmember cref="M:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient.ReadEventsAsync(Azure.Messaging.EventHubs.Consumer.ReadEventOptions,System.Threading.CancellationToken)" />
12291229
</Docs>
12301230
</Member>
12311231
<Member MemberName="ReadEventsFromPartitionAsync">

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -316,12 +316,12 @@
316316
requested Event Hub partition for the given consumer group. In this case, the <see cref="T:Azure.Messaging.EventHubs.EventHubsException.FailureReason" />
317317
will be set to <see cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />.
318318
</remarks>
319-
<altmember cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />
319+
<altmember cref="T:Azure.Messaging.EventHubs.EventHubsException" />
320320
<exception cref="T:Azure.Messaging.EventHubs.EventHubsException">
321321
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
322322
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" />.
323323
</exception>
324-
<altmember cref="T:Azure.Messaging.EventHubs.EventHubsException" />
324+
<altmember cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />
325325
</Docs>
326326
</Member>
327327
<Member MemberName="PrefetchCount">

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@
4848
<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
4949
objects are properly cleaned up.</para>
5050
</remarks>
51-
<altmember cref="M:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient.ReadEventsFromPartitionAsync(System.String,Azure.Messaging.EventHubs.Consumer.EventPosition,Azure.Messaging.EventHubs.Consumer.ReadEventOptions,System.Threading.CancellationToken)" />
5251
<altmember cref="M:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient.ReadEventsFromPartitionAsync(System.String,Azure.Messaging.EventHubs.Consumer.EventPosition,System.Threading.CancellationToken)" />
52+
<altmember cref="M:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient.ReadEventsFromPartitionAsync(System.String,Azure.Messaging.EventHubs.Consumer.EventPosition,Azure.Messaging.EventHubs.Consumer.ReadEventOptions,System.Threading.CancellationToken)" />
5353
</Docs>
5454
<Members>
5555
<Member MemberName=".ctor">

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -334,12 +334,12 @@
334334
requested Event Hub partition for the given consumer group. In this case, the <see cref="T:Azure.Messaging.EventHubs.EventHubsException.FailureReason" />
335335
will be set to <see cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />.
336336
</remarks>
337-
<altmember cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />
337+
<altmember cref="T:Azure.Messaging.EventHubs.EventHubsException" />
338338
<exception cref="T:Azure.Messaging.EventHubs.EventHubsException">
339339
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
340340
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" />.
341341
</exception>
342-
<altmember cref="T:Azure.Messaging.EventHubs.EventHubsException" />
342+
<altmember cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />
343343
</Docs>
344344
</Member>
345345
<Member MemberName="PrefetchCount">

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -566,8 +566,8 @@
566566
</summary>
567567
<returns>An <see cref="T:Azure.Messaging.EventHubs.Producer.EventDataBatch" /> with the default batch options.</returns>
568568
<remarks>To be added.</remarks>
569-
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" />
570569
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(Azure.Messaging.EventHubs.Producer.CreateBatchOptions,System.Threading.CancellationToken)" />
570+
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" />
571571
</Docs>
572572
</Member>
573573
<Member MemberName="CreateBatchAsync">
@@ -618,9 +618,9 @@
618618
</summary>
619619
<returns>An <see cref="T:Azure.Messaging.EventHubs.Producer.EventDataBatch" /> with the requested <paramref name="options" />.</returns>
620620
<remarks>To be added.</remarks>
621-
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(System.Threading.CancellationToken)" />
622-
<exception cref="T:System.InvalidOperationException">Occurs when both a partition identifier and partition key have been specified in the <paramref name="options" />.</exception>
623621
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" />
622+
<exception cref="T:System.InvalidOperationException">Occurs when both a partition identifier and partition key have been specified in the <paramref name="options" />.</exception>
623+
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(System.Threading.CancellationToken)" />
624624
</Docs>
625625
</Member>
626626
<Member MemberName="DisposeAsync">
@@ -1214,8 +1214,8 @@
12141214
When published, the result is atomic; either all events that belong to the set were successful or all
12151215
have failed. Partial success is not possible.
12161216
</remarks>
1217-
<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)" />
12181217
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" />
1218+
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(System.Threading.CancellationToken)" />
12191219
<exception cref="T:Azure.Messaging.EventHubs.EventHubsException">
12201220
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
12211221
<see cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.MessageSizeExceeded" /> in this case.
@@ -1224,7 +1224,7 @@
12241224
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
12251225
unsupported type for serialization. See the <see cref="P:Azure.Messaging.EventHubs.EventData.Properties" /> remarks for details.
12261226
</exception>
1227-
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(System.Threading.CancellationToken)" />
1227+
<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)" />
12281228
</Docs>
12291229
</Member>
12301230
<Member MemberName="SendAsync">
@@ -1283,8 +1283,8 @@
12831283
When published, the result is atomic; either all events that belong to the set were successful or all
12841284
have failed. Partial success is not possible.
12851285
</remarks>
1286-
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(System.Collections.Generic.IEnumerable{Azure.Messaging.EventHubs.EventData},System.Threading.CancellationToken)" />
12871286
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" />
1287+
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(Azure.Messaging.EventHubs.Producer.CreateBatchOptions,System.Threading.CancellationToken)" />
12881288
<exception cref="T:System.InvalidOperationException">Occurs when both a partition identifier and partition key have been specified in the <paramref name="options" />.</exception>
12891289
<exception cref="T:Azure.Messaging.EventHubs.EventHubsException">
12901290
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
@@ -1294,7 +1294,7 @@
12941294
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
12951295
unsupported type for serialization. See the <see cref="P:Azure.Messaging.EventHubs.EventData.Properties" /> remarks for details.
12961296
</exception>
1297-
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(Azure.Messaging.EventHubs.Producer.CreateBatchOptions,System.Threading.CancellationToken)" />
1297+
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(System.Collections.Generic.IEnumerable{Azure.Messaging.EventHubs.EventData},System.Threading.CancellationToken)" />
12981298
</Docs>
12991299
</Member>
13001300
<Member MemberName="ToString">

0 commit comments

Comments
 (0)