Skip to content

Commit d8a696a

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

42 files changed

Lines changed: 403 additions & 403 deletions

File tree

Some content is hidden

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

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.ConnectionMode" />
230229
<altmember cref="P:Azure.Cosmos.CosmosClientOptions.GatewayModeMaxConnectionLimit" />
230+
<altmember cref="P:Azure.Cosmos.CosmosClientOptions.ConnectionMode" />
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="T:Azure.Cosmos.Serialization.CosmosSerializer" />
285284
<altmember cref="P:Azure.Cosmos.CosmosClientOptions.Serializer" />
285+
<altmember cref="T:Azure.Cosmos.Serialization.CosmosSerializer" />
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="T:Azure.Cosmos.Serialization.CosmosSerializer" />
379378
<altmember cref="P:Azure.Cosmos.CosmosClientOptions.SerializerOptions" />
379+
<altmember cref="T:Azure.Cosmos.Serialization.CosmosSerializer" />
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.MaxRetryWaitTimeOnRateLimitedRequests" />
408+
<altmember cref="P:Azure.Cosmos.CosmosClientOptions.MaxRetryAttemptsOnRateLimitedRequests" />
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.MaxRetryAttemptsOnRateLimitedRequests" />
418+
<altmember cref="P:Azure.Cosmos.CosmosClientOptions.MaxRetryWaitTimeOnRateLimitedRequests" />
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.StoredProcedureProperties" />
2120
<altmember cref="T:Azure.Cosmos.Scripts.TriggerProperties" />
2221
<altmember cref="T:Azure.Cosmos.Scripts.UserDefinedFunctionProperties" />
22+
<altmember cref="T:Azure.Cosmos.Scripts.StoredProcedureProperties" />
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.UniqueKeyPolicy" />
31+
<altmember cref="P:Azure.Cosmos.ContainerProperties.IndexingPolicy" />
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.IndexingPolicy" />
55+
<altmember cref="P:Azure.Cosmos.ContainerProperties.UniqueKeyPolicy" />
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.WithConnectionModeDirect" />
133132
<altmember cref="M:Azure.Cosmos.Fluent.CosmosClientBuilder.WithConnectionModeGateway(System.Nullable{System.Int32},System.Net.IWebProxy)" />
133+
<altmember cref="M:Azure.Cosmos.Fluent.CosmosClientBuilder.WithConnectionModeDirect" />
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="T:Azure.Cosmos.IndexingPolicy" />
8988
<altmember cref="P:Azure.Cosmos.ItemRequestOptions.IndexingDirective" />
89+
<altmember cref="T:Azure.Cosmos.IndexingPolicy" />
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
@@ -1194,12 +1194,12 @@
11941194
Each reader of events is presented with an independent iterator; if there are multiple readers, each receive their own copy of an event to
11951195
process, rather than competing for them.
11961196
</remarks>
1197-
<altmember cref="M:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient.ReadEventsAsync(System.Threading.CancellationToken)" />
1197+
<altmember cref="M:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient.ReadEventsAsync(Azure.Messaging.EventHubs.Consumer.ReadEventOptions,System.Threading.CancellationToken)" />
11981198
<exception cref="T:Azure.Messaging.EventHubs.EventHubsException">
11991199
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
12001200
this case, the <see cref="T:Azure.Messaging.EventHubs.EventHubsException.FailureReason" /> will be set to <see cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />.
12011201
</exception>
1202-
<altmember cref="M:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient.ReadEventsAsync(Azure.Messaging.EventHubs.Consumer.ReadEventOptions,System.Threading.CancellationToken)" />
1202+
<altmember cref="M:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient.ReadEventsAsync(System.Threading.CancellationToken)" />
12031203
</Docs>
12041204
</Member>
12051205
<Member MemberName="ReadEventsFromPartitionAsync">

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -309,12 +309,12 @@
309309
requested Event Hub partition for the given consumer group. In this case, the <see cref="T:Azure.Messaging.EventHubs.EventHubsException.FailureReason" />
310310
will be set to <see cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />.
311311
</remarks>
312-
<altmember cref="T:Azure.Messaging.EventHubs.EventHubsException" />
312+
<altmember cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />
313313
<exception cref="T:Azure.Messaging.EventHubs.EventHubsException">
314314
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
315315
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" />.
316316
</exception>
317-
<altmember cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />
317+
<altmember cref="T:Azure.Messaging.EventHubs.EventHubsException" />
318318
</Docs>
319319
</Member>
320320
<Member MemberName="PrefetchCount">

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

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

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -326,12 +326,12 @@
326326
requested Event Hub partition for the given consumer group. In this case, the <see cref="T:Azure.Messaging.EventHubs.EventHubsException.FailureReason" />
327327
will be set to <see cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />.
328328
</remarks>
329-
<altmember cref="T:Azure.Messaging.EventHubs.EventHubsException" />
329+
<altmember cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />
330330
<exception cref="T:Azure.Messaging.EventHubs.EventHubsException">
331331
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
332332
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" />.
333333
</exception>
334-
<altmember cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />
334+
<altmember cref="T:Azure.Messaging.EventHubs.EventHubsException" />
335335
</Docs>
336336
</Member>
337337
<Member MemberName="PrefetchCount">

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -554,8 +554,8 @@
554554
</summary>
555555
<returns>An <see cref="T:Azure.Messaging.EventHubs.Producer.EventDataBatch" /> with the default batch options.</returns>
556556
<remarks>To be added.</remarks>
557-
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(Azure.Messaging.EventHubs.Producer.CreateBatchOptions,System.Threading.CancellationToken)" />
558557
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" />
558+
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(Azure.Messaging.EventHubs.Producer.CreateBatchOptions,System.Threading.CancellationToken)" />
559559
</Docs>
560560
</Member>
561561
<Member MemberName="CreateBatchAsync">
@@ -605,9 +605,9 @@
605605
</summary>
606606
<returns>An <see cref="T:Azure.Messaging.EventHubs.Producer.EventDataBatch" /> with the requested <paramref name="options" />.</returns>
607607
<remarks>To be added.</remarks>
608-
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" />
609-
<exception cref="T:System.InvalidOperationException">Occurs when both a partition identifier and partition key have been specified in the <paramref name="options" />.</exception>
610608
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(System.Threading.CancellationToken)" />
609+
<exception cref="T:System.InvalidOperationException">Occurs when both a partition identifier and partition key have been specified in the <paramref name="options" />.</exception>
610+
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" />
611611
</Docs>
612612
</Member>
613613
<Member MemberName="DisposeAsync">
@@ -1188,8 +1188,8 @@
11881188
When published, the result is atomic; either all events that belong to the set were successful or all
11891189
have failed. Partial success is not possible.
11901190
</remarks>
1191-
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" />
11921191
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(System.Threading.CancellationToken)" />
1192+
<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)" />
11931193
<exception cref="T:Azure.Messaging.EventHubs.EventHubsException">
11941194
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
11951195
<see cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.MessageSizeExceeded" /> in this case.
@@ -1198,7 +1198,7 @@
11981198
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
11991199
unsupported type for serialization. See the <see cref="P:Azure.Messaging.EventHubs.EventData.Properties" /> remarks for details.
12001200
</exception>
1201-
<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)" />
1201+
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" />
12021202
</Docs>
12031203
</Member>
12041204
<Member MemberName="SendAsync">
@@ -1256,8 +1256,8 @@
12561256
When published, the result is atomic; either all events that belong to the set were successful or all
12571257
have failed. Partial success is not possible.
12581258
</remarks>
1259-
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" />
12601259
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(Azure.Messaging.EventHubs.Producer.CreateBatchOptions,System.Threading.CancellationToken)" />
1260+
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(System.Collections.Generic.IEnumerable{Azure.Messaging.EventHubs.EventData},System.Threading.CancellationToken)" />
12611261
<exception cref="T:System.InvalidOperationException">Occurs when both a partition identifier and partition key have been specified in the <paramref name="options" />.</exception>
12621262
<exception cref="T:Azure.Messaging.EventHubs.EventHubsException">
12631263
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
@@ -1267,7 +1267,7 @@
12671267
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
12681268
unsupported type for serialization. See the <see cref="P:Azure.Messaging.EventHubs.EventData.Properties" /> remarks for details.
12691269
</exception>
1270-
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(System.Collections.Generic.IEnumerable{Azure.Messaging.EventHubs.EventData},System.Threading.CancellationToken)" />
1270+
<altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" />
12711271
</Docs>
12721272
</Member>
12731273
<Member MemberName="ToString">

0 commit comments

Comments
 (0)