CosmosUser Class

Definition

Operations for reading, replacing, or deleting a specific existing user by id and query a user's permissions.

public abstract class CosmosUser
type CosmosUser = class
Public MustInherit Class CosmosUser
Inheritance
System.Object
CosmosUser

Constructors

CosmosUser()

Properties

Id

The Id of the Cosmos user

Methods

CreatePermissionAsync(PermissionProperties, Nullable<Int32>, RequestOptions, CancellationToken)

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

DeleteAsync(RequestOptions, CancellationToken)

Delete a UserProperties from the Azure Cosmos DB service as an asynchronous operation.

GetPermission(String)

Returns a reference to a permission object.

GetPermissionQueryIterator<T>(QueryDefinition, String, QueryRequestOptions, CancellationToken)

This method creates a query for permissions under a database using a SQL statement. It returns a FeedIterator. For more information on preparing SQL statements with parameterized values, please see QueryDefinition overload.

GetPermissionQueryIterator<T>(String, String, QueryRequestOptions, CancellationToken)

This method creates a query for permission under a user using a SQL statement. It returns a FeedIterator. For more information on preparing SQL statements with parameterized values, please see QueryDefinition overload.

ReadAsync(RequestOptions, CancellationToken)

Reads a UserProperties from the Azure Cosmos service as an asynchronous operation.

ReplaceAsync(UserProperties, RequestOptions, CancellationToken)

Replace a UserProperties from the Azure Cosmos service as an asynchronous operation.

UpsertPermissionAsync(PermissionProperties, Nullable<Int32>, RequestOptions, CancellationToken)

Upsert a permission as an asynchronous operation in the Azure Cosmos service.

Applies to