Users class
Wordt gebruikt om alle gebruikers te maken, upsert, query's uit te voeren en te lezen.
Zie Gebruiker een specifieke gebruiker lezen, vervangen of verwijderen op id.
Eigenschappen
| database |
Methoden
| create(User |
Maak een databasegebruiker met de opgegeven UserDefinition-. voorbeeld van
|
| query(Sql |
Voer een query uit op alle gebruikers. |
| query<T>(Sql |
Voer een query uit op alle gebruikers. voorbeeld van Query op de gebruiker met id.
|
| read |
Alle gebruikers lezen.- voorbeeld van Lees alle gebruikers naar matrix.
|
| upsert(User |
Upsert een databasegebruiker met een opgegeven UserDefinition. voorbeeld van
|
Eigenschapdetails
database
Methodedetails
create(UserDefinition, RequestOptions)
Maak een databasegebruiker met de opgegeven UserDefinition-.
voorbeeld van
import { CosmosClient } from "@azure/cosmos";
const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const { database } = await client.databases.createIfNotExists({ id: "Test Database" });
await database.users.create({ id: "<user-id>" });
function create(body: UserDefinition, options?: RequestOptions): Promise<UserResponse>
Parameters
- body
- UserDefinition
De opgegeven UserDefinition-.
- options
- RequestOptions
Retouren
Promise<UserResponse>
query(SqlQuerySpec, FeedOptions)
Voer een query uit op alle gebruikers.
function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>
Parameters
- query
- SqlQuerySpec
Queryconfiguratie voor de bewerking. Zie SqlQuerySpec- voor meer informatie over het configureren van een query.
- options
- FeedOptions
Retouren
QueryIterator<any>
query<T>(SqlQuerySpec, FeedOptions)
Voer een query uit op alle gebruikers.
voorbeeld van
Query op de gebruiker met id.
import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";
const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const { database } = await client.databases.createIfNotExists({ id: "Test Database" });
const querySpec: SqlQuerySpec = {
query: `SELECT * FROM root r WHERE r.id = @user`,
parameters: [{ name: "@user", value: "<user-id>" }],
};
const { resources: permisssion } = await database.users.query(querySpec).fetchAll();
function query<T>(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<T>
Parameters
- query
- SqlQuerySpec
Queryconfiguratie voor de bewerking. Zie SqlQuerySpec- voor meer informatie over het configureren van een query.
- options
- FeedOptions
Retouren
readAll(FeedOptions)
Alle gebruikers lezen.-
voorbeeld van
Lees alle gebruikers naar matrix.
import { CosmosClient } from "@azure/cosmos";
const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const { database } = await client.databases.createIfNotExists({ id: "Test Database" });
const { resources: usersList } = await database.users.readAll().fetchAll();
function readAll(options?: FeedOptions): QueryIterator<UserDefinition & Resource>
Parameters
- options
- FeedOptions
Retouren
upsert(UserDefinition, RequestOptions)
Upsert een databasegebruiker met een opgegeven UserDefinition.
voorbeeld van
import { CosmosClient } from "@azure/cosmos";
const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const { database } = await client.databases.createIfNotExists({ id: "Test Database" });
await database.users.upsert({ id: "<user-id>" });
function upsert(body: UserDefinition, options?: RequestOptions): Promise<UserResponse>
Parameters
- body
- UserDefinition
De opgegeven UserDefinition-.
- options
- RequestOptions
Retouren
Promise<UserResponse>