CosmosDatabase.CreateContainerAsync Método

Definição

Namespace:

Azure.Cosmos

Assembly:

Azure.Cosmos.dll

Pacote:

Azure.Cosmos v4.0.0-preview3

Sobrecargas

CreateContainerAsync(ContainerProperties, Nullable<Int32>, RequestOptions, CancellationToken)	Cria um contêiner como uma operação assíncrona no serviço do Azure Cosmos.
CreateContainerAsync(String, String, Nullable<Int32>, RequestOptions, CancellationToken)	Cria um contêiner como uma operação assíncrona no serviço do Azure Cosmos.

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

Cria um contêiner como uma operação assíncrona no serviço do Azure Cosmos.

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

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

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

Parâmetros

containerProperties

ContainerProperties

O objeto ContainerProperties.

throughput

Nullable<Int32>

(Opcional) A taxa de transferência provisionada para um contêiner na medição de Unidades de Solicitações por segundo no serviço do Azure Cosmos DB.

requestOptions

RequestOptions

(Opcional) As opções para a solicitação de contêiner RequestOptions

cancellationToken

CancellationToken

(Opcional) CancellationToken que representa o cancelamento da solicitação.

Retornos

Task<ContainerResponse>

Um Task que contém um Response que encapsula um ContainerProperties que contém o registro de recurso de leitura.

Exceções

ArgumentNullException

Se um dos dois containerProperties não estiver definido.

AggregateException

Representa uma consolidação de falhas que ocorreram durante o processamento assíncrono. Procure em InnerExceptions para localizar as exceções reais.

CosmosException

Essa exceção pode encapsular muitos tipos diferentes de erros. Para determinar o erro específico, sempre examine a propriedade StatusCode. Alguns códigos comuns que você pode obter ao criar um contêiner são:

StatusCode	Motivo da exceção
400	BadRequest - Isso significa que algo estava errado com a solicitação fornecida. É provável que uma ID não tenha sido fornecida para o novo contêiner.
403	Proibido – isso significa que você tentou exceder sua cota de contêineres. Entre em contato com o suporte para aumentar essa cota.
409	Conflito – isso significa que um com uma ContainerProperties ID correspondente à ID que você forneceu já existia.

Exemplos

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

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

Comentários

https://docs.microsoft.com/azure/cosmos-db/request-units para obter detalhes sobre a taxa de transferência de provisionamento.

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

Cria um contêiner como uma operação assíncrona no serviço do Azure Cosmos.

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

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

Public MustOverride Function CreateContainerAsync (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)

Parâmetros

id

String

A ID do contêiner do Cosmos

partitionKeyPath

String

O caminho para a chave de partição. Exemplo: /location

throughput

Nullable<Int32>

(Opcional) A taxa de transferência provisionada para um contêiner na medição de Unidades de Solicitações por segundo no serviço do Azure Cosmos DB.

requestOptions

RequestOptions

(Opcional) As opções para a solicitação de contêiner RequestOptions

cancellationToken

CancellationToken

(Opcional) CancellationToken que representa o cancelamento da solicitação.

Retornos

Task<ContainerResponse>

Um Task que contém um Response que encapsula um ContainerProperties que contém o registro de recurso de leitura.

Exceções

ArgumentNullException

Se id não estiver definido.

AggregateException

Representa uma consolidação de falhas que ocorreram durante o processamento assíncrono. Procure em InnerExceptions para localizar as exceções reais.

CosmosException

Essa exceção pode encapsular muitos tipos diferentes de erros. Para determinar o erro específico, sempre examine a propriedade StatusCode. Alguns códigos comuns que você pode obter ao criar um contêiner são:

StatusCode	Motivo da exceção
400	BadRequest - Isso significa que algo estava errado com a solicitação fornecida. É provável que uma ID não tenha sido fornecida para o novo contêiner.
403	Proibido – isso significa que você tentou exceder sua cota de contêineres. Entre em contato com o suporte para aumentar essa cota.
409	Conflito – isso significa que um com uma ContainerProperties ID correspondente à ID que você forneceu já existia.

Exemplos

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

Comentários

https://docs.microsoft.com/azure/cosmos-db/request-units para obter detalhes sobre a taxa de transferência de provisionamento.