DocumentClient.ReadPermissionAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| ReadPermissionAsync(String, RequestOptions) |
Permission非同期操作として Azure Cosmos DB サービスから を読み取ります。 |
| ReadPermissionAsync(Uri, RequestOptions) |
Permission Azure Cosmos DB サービスから非同期操作としてリソースを読み取ります。 |
ReadPermissionAsync(String, RequestOptions)
Permission非同期操作として Azure Cosmos DB サービスから を読み取ります。
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Permission>> ReadPermissionAsync (string permissionLink, Microsoft.Azure.Documents.Client.RequestOptions options = default);abstract member ReadPermissionAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Permission>>
override this.ReadPermissionAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Permission>>Public Function ReadPermissionAsync (permissionLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of Permission))パラメーター
- permissionLink
- String
読み取るアクセス許可リソースのリンク。
- options
- RequestOptions
(省略可能)要求の要求オプション。
戻り値
System.Threading.Tasks読み取りリソース レコードをResourceResponse<TResource>含む をPermissionラップする を含む 。
実装
例外
が設定されていない場合 permissionLink 。
この例外により、さまざまな種類のエラーがカプセル化される可能性があります。 特定のエラーを特定するには、常に StatusCode プロパティを参照してください。 ドキュメントの作成時に取得できる一般的なコードは次のとおりです。
| StatusCode | 例外の理由 |
|---|---|
| 404 | NotFound - 読み取ろうとしたリソースが存在しなかったことを意味します。 |
| 429 | TooManyRequests - つまり、1 秒あたりの要求ユニット数を超えています。 DocumentClientException.RetryAfter 値を調べ、この操作を再試行するまでの待機時間を確認します。 |
例
//Reads a Permission resource from a Database and User where
// - sample_database is the ID of the database
// - sample_user is the ID of the user
// - permission_id is the ID of the permission to be read
var permissionLink = "/dbs/sample_database/users/sample_user/permissions/permission_id";
Permission permission = await client.ReadPermissionAsync(permissionLink);
注釈
リソースの読み取りを行うことは、データベースからリソースを取得する最も効率的な方法です。 リソースの ID がわかっている場合は、ID によるクエリではなく読み取りを行います。
示されている例では、ID ベースのリンクを使用します。このリンクは、リソースの作成時に使用される ID プロパティで構成されます。 必要に応じて、 SelfLink Permission の プロパティを引き続き使用できます。 セルフリンクは、リソース識別子 (または_ridプロパティ) で構成されるリソースの URI です。 ID ベースのリンクと SelfLink の両方が機能します。 の permissionLink 形式は常に "/dbs/{db identifier}/users/{user identifier}/permissions/{permission identifier}" です。{..} 内の値のみが、リソースのアドレス指定に使用する方法によって変わります。
こちらもご覧ください
適用対象
ReadPermissionAsync(Uri, RequestOptions)
Permission Azure Cosmos DB サービスから非同期操作としてリソースを読み取ります。
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Permission>> ReadPermissionAsync (Uri permissionUri, Microsoft.Azure.Documents.Client.RequestOptions options = default);abstract member ReadPermissionAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Permission>>
override this.ReadPermissionAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Permission>>Public Function ReadPermissionAsync (permissionUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of Permission))パラメーター
- permissionUri
- Uri
読み取るアクセス許可リソースへの URI。
- options
- RequestOptions
要求の要求オプション。
戻り値
System.Threading.Tasks読み取りリソース レコードをResourceResponse<TResource>含む をPermissionラップする を含む 。
実装
例外
が設定されていない場合 permissionUri 。
この例外により、さまざまな種類のエラーがカプセル化される可能性があります。 特定のエラーを特定するには、常に StatusCode プロパティを参照してください。 ドキュメントの作成時に取得できる一般的なコードは次のとおりです。
| StatusCode | 例外の理由 |
|---|---|
| 404 | NotFound - 読み取ろうとしたリソースが存在しなかったことを意味します。 |
| 429 | TooManyRequests - つまり、1 秒あたりの要求ユニット数を超えています。 DocumentClientException.RetryAfter 値を調べ、この操作を再試行するまでの待機時間を確認します。 |
例
//Reads a Permission resource where
// - db_id is the ID property of the Database
// - user_id is the ID property of the User
// - permission_id is the ID property of the Permission you wish to read.
var permissionLink = UriFactory.CreatePermissionUri("db_id", "coll_id", "user_id");
Permission permission = await client.ReadPermissionAsync(permissionLink);
注釈
リソースの読み取りを行うことは、サービスからリソースを取得する最も効率的な方法です。 リソースの ID がわかっている場合は、ID によるクエリではなく読み取りを行います。
こちらもご覧ください
適用対象
Azure SDK for .NET