Users class
Wird zum Erstellen, Upsert, Abfragen und Lesen aller Benutzer verwendet.
Siehe Benutzer-, um einen bestimmten Benutzer nach ID zu lesen, zu ersetzen oder zu löschen.
Eigenschaften
| database |
Methoden
| create(User |
Erstellen Sie einen Datenbankbenutzer mit dem angegebenen UserDefinition-. Beispiel
|
| query(Sql |
Alle Benutzer abfragen. |
| query<T>(Sql |
Alle Benutzer abfragen. Beispiel Abfrage des Benutzers mit id.
|
| read |
Alle Benutzer lesen.- Beispiel Alle Benutzer in Array lesen.
|
| upsert(User |
Upsert einen Datenbankbenutzer mit einem angegebenen UserDefinition-. Beispiel
|
Details zur Eigenschaft
database
Details zur Methode
create(UserDefinition, RequestOptions)
Erstellen Sie einen Datenbankbenutzer mit dem angegebenen UserDefinition-.
Beispiel
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>
Parameter
- body
- UserDefinition
Die angegebene UserDefinition-.
- options
- RequestOptions
Gibt zurück
Promise<UserResponse>
query(SqlQuerySpec, FeedOptions)
Alle Benutzer abfragen.
function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>
Parameter
- query
- SqlQuerySpec
Abfragekonfiguration für den Vorgang. Weitere Informationen zum Konfigurieren einer Abfrage finden Sie unter SqlQuerySpec-.
- options
- FeedOptions
Gibt zurück
QueryIterator<any>
query<T>(SqlQuerySpec, FeedOptions)
Alle Benutzer abfragen.
Beispiel
Abfrage des Benutzers mit 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>
Parameter
- query
- SqlQuerySpec
Abfragekonfiguration für den Vorgang. Weitere Informationen zum Konfigurieren einer Abfrage finden Sie unter SqlQuerySpec-.
- options
- FeedOptions
Gibt zurück
readAll(FeedOptions)
Alle Benutzer lesen.-
Beispiel
Alle Benutzer in Array lesen.
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>
Parameter
- options
- FeedOptions
Gibt zurück
upsert(UserDefinition, RequestOptions)
Upsert einen Datenbankbenutzer mit einem angegebenen UserDefinition-.
Beispiel
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>
Parameter
- body
- UserDefinition
Die angegebene UserDefinition-.
- options
- RequestOptions
Gibt zurück
Promise<UserResponse>