Database.CreateContainerIfNotExistsAsync メソッド

リファレンス

定義

名前空間:: Microsoft.Azure.Cosmos

アセンブリ:: Microsoft.Azure.Cosmos.Client.dll

パッケージ:: Microsoft.Azure.Cosmos v3.36.0

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

オーバーロード

CreateContainerIfNotExistsAsync(ContainerProperties, ThroughputProperties, RequestOptions, CancellationToken)	コンテナーが存在するかどうかを確認し、存在しない場合は作成します。コンテナー ID のみが、既存のコンテナーがあるかどうかを確認するために使用されます。スループットなどの他のコンテナープロパティは検証されず、渡されたプロパティとは異なる場合があります。
CreateContainerIfNotExistsAsync(ContainerProperties, Nullable<Int32>, RequestOptions, CancellationToken)	コンテナーが存在するかどうかを確認し、存在しない場合は作成します。コンテナー ID のみが、既存のコンテナーがあるかどうかを確認するために使用されます。スループットなどの他のコンテナープロパティは検証されず、渡されたプロパティとは異なる場合があります。
CreateContainerIfNotExistsAsync(String, String, Nullable<Int32>, RequestOptions, CancellationToken)	コンテナーが存在するかどうかを確認し、存在しない場合は作成します。これにより読み取り操作が行われ、コンテナーが見つからない場合は作成操作が実行されます。

CreateContainerIfNotExistsAsync(ContainerProperties, ThroughputProperties, RequestOptions, CancellationToken)

