Database.CreateUserAsync(String, RequestOptions, CancellationToken) Méthode

Définition

Espace de noms:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Paquet:

Microsoft.Azure.Cosmos v3.36.0

Crée un utilisateur en tant qu’opération asynchrone dans le service Azure Cosmos.

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)

Paramètres

id

String

ID d’utilisateur Cosmos

requestOptions

RequestOptions

(Facultatif) Options de la demande de l’utilisateur.

cancellationToken

CancellationToken

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

Retours

Task<UserResponse>

Task contenant un UserResponse qui encapsule un UserProperties contenant l’enregistrement de ressource de lecture.

Exceptions

ArgumentNullException

Si id n’est pas défini.

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 utilisateur :

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 nouvel utilisateur.
409	Conflit : cela signifie qu’un UserProperties avec un ID correspondant à l’ID que vous avez fourni existait déjà.

Exemples

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