Database.UpsertUserAsync(String, RequestOptions, CancellationToken) Methode

Definition

Namespace:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Paket:

Microsoft.Azure.Cosmos v3.36.0

Führt einen Benutzer als asynchronen Vorgang im Azure Cosmos-Dienst durch.

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

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

Public MustOverride Function UpsertUserAsync (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 die Anforderungsabbruch dar.

Gibt zurück

Task<UserResponse>

Eine Task , die einen UserResponse enthält, der einen UserProperties umschließt, der den Leseressourcendatensatz 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 allgemeine Codes, die Sie beim Erstellen eines Benutzers erhalten, sind:

StatusCode	Ausnahmegrund
400	BadRequest: Dies bedeutet, dass mit der bereitgestellten Anforderung etwas nicht stimmte. Es ist wahrscheinlich, dass für den neuen Benutzer keine ID angegeben wurde.

Beispiele

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