コンテナーが存在するかどうかを確認し、存在しない場合は作成します。コンテナー ID のみが、既存のコンテナーがあるかどうかを確認するために使用されます。スループットなどの他のコンテナープロパティは検証されず、渡されたプロパティとは異なる場合があります。

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse> CreateContainerIfNotExistsAsync (Microsoft.Azure.Cosmos.ContainerProperties containerProperties, Microsoft.Azure.Cosmos.ThroughputProperties throughputProperties, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateContainerIfNotExistsAsync : Microsoft.Azure.Cosmos.ContainerProperties * Microsoft.Azure.Cosmos.ThroughputProperties * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse>

Public MustOverride Function CreateContainerIfNotExistsAsync (containerProperties As ContainerProperties, throughputProperties As ThroughputProperties, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ContainerResponse)

パラメーター

containerProperties: ContainerProperties

ContainerProperties オブジェクト。

throughputProperties: ThroughputProperties

(省略可能)Azure Cosmos DB サービスの 1 秒あたりの要求ユニット数の測定でコンテナーにプロビジョニングされるスループット。

requestOptions: RequestOptions

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

cancellationToken: CancellationToken

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

戻り値

Task<ContainerResponse>

Task読み取りリソースレコードをContainerResponse含むをContainerPropertiesラップするを含む。

StatusCode	CreateDatabaseIfNotExistsAsync 操作の一般的な成功の StatusCodes
201	作成済み - 新しいデータベースが作成されます。
200	OK - データベースが既に存在します。

例外

ArgumentNullException

どちらか containerProperties が設定されていない場合。

AggregateException

非同期処理中に発生したエラーの統合を表します。 InnerExceptions 内を見て、実際の例外を見つけます。

CosmosException

この例外は、さまざまな種類のエラーをカプセル化できます。特定のエラーを特定するには、常に StatusCode プロパティを参照してください。コンテナーの作成時に取得できる一般的なコードは次のとおりです。

StatusCode	例外の理由
400	BadRequest - これは、指定された要求に何らかの問題が発生したことを意味します。新しいコンテナーに ID が指定されていない可能性があります。
403	禁止 - これは、コンテナーのクォータを超えようとしたことを意味します。このクォータを増やすには、サポートにお問い合わせください。
409	競合 - これは、指定した ID と一致する ID が既に存在するを意味 ContainerProperties します。

例

ContainerProperties containerProperties = new ContainerProperties()
{
    Id = Guid.NewGuid().ToString(),
    PartitionKeyPath = "/pk",
    IndexingPolicy = new IndexingPolicy()
   {
        Automatic = false,
        IndexingMode = IndexingMode.Lazy,
   }
};

ContainerResponse response = await this.cosmosDatabase.CreateContainerIfNotExistsAsync(
     containerProperties,
     ThroughputProperties.CreateAutoscaleThroughput(5000));

適用対象

CreateContainerIfNotExistsAsync(ContainerProperties, Nullable<Int32>, RequestOptions, CancellationToken)

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse> CreateContainerIfNotExistsAsync (Microsoft.Azure.Cosmos.ContainerProperties containerProperties, int? throughput = default, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateContainerIfNotExistsAsync : Microsoft.Azure.Cosmos.ContainerProperties * Nullable<int> * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse>

Public MustOverride Function CreateContainerIfNotExistsAsync (containerProperties As ContainerProperties, Optional throughput As Nullable(Of Integer) = Nothing, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ContainerResponse)

パラメーター

containerProperties: ContainerProperties

ContainerProperties オブジェクト。

throughput: Nullable<Int32>

(省略可能)Azure Cosmos DB サービスの 1 秒あたりの要求ユニット数の測定でコンテナーにプロビジョニングされるスループット。

requestOptions: RequestOptions

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

cancellationToken: CancellationToken

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

戻り値

Task<ContainerResponse>

Task読み取りリソースレコードをContainerResponse含むをContainerPropertiesラップするを含む。

StatusCode	CreateDatabaseIfNotExistsAsync 操作の一般的な成功の StatusCodes
201	作成済み - 新しいデータベースが作成されます。
200	OK - データベースが既に存在します。

例外

ArgumentNullException

どちらか containerProperties が設定されていない場合。

AggregateException

非同期処理中に発生したエラーの統合を表します。 InnerExceptions 内を見て、実際の例外を見つけます。

CosmosException

StatusCode	例外の理由
400	BadRequest - これは、指定された要求に何らかの問題が発生したことを意味します。新しいコンテナーに ID が指定されていない可能性があります。
403	禁止 - これは、コンテナーのクォータを超えようとしたことを意味します。このクォータを増やすには、サポートにお問い合わせください。
409	競合 - これは、指定した ID と一致する ID が既に存在するを意味 ContainerProperties します。

例

ContainerProperties containerProperties = new ContainerProperties()
{
    Id = Guid.NewGuid().ToString(),
    PartitionKeyPath = "/pk",
    IndexingPolicy = new IndexingPolicy()
   {
        Automatic = false,
        IndexingMode = IndexingMode.Lazy,
   }
};

ContainerResponse response = await this.cosmosDatabase.CreateContainerIfNotExistsAsync(containerProperties);

注釈

https://docs.microsoft.com/azure/cosmos-db/request-units プロビジョニングスループットの詳細については、

適用対象

CreateContainerIfNotExistsAsync(String, String, Nullable<Int32>, RequestOptions, CancellationToken)

コンテナーが存在するかどうかを確認し、存在しない場合は作成します。これにより読み取り操作が行われ、コンテナーが見つからない場合は作成操作が実行されます。

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse> CreateContainerIfNotExistsAsync (string id, string partitionKeyPath, int? throughput = default, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateContainerIfNotExistsAsync : string * string * Nullable<int> * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse>

Public MustOverride Function CreateContainerIfNotExistsAsync (id As String, partitionKeyPath As String, Optional throughput As Nullable(Of Integer) = Nothing, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ContainerResponse)

パラメーター

id: String

Cosmos コンテナー ID

partitionKeyPath: String

パーティションキーへのパス。例: /location

throughput: Nullable<Int32>

(省略可能)Azure Cosmos DB サービスの 1 秒あたりの要求ユニット数の測定でコンテナーにプロビジョニングされるスループット。

requestOptions: RequestOptions

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

cancellationToken: CancellationToken

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

戻り値

Task<ContainerResponse>

Task読み取りリソースレコードをContainerResponse含むをContainerPropertiesラップするを含む。

例外

ArgumentNullException

が設定されていない場合 id 。

AggregateException

非同期処理中に発生したエラーの統合を表します。 InnerExceptions 内を見て、実際の例外を見つけます。

CosmosException

StatusCode	例外の理由
400	BadRequest - これは、指定された要求に何らかの問題が発生したことを意味します。新しいコンテナーに ID が指定されていない可能性があります。
403	禁止 - これは、コンテナーのクォータを超えようとしたことを意味します。このクォータを増やすには、サポートにお問い合わせください。
409	競合 - これは、指定した ID と一致する ID が既に存在するを意味 ContainerProperties します。

例

ContainerResponse response = await this.cosmosDatabase.CreateContainerIfNotExistsAsync(Guid.NewGuid().ToString(), "/pk");

注釈

https://docs.microsoft.com/azure/cosmos-db/request-units プロビジョニングスループットの詳細については、

適用対象

Database.CreateContainerIfNotExistsAsync メソッド

定義

オーバーロード

CreateContainerIfNotExistsAsync(ContainerProperties, ThroughputProperties, RequestOptions, CancellationToken)

パラメーター

戻り値

例外

例

適用対象

CreateContainerIfNotExistsAsync(ContainerProperties, Nullable<Int32>, RequestOptions, CancellationToken)

パラメーター

戻り値

例外

例

注釈

適用対象

CreateContainerIfNotExistsAsync(String, String, Nullable<Int32>, RequestOptions, CancellationToken)

パラメーター

戻り値

例外

例

注釈

適用対象

フィードバック

その他のリソース