Database.CreateContainerIfNotExistsAsync Méthode

Référence

Définition

Espace de noms:: Microsoft.Azure.Cosmos

Assembly:: Microsoft.Azure.Cosmos.Client.dll

Paquet:: Microsoft.Azure.Cosmos v3.36.0

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Surcharges

CreateContainerIfNotExistsAsync(ContainerProperties, ThroughputProperties, RequestOptions, CancellationToken)	Vérifiez si un conteneur existe et si ce n’est pas le cas, créez-le. Seul l’ID de conteneur est utilisé pour vérifier s’il existe un conteneur existant. D’autres propriétés de conteneur, telles que le débit, ne sont pas validées et peuvent être différentes des propriétés passées.
CreateContainerIfNotExistsAsync(ContainerProperties, Nullable<Int32>, RequestOptions, CancellationToken)	Vérifiez si un conteneur existe et si ce n’est pas le cas, créez-le. Seul l’ID de conteneur est utilisé pour vérifier s’il existe un conteneur existant. D’autres propriétés de conteneur, telles que le débit, ne sont pas validées et peuvent être différentes des propriétés passées.
CreateContainerIfNotExistsAsync(String, String, Nullable<Int32>, RequestOptions, CancellationToken)	Vérifiez si un conteneur existe et si ce n’est pas le cas, créez-le. Une opération de lecture est alors effectuée et, si le conteneur est introuvable, elle effectue une opération de création.

CreateContainerIfNotExistsAsync(ContainerProperties, ThroughputProperties, RequestOptions, CancellationToken)

Vérifiez si un conteneur existe et si ce n’est pas le cas, créez-le. Seul l’ID de conteneur est utilisé pour vérifier s’il existe un conteneur existant. D’autres propriétés de conteneur, telles que le débit, ne sont pas validées et peuvent être différentes des propriétés passées.

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)

Paramètres

containerProperties: ContainerProperties

Objet ContainerProperties.

throughputProperties: ThroughputProperties

(Facultatif) Débit provisionné pour un conteneur dans la mesure des unités de demandes par seconde dans le service Azure Cosmos DB.

requestOptions: RequestOptions

(Facultatif) Options de la demande.

cancellationToken: CancellationToken

(Facultatif) CancellationToken représentant l’annulation de la demande.

Retours

Task<ContainerResponse>

Task contenant un ContainerResponse qui encapsule un ContainerProperties contenant l’enregistrement de ressource de lecture.

StatusCode	Codes d’état de réussite courants pour l’opération CreateDatabaseIfNotExistsAsync
201	Créé : une nouvelle base de données est créée.
200	OK : cela signifie que la base de données existe déjà.

Exceptions

ArgumentNullException

Si l’un ou l’autre containerProperties n’est pas défini.

AggregateException

Représente une consolidation des échecs qui se sont produits pendant le traitement asynchrone. Recherchez la ou les exceptions réelles dans InnerExceptions.

CosmosException

Cette exception peut encapsuler de nombreux types d’erreurs différents. Pour déterminer l’erreur spécifique, examinez toujours la propriété StatusCode. Voici quelques codes courants que vous pouvez obtenir lors de la création d’un conteneur :

StatusCode	Raison de l’exception
400	BadRequest : cela signifie qu’il y a eu un problème avec la demande fournie. Il est probable qu’un ID n’a pas été fourni pour le nouveau conteneur.
403	Interdit : cela signifie que vous avez tenté de dépasser votre quota pour les conteneurs. Contactez le support technique pour augmenter ce quota.
409	Conflit : cela signifie qu’un ContainerProperties avec un ID correspondant à l’ID que vous avez fourni existait déjà.

Exemples

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

S’applique à

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)

Paramètres

containerProperties: ContainerProperties

Objet ContainerProperties.

throughput: Nullable<Int32>

(Facultatif) Débit provisionné pour un conteneur dans la mesure des unités de demandes par seconde dans le service Azure Cosmos DB.

requestOptions: RequestOptions

(Facultatif) Options de la demande.

cancellationToken: CancellationToken

(Facultatif) CancellationToken représentant l’annulation de la demande.

Retours

Task<ContainerResponse>

Task contenant un ContainerResponse qui encapsule un ContainerProperties contenant l’enregistrement de ressource de lecture.

StatusCode	Codes d’état de réussite courants pour l’opération CreateDatabaseIfNotExistsAsync
201	Créé : une nouvelle base de données est créée.
200	OK : cela signifie que la base de données existe déjà.

Exceptions

ArgumentNullException

Si l’un ou l’autre containerProperties n’est pas défini.

AggregateException

Représente une consolidation des échecs qui se sont produits pendant le traitement asynchrone. Recherchez la ou les exceptions réelles dans InnerExceptions.

CosmosException

StatusCode	Raison de l’exception
400	BadRequest : cela signifie qu’il y a eu un problème avec la demande fournie. Il est probable qu’un ID n’a pas été fourni pour le nouveau conteneur.
403	Interdit : cela signifie que vous avez tenté de dépasser votre quota pour les conteneurs. Contactez le support technique pour augmenter ce quota.
409	Conflit : cela signifie qu’un ContainerProperties avec un ID correspondant à l’ID que vous avez fourni existait déjà.

Exemples

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

Remarques

https://docs.microsoft.com/azure/cosmos-db/request-units pour plus d’informations sur le débit d’approvisionnement.

S’applique à

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

Vérifiez si un conteneur existe et si ce n’est pas le cas, créez-le. Une opération de lecture est alors effectuée et, si le conteneur est introuvable, elle effectue une opération de création.

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)

Paramètres

id: String

ID de conteneur Cosmos

partitionKeyPath: String

Chemin d’accès à la clé de partition. Exemple : /location

throughput: Nullable<Int32>

(Facultatif) Débit provisionné pour un conteneur dans la mesure des unités de requête par seconde dans le service Azure Cosmos DB.

requestOptions: RequestOptions

(Facultatif) Options de la demande.

cancellationToken: CancellationToken

(Facultatif) CancellationToken représentant l’annulation de la demande.

Retours

Task<ContainerResponse>

Task contenant un ContainerResponse qui encapsule un ContainerProperties contenant l’enregistrement de ressource de lecture.

Exceptions

ArgumentNullException

Si id n’est pas défini.

AggregateException

Représente une consolidation des échecs qui se sont produits pendant le traitement asynchrone. Recherchez la ou les exceptions réelles dans InnerExceptions.

CosmosException

StatusCode	Raison de l’exception
400	BadRequest : cela signifie qu’il y a eu un problème avec la demande fournie. Il est probable qu’un ID n’a pas été fourni pour le nouveau conteneur.
403	Interdit : cela signifie que vous avez tenté de dépasser votre quota pour les conteneurs. Contactez le support technique pour augmenter ce quota.
409	Conflit : cela signifie qu’un ContainerProperties avec un ID correspondant à l’ID que vous avez fourni existait déjà.

Exemples

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

Remarques

https://docs.microsoft.com/azure/cosmos-db/request-units pour plus d’informations sur le débit d’approvisionnement.

S’applique à

Partager via

Database.CreateContainerIfNotExistsAsync Méthode

Définition

Surcharges

CreateContainerIfNotExistsAsync(ContainerProperties, ThroughputProperties, RequestOptions, CancellationToken)

Paramètres

Retours

Exceptions

Exemples

S’applique à

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

Paramètres

Retours

Exceptions

Exemples

Remarques

S’applique à

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

Paramètres

Retours

Exceptions

Exemples

Remarques

S’applique à

Ressources supplémentaires