CosmosPermission.ReadAsync Method

Definition

Namespace:

Azure.Cosmos

Assembly:

Azure.Cosmos.dll

Package:

Azure.Cosmos v4.0.0-preview3

Reads a PermissionProperties from the Azure Cosmos service as an asynchronous operation. Each read will return a new ResourceToken with its respective expiration.

public abstract System.Threading.Tasks.Task<Azure.Cosmos.PermissionResponse> ReadAsync (int? tokenExpiryInSeconds = default, Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadAsync : Nullable<int> * Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Cosmos.PermissionResponse>

Public MustOverride Function ReadAsync (Optional tokenExpiryInSeconds As Nullable(Of Integer) = Nothing, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of PermissionResponse)

Parameters

tokenExpiryInSeconds

Nullable<Int32>

(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.

requestOptions

RequestOptions

(Optional) The options for the permission request RequestOptions

cancellationToken

CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

Task<PermissionResponse>

A Task containing a PermissionResponse which wraps a PermissionProperties containing the read resource record.

Exceptions

CosmosException

This exception can encapsulate many different types of errors. To determine the specific error always look at the StatusCode property. Some common codes you may get when creating a permission are:

StatusCode	Reason for exception
404	NotFound - This means the resource or parent resource you tried to read did not exist.
429	TooManyRequests - This means you have exceeded the number of request units per second. Consult the DocumentClientException.RetryAfter value to see how long you should wait before retrying this operation.

Examples

CosmosUser user = this.database.GetUser("userId");
CosmosPermission permission= user.GetPermission("permissionId");
PermissionProperties permissionProperties = await permission.ReadAsync(tokenExpiryInSeconds: 9000);