Permission.ReplaceAsync メソッド

  • リファレンス

定義

名前空間:
Microsoft.Azure.Cosmos
アセンブリ:
Microsoft.Azure.Cosmos.Client.dll
パッケージ:
Microsoft.Azure.Cosmos v3.36.0

Azure Cosmos サービスの を PermissionProperties 非同期操作として置き換えます。 これにより、既存の ResourceToken は取り消されません。

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.PermissionResponse> ReplaceAsync (Microsoft.Azure.Cosmos.PermissionProperties permissionProperties, int? tokenExpiryInSeconds = default, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ReplaceAsync : Microsoft.Azure.Cosmos.PermissionProperties * Nullable<int> * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.PermissionResponse>
Public MustOverride Function ReplaceAsync (permissionProperties As PermissionProperties, Optional tokenExpiryInSeconds As Nullable(Of Integer) = Nothing, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of PermissionResponse)

パラメーター

permissionProperties
PermissionProperties

PermissionProperties オブジェクト。

tokenExpiryInSeconds
Nullable<Int32>

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

requestOptions
RequestOptions

(省略可能)ユーザー要求のオプション。

cancellationToken
CancellationToken

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

戻り値

Task<PermissionResponse>

Task置換リソース レコードをPermissionResponse含む をPermissionPropertiesラップする を含む 。

例外

CosmosException

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

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

例

PermissionProperties permissionProperties = permissionReadResponse;
permissionProperties.Id = "newuser";
PermissionResponse response = await permission.ReplaceAsync(permissionProperties, tokenExpiryInSeconds: 9000);
PermissionProperties replacedProperties = response;

適用対象