CosmosPermission.ReadAsync メソッド

定義

名前空間:

Azure.Cosmos

アセンブリ:

Azure.Cosmos.dll

パッケージ:

Azure.Cosmos v4.0.0-preview3

PermissionProperties非同期操作として Azure Cosmos サービスから を読み取ります。 各読み取りでは、それぞれの有効期限を持つ新しい ResourceToken が返されます。

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)

パラメーター

tokenExpiryInSeconds

Nullable<Int32>

(省略可能)リソース トークンの有効期限 (秒単位)。 この値の範囲は 10 秒から 24 時間 (または 86,400 秒) です。 この既定値は 1 時間 (または 3,600 秒) です。 これにより、将来のトークンの既定値は変更されません。

requestOptions

RequestOptions

(省略可能)アクセス許可要求のオプション RequestOptions

cancellationToken

CancellationToken

(省略可能) CancellationToken 要求の取り消しを表します。

戻り値

Task<PermissionResponse>

Task読み取りリソース レコードをPermissionResponse含む をPermissionPropertiesラップする を含む 。

例外

CosmosException

この例外は、さまざまな種類のエラーをカプセル化できます。 特定のエラーを特定するには、常に StatusCode プロパティを参照してください。 アクセス許可の作成時に取得できる一般的なコードは次のとおりです。

StatusCode	例外の理由
404	NotFound - 読み取ろうとしたリソースまたは親リソースが存在しなかったことを意味します。
429	TooManyRequests - つまり、1 秒あたりの要求ユニット数を超えています。 DocumentClientException.RetryAfter の値を調べ、この操作を再試行する前に待機する必要がある時間を確認します。

例

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