Skip to content

Commit

Permalink
Permission: Fixes documentation on resource token range limits (Azure…
Browse files Browse the repository at this point in the history
…#2460)

ResourceToken has a minimum expiry period of 10 minutes (or 600 seconds). In the current code documentation, it is captured as 10 seconds, which is not in parity with CosmosDB limits. Aim of the change, is to update the correct range in code documentation.

Supporting detail for 10 minutes:

Azure/azure-sdk-for-js#10077
https://docs.microsoft.com/en-us/azure/cosmos-db/concepts-limits#per-request-limits
  • Loading branch information
arorainms authored May 13, 2021
1 parent fb7dfa1 commit 33e6d9e
Showing 1 changed file with 1 addition and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public abstract class Permission
/// <summary>
/// Reads a <see cref="PermissionProperties"/> from the Azure Cosmos service as an asynchronous operation. Each read will return a new ResourceToken with its respective expiration.
/// </summary>
/// <param name="tokenExpiryInSeconds">(Optional) The expiry time for resource token in seconds. This value can range from 10 seconds, to 24 hours (or 86,400 seconds). The default value for this is 1 hour (or 3,600 seconds). This does not change the default value for future tokens.</param>
/// <param name="tokenExpiryInSeconds">(Optional) The expiry time for resource token in seconds. This value can range from 10 minutes (or 600 seconds), to 24 hours (or 86,400 seconds). The default value for this is 1 hour (or 3,600 seconds). This does not change the default value for future tokens.</param>
/// <param name="requestOptions">(Optional) The options for the permission request.</param>
/// <param name="cancellationToken">(Optional) <see cref="CancellationToken"/> representing request cancellation.</param>
/// <returns>
Expand Down

0 comments on commit 33e6d9e

Please sign in to comment.