Freigeben über

DocumentClient.CreateDocumentCollectionIfNotExistsAsync Methode

  • Referenz

Definition

Namespace:
Microsoft.Azure.Documents.Client
Assemblys:
Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll
Pakete:
Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Überlädt

CreateDocumentCollectionIfNotExistsAsync(Uri, DocumentCollection, RequestOptions)

Erstellt (wenn nicht vorhanden) oder ruft (falls bereits vorhanden) eine Sammlung als asychronen Vorgang im Azure Cosmos DB-Dienst ab.
CreateDocumentCollectionIfNotExistsAsync(String, DocumentCollection, RequestOptions)

Erstellt (falls nicht vorhanden) oder ruft (falls bereits vorhanden) eine Sammlung als aychronen Vorgang im Azure Cosmos DB-Dienst ab. Sie können den status Code aus der Antwort überprüfen, um festzustellen, ob die Sammlung neu erstellt wurde (201) oder ob eine vorhandene Sammlung zurückgegeben wurde (200).

CreateDocumentCollectionIfNotExistsAsync(Uri, DocumentCollection, RequestOptions)

Erstellt (wenn nicht vorhanden) oder ruft (falls bereits vorhanden) eine Sammlung als asychronen Vorgang im Azure Cosmos DB-Dienst ab.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>> CreateDocumentCollectionIfNotExistsAsync (Uri databaseUri, Microsoft.Azure.Documents.DocumentCollection documentCollection, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member CreateDocumentCollectionIfNotExistsAsync : Uri * Microsoft.Azure.Documents.DocumentCollection * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>>
override this.CreateDocumentCollectionIfNotExistsAsync : Uri * Microsoft.Azure.Documents.DocumentCollection * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>>
Public Function CreateDocumentCollectionIfNotExistsAsync (databaseUri As Uri, documentCollection As DocumentCollection, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of DocumentCollection))

Parameter

databaseUri
Uri

der URI der Datenbank, in der die Auflistung erstellt werden soll.

documentCollection
DocumentCollection

Das DocumentCollection-Objekt.

options
RequestOptions

(Optional) Alle RequestOptions , die Sie beim Erstellen einer Sammlung angeben möchten. Z.B. RequestOptions.OfferThroughput = 400.

Gibt zurück

Task<ResourceResponse<DocumentCollection>>

Die DocumentCollection erstellte , die in einem Task -Objekt enthalten ist, das die Dienstantwort für den asynchronen Vorgang darstellt.

Implementiert

CreateDocumentCollectionIfNotExistsAsync(Uri, DocumentCollection, RequestOptions)

Gilt für:

CreateDocumentCollectionIfNotExistsAsync(String, DocumentCollection, RequestOptions)

Erstellt (falls nicht vorhanden) oder ruft (falls bereits vorhanden) eine Sammlung als aychronen Vorgang im Azure Cosmos DB-Dienst ab. Sie können den status Code aus der Antwort überprüfen, um festzustellen, ob die Sammlung neu erstellt wurde (201) oder ob eine vorhandene Sammlung zurückgegeben wurde (200).

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>> CreateDocumentCollectionIfNotExistsAsync (string databaseLink, Microsoft.Azure.Documents.DocumentCollection documentCollection, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member CreateDocumentCollectionIfNotExistsAsync : string * Microsoft.Azure.Documents.DocumentCollection * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>>
override this.CreateDocumentCollectionIfNotExistsAsync : string * Microsoft.Azure.Documents.DocumentCollection * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>>
Public Function CreateDocumentCollectionIfNotExistsAsync (databaseLink As String, documentCollection As DocumentCollection, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of DocumentCollection))

Parameter

databaseLink
String

Der Link der Datenbank, in der die Sammlung erstellt werden soll. Beispiel: dbs/db_rid/.

documentCollection
DocumentCollection

Das DocumentCollection-Objekt.

options
RequestOptions

(Optional) Alle RequestOptions , die Sie beim Erstellen einer Sammlung angeben möchten. Z.B. RequestOptions.OfferThroughput = 400.

Gibt zurück

Task<ResourceResponse<DocumentCollection>>

Die DocumentCollection erstellte , die in einem Task -Objekt enthalten ist, das die Dienstantwort für den asynchronen Vorgang darstellt.

Implementiert

CreateDocumentCollectionIfNotExistsAsync(String, DocumentCollection, RequestOptions)

Ausnahmen

ArgumentNullException

Wenn oder databaseLinkdocumentCollection nicht festgelegt ist.

AggregateException

Stellt eine Konsolidierung von Fehlern dar, die während der asynchronen Verarbeitung aufgetreten sind. Suchen Sie in InnerExceptions nach den tatsächlichen Ausnahmen.

DocumentClientException

Diese Ausnahme kann viele verschiedene Fehlertypen kapseln. Um den spezifischen Fehler zu ermitteln, sehen Sie sich immer die StatusCode-Eigenschaft an. Einige häufige Codes, die Sie beim Erstellen einer DocumentCollection erhalten können, sind:

StatusCodeGrund für die Ausnahme
400BadRequest: Dies bedeutet, dass mit der bereitgestellten Anforderung ein Fehler aufgetreten ist. Es ist wahrscheinlich, dass für die neue Auflistung keine ID angegeben wurde.
403Verboten: Dies bedeutet, dass Sie versucht haben, Ihr Kontingent für Sammlungen zu überschreiten. Wenden Sie sich an den Support, um dieses Kontingent zu erhöhen.

Beispiele

using (IDocumentClient client = new DocumentClient(new Uri("service endpoint"), "auth key"))
{
    //Create a new collection with an OfferThroughput set to 10000
    //Not passing in RequestOptions.OfferThroughput will result in a collection with the default OfferThroughput set.
    DocumentCollection coll = await client.CreateDocumentCollectionIfNotExistsAsync(databaseLink,
        new DocumentCollection { Id = "My Collection" },
        new RequestOptions { OfferThroughput = 10000} );
}

Weitere Informationen

Gilt für: