Database.GetUser(String) Method

Definition

Returns a reference to a user object.

public abstract Microsoft.Azure.Cosmos.User GetUser (string id);
abstract member GetUser : string -> Microsoft.Azure.Cosmos.User
Public MustOverride Function GetUser (id As String) As User

Parameters

id
String

The Cosmos user id.

Returns

Cosmos user reference

Examples

Database db = this.cosmosClient.GetDatabase("myDatabaseId");
User user = await db.GetUser("userId");
UserResponse response = await user.ReadAsync();

Remarks

Returns a User reference. Reference doesn't guarantee existence. Please ensure user already exists or is created through a create operation.

Applies to