ContainerProperties クラス

定義

Azure Cosmos DB サービスのドキュメント コンテナーを表します。 コンテナーは、ドキュメントの名前付き論理コンテナーです。

public class ContainerProperties
type ContainerProperties = class
Public Class ContainerProperties
継承
ContainerProperties

次の例では、ユニットあたりの要求スループットが 50000 の新しいパーティション分割コンテナーを作成します。 パーティション キーは、このコンテナー内のすべてのドキュメントの最初のレベルの "country" プロパティです。

Container container = await client.GetDatabase("dbName").Containers.CreateAsync("MyCollection", "/country", 50000);
ContainerProperties containerProperties = container.Resource;

次の例では、カスタム インデックス作成ポリシーを使用して新しいコンテナーを作成します。

ContainerProperties containerProperties = new ContainerProperties("MyCollection", "/country");
containerProperties.IndexingPolicy.Automatic = true;
containerProperties.IndexingPolicy.IndexingMode = IndexingMode.Consistent;

CosmosContainerResponse containerCreateResponse = await client.GetDatabase("dbName").CreateContainerAsync(containerProperties, 50000);
ContainerProperties createdContainerProperties = containerCreateResponse.Container;

次の例では、このコンテナーを削除します。

Container container = client.GetDatabase("dbName").Containers["MyCollection"];
await container.DeleteAsync();

注釈

データベースには 0 個以上の名前付きコンテナーを含め、各コンテナーは 0 個以上の JSON ドキュメントで構成されます。 スキーマを使用しないため、コンテナー内のドキュメントは同じ構造またはフィールドを共有する必要はありません。 コンテナーはアプリケーション リソースであるため、マスター キーまたはリソース キーを使用して承認できます。

コンストラクター

ContainerProperties()

Azure Cosmos DB サービスの クラスの ContainerProperties 新しいインスタンスを初期化します。

ContainerProperties(String, IReadOnlyList<String>)

Azure Cosmos DB サービスの クラスの ContainerProperties 新しいインスタンスを初期化します。

ContainerProperties(String, String)

Azure Cosmos DB サービスの クラスの ContainerProperties 新しいインスタンスを初期化します。

プロパティ

AnalyticalStoreTimeToLiveInSeconds

Azure Cosmos サービスのコンテナー スコープでの分析ストアの有効期間を秒単位で取得または設定します。

有効になっている場合の分析ストアでは、コンテナー内のすべての項目の変更がキャプチャされます。 AnalyticalStoreTimeToLiveInSeconds は、分析ストアの変更の有効期間を定義します。

ClientEncryptionPolicy

Azure Cosmos サービスからコンテナーに項目を格納するためのクライアント暗号化ポリシー情報を取得または設定します。

ConflictResolutionPolicy

を取得または設定します。 ConflictResolutionPolicy

DefaultTimeToLive

Azure Cosmos サービスのコンテナー内の項目の既定の有効期間を秒単位で取得または設定します。

ETag

Azure Cosmos DB サービスから、リソースに関連付けられているエンティティ タグを取得します。

GeospatialConfig

GeospatialConfig Azure Cosmos DB サービスからコレクションに関連付けられている を取得します。

Id

Azure Cosmos DB サービス内のリソースの ID を取得または設定します。

IndexingPolicy

IndexingPolicy Azure Cosmos DB サービスからコンテナーに関連付けられている を取得します。

LastModified

Azure Cosmos DB サービスから に ContainerProperties 関連付けられている最後に変更されたタイム スタンプを取得します。

PartitionKeyDefinitionVersion

を取得または設定します。 PartitionKeyDefinitionVersion

パーティション キー定義バージョン 1 では、パーティション キーの最初の 100 バイトに基づいてハッシュを計算するハッシュ関数が使用されます。 これにより、パーティション キーが 100 バイトを超えるドキュメントの競合が発生する可能性があります。

パーティション キー定義バージョン 2 では、パーティション キーの最初の 2 KB に基づいてハッシュを計算するハッシュ関数が使用されます。

PartitionKeyPath

コンテナーのパーティション分割に使用される JSON パス

PartitionKeyPaths

階層パーティション キーを持つコンテナーに使用される JSON パスの一覧

SelfLink

Azure Cosmos DB サービスから、リソースに関連付けられているセルフリンクを取得します。

TimeToLivePropertyPath
古い.

ベース タイム スタンプ プロパティ パスの有効期間を取得または設定します。

UniqueKeyPolicy

Azure Cosmos DB サービスの UniqueKeyPolicy コンテナー内のドキュメントの一意性を保証する を取得または設定します。

適用対象

こちらもご覧ください