Database.CreateUserAsync(String, RequestOptions, CancellationToken) Methode

Referenz

Definition

Namespace:: Microsoft.Azure.Cosmos

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

Paket:: Microsoft.Azure.Cosmos v3.36.0

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Erstellt einen Benutzer als asynchronen Vorgang im Azure Cosmos-Dienst.

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.UserResponse> CreateUserAsync (string id, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateUserAsync : string * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.UserResponse>

Public MustOverride Function CreateUserAsync (id As String, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of UserResponse)

Parameter

id: String

Die Cosmos-Benutzer-ID

requestOptions: RequestOptions

(Optional) Die Optionen für die Benutzeranforderung.

cancellationToken: CancellationToken

(Optional) CancellationToken stellt den Anforderungsabbruch dar.

Gibt zurück

Task<UserResponse>

Eine Task , die ein UserResponse enthält, das einen UserProperties umschließt, der den gelesenen Ressourcendatensatz enthält.

Ausnahmen

ArgumentNullException

Wenn id nicht festgelegt ist.

CosmosException

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 eines Benutzers erhalten können, sind:

StatusCode	Grund für die Ausnahme
400	BadRequest: Dies bedeutet, dass mit der bereitgestellten Anforderung ein Fehler aufgetreten ist. Es ist wahrscheinlich, dass für den neuen Benutzer keine ID angegeben wurde.
409	Konflikt: Dies bedeutet, dass ein UserProperties mit einer ID übereinstimmt, die der von Ihnen angegebenen ID entspricht, bereits vorhanden ist.

Beispiele

UserResponse response = await this.cosmosDatabase.CreateUserAsync(Guid.NewGuid().ToString());

Gilt für:

Share via