DocumentClient.CreateDocumentCollectionAsync Methode

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

CreateDocumentCollectionAsync(String, DocumentCollection, RequestOptions)	Erstellt eine Sammlung als asychronen Vorgang im Azure Cosmos DB-Dienst.
CreateDocumentCollectionAsync(Uri, DocumentCollection, RequestOptions)	Erstellt eine Sammlung als asychronen Vorgang im Azure Cosmos DB-Dienst.

CreateDocumentCollectionAsync(String, DocumentCollection, RequestOptions)

Erstellt eine Sammlung als asychronen Vorgang im Azure Cosmos DB-Dienst.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>> CreateDocumentCollectionAsync (string databaseLink, Microsoft.Azure.Documents.DocumentCollection documentCollection, Microsoft.Azure.Documents.Client.RequestOptions options = default);

abstract member CreateDocumentCollectionAsync : 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.CreateDocumentCollectionAsync : 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 CreateDocumentCollectionAsync (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 Auflistung 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>>

Das DocumentCollection erstellt wurde, das in einem Task Objekt enthalten ist, das die Dienstantwort für den asynchronen Vorgang darstellt.

Implementiert

CreateDocumentCollectionAsync(String, DocumentCollection, RequestOptions)

Ausnahmen

ArgumentNullException

Wenn entweder databaseLink oder documentCollection 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 Sammlung erhalten, sind:

StatusCode	Ausnahmegrund
400	BadRequest: Dies bedeutet, dass mit der bereitgestellten Anforderung etwas nicht stimmte. Es ist wahrscheinlich, dass für die neue Auflistung keine ID angegeben wurde.
403	Verboten: 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.
409	Konflikt: Dies bedeutet, dass eine DocumentCollection mit einer ID übereinstimmt, die der von Ihnen angegebenen ID entspricht, bereits vorhanden ist.

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.CreateDocumentCollectionAsync(databaseLink,
        new DocumentCollection { Id = "My Collection" },
        new RequestOptions { OfferThroughput = 10000} );
}

Weitere Informationen

• RequestOptions
• ResourceResponse<TResource>
• Task
• DocumentCollection
• OfferV2

CreateDocumentCollectionAsync(Uri, DocumentCollection, RequestOptions)

Erstellt eine Sammlung als asychronen Vorgang im Azure Cosmos DB-Dienst.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>> CreateDocumentCollectionAsync (Uri databaseUri, Microsoft.Azure.Documents.DocumentCollection documentCollection, Microsoft.Azure.Documents.Client.RequestOptions options = default);

abstract member CreateDocumentCollectionAsync : 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.CreateDocumentCollectionAsync : 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 CreateDocumentCollectionAsync (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 Microsoft.Azure.Documents.DocumentCollection-Objekt.

options

RequestOptions

Die Anforderungsoptionen für die Anforderung.

Gibt zurück

Task<ResourceResponse<DocumentCollection>>

Das Taskobjekt, das die Dienstantwort für den asynchronen Vorgang darstellt.

Implementiert

CreateDocumentCollectionAsync(Uri, DocumentCollection, RequestOptions)