Microsoft.Azure.Cosmos 名前空間
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
クラス
AccountConsistency |
Azure Cosmos DB サービスのデータベース アカウントの整合性ポリシーを表します。 |
AccountProperties |
AccountProperties を表します。 AccountProperties は、Azure Cosmos DB サービス内のデータベースのコンテナーです。 |
AccountRegion |
AccountLocation クラスは、特定のリージョン内の Azure Cosmos DB データベース アカウントを表します。 |
BoundingBoxProperties |
Azure Cosmos DB サービスの geometry 空間パスの境界ボックスを表します |
ChangeFeedEstimator |
デプロイによって ChangeFeedProcessor 読み取られる保留中の作業を見積もるために使用されます。 |
ChangeFeedEstimatorRequestOptions |
の ChangeFeedEstimator要求オプション。 |
ChangeFeedMode |
変更フィード モード ChangeFeedRequestOptionsの基本クラス。 |
ChangeFeedProcessor |
によってBuild()作成されたインスタンスを開始および停止する ChangeFeedProcessor API を提供します。 |
ChangeFeedProcessorBuilder |
カスタム パラメーター のセットを使用して の ChangeFeedProcessor インスタンスを柔軟に作成する方法を提供します。 |
ChangeFeedProcessorContext |
配信された変更のセットに関連するコンテキスト。 |
ChangeFeedProcessorState |
パーティション キーの特定の範囲のフィード プロセッサの状態を変更します。 |
ChangeFeedProcessorUserException |
IChangeFeedObserver の操作が実行され、ユーザー コードによってスローされたときに例外が発生しました |
ChangeFeedRequestOptions |
Cosmos Change Feed 要求オプション |
ChangeFeedStartFrom |
で ChangeFeed 操作を開始する場所の ChangeFeedRequestOptions基本クラス。 |
ClientEncryptionIncludedPath |
内の暗号化と関連付けられた設定 ClientEncryptionPolicyを必要とするパス。 |
ClientEncryptionKey |
Id によって特定のクライアント データ暗号化キー (ClientEncryptionKey とも呼ばれます) を読み取るための操作を提供します。クライアント暗号化キーを作成および列挙する操作については、「」を参照してください Database 。 Azure Cosmos DB でのクライアント側暗号化のサポートの詳細については、「」を参照してください https://aka.ms/CosmosClientEncryption 。 |
ClientEncryptionKeyProperties |
Azure Cosmos DB サービスで使用する暗号化キーの詳細。 |
ClientEncryptionKeyResponse |
関連する要求に対する ClientEncryptionKey Cosmos DB サービスからの応答。 |
ClientEncryptionPolicy |
ClientEncryptionPolicyパーティション キーの一部である "id" プロパティまたはプロパティを暗号化する必要がある場合は、policyFormatVersion 2 と "Deterministic" 暗号化の種類で を初期化する必要があります。 すべてのパーティション キー プロパティ値は JSON 文字列である必要があります。 |
CompositePath |
複合パスの DOM。 複合パスは、複合インデックスで使用されます。 たとえば、"SELECT * FROM c ORDER BY c.age, c.height" などのクエリを実行する場合は、複合インデックスに複合パスとして "/age" と "/height" を追加する必要があります。 |
ConflictProperties |
Azure Cosmos DB サービスの競合を表します。 |
ConflictResolutionPolicy |
異なるリージョンからの書き込みが Azure Cosmos DB サービス内のコンテナー内の項目で競合する場合に、競合を解決する方法を指定するための競合解決ポリシー構成を表します。 |
Conflicts |
Azure Cosmos コンテナーでの競合の読み取り/クエリの操作。 |
Container |
ID によってコンテナー内の特定の既存のコンテナーまたは項目を読み取り、置換、または削除するための操作。2 種類の操作があります。
|
ContainerProperties |
Azure Cosmos DB サービスのドキュメント コンテナーを表します。 コンテナーは、ドキュメントの名前付き論理コンテナーです。 |
ContainerRequestOptions |
Cosmos コンテナー要求オプション |
ContainerResponse |
Cosmos コンテナーの応答 |
CosmosClient |
Azure Cosmos DB アカウントのクライアント側の論理表現を提供します。 このクライアントを使用して、Azure Cosmos DB データベース サービスで要求を構成および実行できます。 CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。 |
CosmosClientOptions |
CosmosClient に必要なすべての構成可能なオプションを定義します。 |
CosmosClientTelemetryOptions |
対応するしきい値と共にテレメトリと分散トレースを有効または無効にする Cosmos Client のテレメトリ オプション。 |
CosmosDiagnostics |
Azure Cosmos DB サービスに対する現在の要求の Cosmos 診断情報が含まれています。 |
CosmosException |
Cosmos クライアントの例外 |
CosmosLinqSerializerOptions |
このクラスは、Linq シリアル化プロパティを構成する方法を提供します |
CosmosOperationCanceledException |
スレッドが実行している操作のキャンセル時にスレッドにスローされる例外。 これにより、OperationCanceledException が拡張され、取り消された操作の診断が含まれます。 |
CosmosResponseFactory |
この応答ファクトリは、CosmosClient シリアライザーを使用して応答メッセージを対応する型の応答に変換します |
CosmosSerializationOptions |
このクラスは、基本的なシリアライザー設定を構成する方法を提供します。 |
CosmosSerializer |
これは、CosmosClient でカスタム シリアライザーを使用できるようにするためのインターフェイスです |
CosmosThresholdOptions |
分散トレースのしきい値 |
Database |
既存のデータベースの読み取りまたは削除のための操作。 Client新しいデータベースの作成と、すべてのデータベースの読み取り/クエリの実行については、 を使用 |
DatabaseProperties |
Azure Cosmos DB アカウント内のデータベースを表します。 |
DatabaseResponse |
Cosmos データベースの応答 |
DedicatedGatewayRequestOptions |
専用ゲートウェイ要求オプション |
EncryptionKeyWrapMetadata |
カスタマー マネージド キーを使用してデータ暗号化キーをラップまたはラップ解除するために使用できるメタデータ。 Azure Cosmos DB でのクライアント側暗号化のサポートの詳細については、「」を参照してください https://aka.ms/CosmosClientEncryption 。 |
ExcludedPath |
Azure Cosmos DB サービスのデータのインデックスを作成するときに除外する JSON ドキュメント内のパスを指定します。 |
FeedIterator |
クエリの結果を取得するときに継続トークンを追跡する Cosmos 結果セット反復子。 |
FeedIterator<T> |
クエリの結果を取得するときに継続トークンを追跡する Cosmos 結果セット反復子。 |
FeedRange |
並列処理の単位として使用できるフィード消費量の単位を表します。 |
FeedResponse<T> |
応答を型にシリアル化したさまざまなフィード応答のユーザー コントラクト。 型指定された応答の .NET 標準に従うためには、例外をユーザーにスローする必要があります。 |
GeospatialConfig |
Azure Cosmos DB サービスのコレクションの地理空間構成を表します |
Headers |
要求と応答に使用されるヘッダーの実装 |
IncludedPath |
Azure Cosmos DB サービスに含める JSON ドキュメント内のパスを指定します。 |
IndexingPolicy |
Azure Cosmos DB サービス内のコレクションのインデックス作成ポリシー構成を表します。 |
ItemRequestOptions |
Cosmos アイテム要求オプション |
ItemResponse<T> |
Cosmos 項目の応答 |
PartitionKeyBuilder |
Azure Cosmos DB サービスのパーティション キー値リストを表します。 |
PatchItemRequestOptions |
Cosmos Patch 要求オプション |
PatchOperation |
参照される Cosmos アイテムに適用される Patch 操作の詳細。 |
PatchOperation<T> |
値パラメーターを使用して PatchOperation を定義します。 |
Permission |
ID による特定のアクセス許可の読み取り、置換、または削除を行う操作。アクセス許可は、ResourceTokens の作成に使用されます。 リソース トークンは、データベース内のアプリケーション リソースへのアクセスを提供します。 リソース トークン:
|
PermissionProperties |
Azure Cosmos DB サービスのアクセス許可を表します。 |
PermissionResponse |
Cosmos アクセス許可の応答 |
QueryDefinition |
Cosmos SQL クエリを定義します |
QueryRequestOptions |
Cosmos クエリ要求オプション |
ReadManyRequestOptions |
Cosmos クエリ要求オプション |
Regions |
LocationNames クラスには、Azure Cosmos DB サービスで現在サポートされている Azure リージョンの名前が含まれています。 |
RequestHandler |
カスタム メッセージ ハンドラーの定義を可能にする抽象化。 |
RequestMessage |
Azure Cosmos DB SDK の処理パイプライン内の要求を表します。 |
RequestOptions |
既定の Cosmos 要求オプション |
Response<T> |
Cosmos リソース応答クラス |
ResponseMessage |
Azure Cosmos DB サービスからの応答を表します。 |
ServerSideCumulativeMetrics |
バックエンドからクエリに対して受信したメトリック。 |
ServerSideMetrics |
バックエンドからクエリに対して受信したメトリック。 |
ServerSidePartitionedMetrics |
1 つのパーティションに固有のサーバー側メトリックを表します。 |
SpatialPath |
空間インデックスの仕様 |
ThroughputProperties |
Azure Cosmos DB サービス内のリソースのスループットを表します。 これは、Azure Cosmos DB サービス内のリソースの標準価格です。 |
ThroughputResponse |
Cosmos スループット応答 |
TransactionalBatch |
Azure Cosmos DB サービスでトランザクション方式で実行されるコンテナー内の同じ PartitionKey 項目に対する操作のバッチを表します。 TransactionalBatch のインスタンスを作成するには、 を使用 CreateTransactionalBatch(PartitionKey) します。 |
TransactionalBatchItemRequestOptions |
RequestOptions 内 TransactionalBatchの操作に適用される 。 |
TransactionalBatchOperationResult |
要求の一部であった特定の操作の結果を TransactionalBatch 表します。 |
TransactionalBatchOperationResult<T> |
バッチの一部である特定の操作の結果を表します。 |
TransactionalBatchPatchItemRequestOptions |
Cosmos Batch Patch 要求オプション |
TransactionalBatchRequestOptions |
Cosmos バッチ要求オプション。 |
TransactionalBatchResponse |
要求の TransactionalBatch 応答。 |
UniqueKey |
Azure Cosmos DB サービスのコレクション内のドキュメントに一意性制約を適用する の一意キーを表します。 |
UniqueKeyPolicy |
Azure Cosmos DB サービスのコレクション内のドキュメントに対する一意性制約を指定するための一意キー ポリシー構成を表します。 |
User |
特定の既存のユーザーを ID で読み取り、置換、または削除し、ユーザーのアクセス許可を照会するための操作。 |
UserProperties |
Azure Cosmos DB サービスのユーザーを表します。 |
UserResponse |
Cosmos ユーザーの応答 |
構造体
PartitionKey |
Azure Cosmos DB サービスのパーティション キー値を表します。 |
列挙型
CompositePathSortOrder |
Azure Cosmos DB サービスのインデックス パス仕様のターゲット データ型を定義します。 |
ConflictResolutionMode |
で指定されているように、サポートされている競合解決モードを指定します ConflictResolutionPolicy |
ConnectionMode |
Azure Cosmos DB サービスに接続するときにクライアントが使用する接続モードを表します。 |
ConsistencyLevel |
これらは、Azure Cosmos DB サービスでサポートされている整合性レベルです。 |
CosmosPropertyNamingPolicy |
文字列ベースの名前を別の形式に変換するために使用する名前付けポリシーを決定します (最初の文字が小文字のキャメルケースなど)。 |
DataType |
Azure Cosmos DB サービスのインデックス パス仕様のターゲット データ型を定義します。 |
GeospatialType |
Azure Cosmos DB サービスでサポートされている地理空間の種類を指定します。 |
IndexingDirective |
Azure Cosmos DB データベース内のリソースにインデックスを作成するかどうかを指定します。 |
IndexingMode |
Azure Cosmos DB サービスでサポートされているインデックス作成モードを指定します。 |
IndexKind |
これらは、Azure Cosmos DB サービスのパスのインデックス作成に使用できるインデックス作成の種類です。 |
OperationKind |
これらは、リソースでバージョンの競合が発生した操作の種類です。 |
PartitionKeyDefinitionVersion |
パーティション分割バージョン。 |
PatchOperationType |
Patch でサポートされる操作の種類の一覧について説明します。 |
PermissionMode |
これらは、Azure Cosmos DB サービスでリソースを作成または置換 PermissionProperties するためのアクセス許可です。 |
PortReuseMode |
トランスポート スタックで使用されるポート再利用ポリシー オプション |
SpatialType |
Azure Cosmos DB サービスのインデックス パス仕様のターゲット データ型を定義します。 |
代理人
Container.ChangeFeedHandler<T> |
実行中に変更 ChangeFeedProcessor を受け取るデリゲート。 |
Container.ChangeFeedHandlerWithManualCheckpoint<T> |
手動チェックポイントを使用して、実行内で変更を ChangeFeedProcessor 受け取るデリゲート。 |
Container.ChangeFeedMonitorErrorDelegate |
変更フィード操作中にエラーを通知するデリゲート。 |
Container.ChangeFeedMonitorLeaseAcquireDelegate |
変更フィード プロセッサによって取得されたリースのイベントを通知するデリゲート。 |
Container.ChangeFeedMonitorLeaseReleaseDelegate |
変更フィード プロセッサによってリリースされるリースのイベントを通知するデリゲート。 |
Container.ChangeFeedStreamHandler |
実行中に変更 ChangeFeedProcessor を受け取るデリゲート。 |
Container.ChangeFeedStreamHandlerWithManualCheckpoint |
手動チェックポイントを使用して、実行内で変更を ChangeFeedProcessor 受け取るデリゲート。 |
Container.ChangesEstimationHandler |
関連付けられた ChangeFeedProcessor インスタンスによって読み取られる保留中の変更の推定を受け取るデリゲート。 |
Container.ChangesHandler<T> |
実行中に変更 ChangeFeedProcessor を受け取るデリゲート。 |
Azure SDK for .NET