User.CreatePermissionAsync メソッド

定義

名前空間:

Microsoft.Azure.Cosmos

アセンブリ:

Microsoft.Azure.Cosmos.Client.dll

パッケージ:

Microsoft.Azure.Cosmos v3.36.0

Azure Cosmos サービスで非同期操作としてアクセス許可を作成します。

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

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

Public MustOverride Function CreatePermissionAsync (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	例外の理由
400	BadRequest - これは、指定された要求に何らかの問題が発生したことを意味します。 新しいアクセス許可に ID が指定されていない可能性があります。
409	競合 - これは、指定した ID と一致する ID が既に存在する を意味 PermissionProperties します。

例

PermissionProperties permissionProperties = new PermissionProperties("permissionId", PermissionMode.All, database.GetContainer("containerId"), new PartitionKey("tenantId"))";

PermissionResponse response = await this.cosmosDatabase.GetUser("userId").CreatePermissionAsync(permissionProperties, tokenExpiryInSeconds: 9000);