Database.CreateContainerIfNotExistsAsync Método

Referencia

Definición

Espacio de nombres:: Microsoft.Azure.Cosmos

Ensamblado:: Microsoft.Azure.Cosmos.Client.dll

Paquete:: Microsoft.Azure.Cosmos v3.36.0

Importante

Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.

Sobrecargas

CreateContainerIfNotExistsAsync(ContainerProperties, ThroughputProperties, RequestOptions, CancellationToken)	Compruebe si existe un contenedor y, si no lo hace, créelo. Solo se usa el identificador de contenedor para comprobar si hay un contenedor existente. Otras propiedades de contenedor, como el rendimiento, no se validan y pueden ser diferentes a continuación, las propiedades pasadas.
CreateContainerIfNotExistsAsync(ContainerProperties, Nullable<Int32>, RequestOptions, CancellationToken)	Compruebe si existe un contenedor y, si no lo hace, créelo. Solo se usa el identificador de contenedor para comprobar si hay un contenedor existente. Otras propiedades de contenedor, como el rendimiento, no se validan y pueden ser diferentes a continuación, las propiedades pasadas.
CreateContainerIfNotExistsAsync(String, String, Nullable<Int32>, RequestOptions, CancellationToken)	Compruebe si existe un contenedor y, si no lo hace, créelo. Esto hará una operación de lectura y, si no se encuentra el contenedor, realizará una operación de creación.

CreateContainerIfNotExistsAsync(ContainerProperties, ThroughputProperties, RequestOptions, CancellationToken)

Compruebe si existe un contenedor y, si no lo hace, créelo. Solo se usa el identificador de contenedor para comprobar si hay un contenedor existente. Otras propiedades de contenedor, como el rendimiento, no se validan y pueden ser diferentes a continuación, las propiedades pasadas.

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)

Parámetros

containerProperties: ContainerProperties

Objeto ContainerProperties.

throughputProperties: ThroughputProperties

(Opcional) Rendimiento aprovisionado para un contenedor en medida de unidades de solicitudes por segundo en el servicio Azure Cosmos DB.

requestOptions: RequestOptions

(Opcional) Opciones de la solicitud.

cancellationToken: CancellationToken

(Opcional) CancellationToken que representa la cancelación de la solicitud.

Devoluciones

Task<ContainerResponse>

que Task contiene un ContainerResponse objeto que contiene ContainerProperties el registro de recursos de lectura.

StatusCode	Códigos de estado correctos comunes para la operación CreateDatabaseIfNotExistsAsync
201	Creado: se crea una nueva base de datos.
200	Ok: esto significa que la base de datos ya existe.

Excepciones

ArgumentNullException

Si alguno de los dos containerProperties no está establecido.

AggregateException

Representa una consolidación de errores que se produjeron durante el procesamiento asincrónico. Busque en InnerExceptions para buscar las excepciones reales.

CosmosException

Esta excepción puede encapsular muchos tipos diferentes de errores. Para determinar el error específico, examine siempre la propiedad StatusCode. Algunos códigos comunes que puede obtener al crear un contenedor son:

StatusCode	Motivo de la excepción
400	BadRequest: esto significa que algo estaba mal con la solicitud proporcionada. Es probable que no se haya proporcionado un identificador para el nuevo contenedor.
403	Prohibido: esto significa que ha intentado superar la cuota de los contenedores. Póngase en contacto con el soporte técnico para aumentar esta cuota.
409	Conflicto: significa que ContainerProperties un con un identificador que coincide con el identificador que proporcionó ya existía.

Ejemplos

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));

Se aplica a

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)

Parámetros

containerProperties: ContainerProperties

Objeto ContainerProperties.

throughput: Nullable<Int32>

(Opcional) Rendimiento aprovisionado para un contenedor en medida de unidades de solicitudes por segundo en el servicio Azure Cosmos DB.

requestOptions: RequestOptions

(Opcional) Opciones de la solicitud.

cancellationToken: CancellationToken

(Opcional) CancellationToken que representa la cancelación de la solicitud.

Devoluciones

Task<ContainerResponse>

que Task contiene un ContainerResponse objeto que contiene ContainerProperties el registro de recursos de lectura.

StatusCode	Códigos de estado correctos comunes para la operación CreateDatabaseIfNotExistsAsync
201	Creado: se crea una nueva base de datos.
200	Ok: esto significa que la base de datos ya existe.

Excepciones

ArgumentNullException

Si alguno de los dos containerProperties no está establecido.

AggregateException

Representa una consolidación de errores que se produjeron durante el procesamiento asincrónico. Busque en InnerExceptions para buscar las excepciones reales.

CosmosException

StatusCode	Motivo de la excepción
400	BadRequest: esto significa que algo estaba mal con la solicitud proporcionada. Es probable que no se haya proporcionado un identificador para el nuevo contenedor.
403	Prohibido: esto significa que ha intentado superar la cuota de los contenedores. Póngase en contacto con el soporte técnico para aumentar esta cuota.
409	Conflicto: significa que ContainerProperties un con un identificador que coincide con el identificador que proporcionó ya existía.

Ejemplos

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);

Comentarios

https://docs.microsoft.com/azure/cosmos-db/request-units para más información sobre el rendimiento de aprovisionamiento.

Se aplica a

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

Compruebe si existe un contenedor y, si no es así, créelo. Esto hará una operación de lectura y, si no se encuentra el contenedor, realizará una operación de creación.

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)

Parámetros

id: String

Identificador del contenedor de Cosmos

partitionKeyPath: String

Ruta de acceso a la clave de partición. Ejemplo: /location

throughput: Nullable<Int32>

(Opcional) Rendimiento aprovisionado para un contenedor en medida de unidades de solicitud por segundo en el servicio Azure Cosmos DB.

requestOptions: RequestOptions

(Opcional) Opciones de la solicitud.

cancellationToken: CancellationToken

(Opcional) CancellationToken que representa la cancelación de la solicitud.

Devoluciones

Task<ContainerResponse>

que Task contiene un ContainerResponse ContainerProperties objeto que contiene el registro de recursos de lectura.

Excepciones

ArgumentNullException

Si id no se establece.

AggregateException

Representa una consolidación de errores que se produjeron durante el procesamiento asincrónico. Busque en InnerExceptions para buscar las excepciones reales.

CosmosException

StatusCode	Motivo de la excepción
400	BadRequest: esto significa que algo estaba mal con la solicitud proporcionada. Es probable que no se haya proporcionado un identificador para el nuevo contenedor.
403	Prohibido: esto significa que ha intentado superar la cuota de los contenedores. Póngase en contacto con el soporte técnico para aumentar esta cuota.
409	Conflicto: significa que ContainerProperties un con un identificador que coincide con el identificador que proporcionó ya existía.

Ejemplos

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

Comentarios

https://docs.microsoft.com/azure/cosmos-db/request-units para más información sobre el rendimiento de aprovisionamiento.

Se aplica a

Compartir a través de

Database.CreateContainerIfNotExistsAsync Método

Definición

Sobrecargas

CreateContainerIfNotExistsAsync(ContainerProperties, ThroughputProperties, RequestOptions, CancellationToken)

Parámetros

Devoluciones

Excepciones

Ejemplos

Se aplica a

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

Parámetros

Devoluciones

Excepciones

Ejemplos

Comentarios

Se aplica a

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

Parámetros

Devoluciones

Excepciones

Ejemplos

Comentarios

Se aplica a

Recursos adicionales