Database.CreateUserAsync(String, RequestOptions, CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.Azure.Cosmos

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

Package:: Microsoft.Azure.Cosmos v3.39.0

Source:: Database.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Creates a user as an asynchronous operation in the Azure Cosmos service.

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)

Parameters

id: String

The Cosmos user id

requestOptions: RequestOptions

(Optional) The options for the user request.

cancellationToken: CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

Task<UserResponse>

A Task containing a UserResponse which wraps a UserProperties containing the read resource record.

Examples

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

Applies to