次の方法で共有

@azure/cosmos package

クラス

AbortError

このエラーは、非同期操作が中止されたときにスローされます。 エラーの name プロパティが name一致する "AbortError" をテストして、このエラーを確認します。

例

const controller = new AbortController();
controller.abort();
try {
  doAsyncWork(controller.signal)
} catch (e) {
  if (e.name === 'AbortError') {
    // handle abort error here.
  }
}
AzureKeyVaultEncryptionKeyResolver

カスタマー マネージド キーに Azure Key Vault を使用する EncryptionKeyResolver の実装。
ChangeFeedIterator

変更フィードの反復子を提供します。

反復子のインスタンスを取得するには、Items.changeFeed() を使用します。
ChangeFeedIteratorResponse

Azure Cosmos DB 変更フィードからの 1 つの応答ページ
ChangeFeedPolicy

Azure Cosmos DB サービス内のコンテナーの変更フィード ポリシー構成を表します。
ChangeFeedResponse

Azure Cosmos DB 変更フィードからの 1 つの応答ページ
ChangeFeedRetentionTimeSpan
ChangeFeedStartFrom

ChangeFeedIterator を開始する場所の基本クラス。
ClientEncryptionKeyResponse

ClientEncryptionKey 操作の応答オブジェクト
ClientSideMetrics
Conflict

特定の 競合 を ID で読み取りまたは削除するために使用します。

競合の を参照して、すべての競合を照会または読み取ります。
ConflictResponse
Conflicts

すべての競合のクエリまたは読み取りに使用します。

競合 を参照して、特定の 競合 を ID で読み取りまたは削除します。
Container

ID による特定の既存のコンテナーの読み取り、置換、または削除を行う操作。

新しいコンテナーを作成し、すべてのコンテナーの読み取り/クエリを実行する方法については、「コンテナーの」を参照してください。.containersを使用します。

注: これらすべての操作は、固定予算に対して呼び出しを行います。 これらの呼び出しがアプリケーションと共にサブリニアにスケーリングされるようにシステムを設計する必要があります。 たとえば、コンテナーが存在することを確認するために、すべての container(id).read() 呼び出しの前に item.read() を呼び出さないでください。これは、アプリケーションの起動時に 1 回行います。
ContainerResponse

コンテナー操作の応答オブジェクト
Containers

新しいコンテナーを作成し、すべてのコンテナーの読み取り/クエリを実行するための操作

既存 コンテナーの読み取り、置換、または削除については、コンテナー を参照してください。.container(id)を使用します。

注: これらすべての操作は、固定予算に対して呼び出しを行います。 これらの呼び出しがアプリケーションと共にサブリニアにスケーリングされるようにシステムを設計する必要があります。 たとえば、コンテナーが存在することを確認するために、すべての containers.readAll() 呼び出しの前に item.read() を呼び出さないでください。これは、アプリケーションの起動時に 1 回行います。
CosmosClient

Azure Cosmos DB データベース アカウントのクライアント側の論理表現を提供します。 このクライアントは、Azure Cosmos DB データベース サービスで要求を構成して実行するために使用されます。

例

クライアントをインスタンス化し、新しいデータベースを作成する

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

例

カスタム接続ポリシーを使用してクライアントをインスタンス化する

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({
  endpoint,
  key,
  connectionPolicy: {
    requestTimeout: 10000,
  },
});

例

AAD 認証とカスタム スコープを使用してクライアントをインスタンス化する

import { DefaultAzureCredential } from "@azure/identity";
import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const aadCredentials = new DefaultAzureCredential();
const client = new CosmosClient({
  endpoint,
  aadCredentials,
  aadScope: "https://cosmos.azure.com/.default", // Optional custom scope
});
CosmosDiagnostics
  • これは、クライアント操作中に収集された診断情報を保持する Cosmos 診断の種類です。 つまり、Item.read()、Container.create()。 これには 3 つのメンバーがあります。
  1. clientSideRequestStatistics メンバーには、次のような集計診断情報が含まれています。
  • メタデータ参照。 ここでは、最終的な目的のリソースとは別に、すべてのサーバー要求がメタデータ呼び出しと見なされます。 つまり、item.read(id) の場合、クライアントがエンドポイントを検出するためにサーバー呼び出しを行った場合、メタデータ呼び出しと見なされます。
  • 再試行
  • エンドポイントが接続されました。
  • 要求、応答ペイロードの統計。
  • gatewayStatistics - メイン操作に対応する情報。 たとえば Item.read() の間、クライアントはメタデータ検索などの多くの操作を実行する場合がありますが、gatewayStatistics は実際の読み取り操作の診断情報を表します。
  1. diagnosticNode - 詳細な診断情報をキャプチャする構造のようなツリーです。 既定では無効になっており、非運用環境でのデバッグにのみ使用されます。 diagnosticNode でキャプチャされる詳細の種類は、CosmosDbDiagnosticLevelによって制御されます。
  • CosmosDbDiagnosticLevel.info - 既定値です。 このレベルでは、clientSideRequestStatistics のみがキャプチャされます。 運用環境を対象としています。
  • CosmosDbDiagnosticLevel.debug - diagnosticNode と clientConfig をキャプチャします。 要求と応答のペイロードはキャプチャされません。 運用環境で使用するためのものではありません。
  • CosmosDbDiagnosticLevel.debug-unsafe - CosmosDbDiagnosticLevel.debug でキャプチャされたデータに加えて、要求と応答のペイロードもキャプチャします。 運用環境で使用するためのものではありません。
  1. clientConfig - 初期化中のクライアントの構成方法に関連する情報をキャプチャします。
Database

既存のデータベースを読み取りまたは削除するための操作。

新しいデータベースを作成し、すべてのデータベースの読み取り/クエリを実行する方法については、「データベースの」を参照してください。client.databasesを使用します。

注: これらすべての操作は、固定予算に対して呼び出しを行います。 これらの呼び出しがアプリケーションと共にサブリニアにスケーリングされるようにシステムを設計する必要があります。 たとえば、1 回の database.read() 呼び出しの前に item.read() を呼び出して、データベースが存在することを確認しないでください。これは、アプリケーションの起動時に 1 回行います。
DatabaseAccount

Azure Cosmos DB データベース サービスの DatabaseAccount を表します。
DatabaseResponse

データベース操作の応答オブジェクト
Databases

新しいデータベースを作成し、すべてのデータベースの読み取り/クエリを実行するための操作

既存のデータベースの読み取りまたは削除については、「Database」を参照してください。client.database(id)を使用します。

注: これらすべての操作は、固定予算に対して呼び出しを行います。 これらの呼び出しがアプリケーションと共にサブリニアにスケーリングされるようにシステムを設計する必要があります。 たとえば、1 回の databases.readAll() 呼び出しの前に item.read() を呼び出して、データベースが存在することを確認しないでください。これは、アプリケーションの起動時に 1 回行います。
EncryptionQueryBuilder

パラメータ化されたクエリで暗号化されたパラメータを構築するためのビルダークラスを表します。
ErrorResponse

操作で返されるエラー応答を表します。
FeedRange

changefeed のフィード範囲を指定します。
FeedResponse
Item

特定の項目に対して操作を実行するために使用されます。

すべてのアイテムに対する操作については、「項目」を参照してください。container.itemsを参照してください。
ItemResponse
Items

新しい項目を作成し、すべての項目の読み取り/クエリを実行するための操作

既存のコンテナーの読み取り、置換、または削除については、項目の を参照してください。.item(id)を使用します。
Offer

既存の オファー を ID で読み取ったり置き換えたりするために使用します。

すべてのプラン クエリまたは読み取りを行うプランの を参照してください。
OfferResponse
Offers

すべてのオファーのクエリまたは読み取りに使用します。

既存 オファーの を ID で読み取ったり置き換えたりするには、プラン を参照してください。
PartitionKeyBuilder

PartitionKey をビルドするための Builder クラス。
Permission

特定の Permission を ID で読み取り、置換、または削除するために使用します。

すべてのアクセス許可 作成、アップサート、クエリ、読み取りを行うアクセス許可の を参照してください。
PermissionResponse
Permissions

すべてのアクセス許可の作成、置換、クエリ、読み取りに使用します。

ID による特定のアクセス許可の読み取り、置換、または削除については、「アクセス許可の」を参照してください。
QueryIterator

QueryIterator オブジェクトを表します。これは、Azure Cosmos DB データベース サービスでのトラバーサルと応答の反復処理を可能にするフィードまたはクエリ応答の実装です。
QueryMetrics
QueryPreparationTimes
ResourceResponse
RuntimeExecutionTimes
SasTokenProperties
Scripts
StoredProcedure

ID による特定の既存のストアド プロシージャの読み取り、置換、削除、または実行のための操作。

ストアド プロシージャの作成、すべて読み取り、またはクエリを実行する操作の場合は、
StoredProcedureResponse
StoredProcedures

すべてのストアド プロシージャの作成、アップサート、または読み取り/クエリを行う操作。

ID で特定の既存のストアド プロシージャを読み取り、置換、削除、または実行する操作については、container.storedProcedure()を参照してください。
TimeoutError
Trigger

トリガーの読み取り、置換、または削除を行う操作。

container.triggers を使用して、すべてを作成、アップサート、クエリ、読み取りを行います。
TriggerResponse
Triggers

すべてのトリガーを作成、アップサート、クエリ、読み取る操作。

container.triggers を使用して、トリガーの読み取り、置換、または削除を行います。
User

ユーザーの読み取り、置換、および削除に使用されます。

さらに、user.permission と user.permissionsを使用して、特定のユーザーのアクセス許可にアクセスできます。

作成、アップサート、クエリ、またはすべてを読み取る ユーザー を参照してください。
UserDefinedFunction

ID で指定されたユーザー定義関数の読み取り、置換、または削除に使用されます。

UserDefinedFunction 、作成、アップサート、クエリ、すべてのユーザー定義関数の読み取りを参照してください。
UserDefinedFunctionResponse
UserDefinedFunctions

すべてのユーザー定義関数の作成、アップサート、クエリ、読み取りに使用されます。

特定 ユーザー定義関数を id で読み取り、置換、または削除するには、UserDefinedFunction を参照してください。
UserResponse
Users

すべてのユーザーの作成、アップサート、クエリ、読み取りに使用されます。

特定のユーザー ID による読み取り、置換、または削除を行うユーザー を参照してください。

インターフェイス

@azure/cosmos.Index
Agent
BulkOperationResult

executeBulkOperations API を使用して、操作の応答を一括で表します。
BulkOptions

一括実行を変更するために使用される Options オブジェクト。 continueOnError (既定値: false) - 操作が失敗したときに一括実行を続行します ** 4.0 リリースでは既定値は TRUE になります
ChangeFeedIteratorOptions

変更フィードのオプションを指定します

これらのオプションのいずれも設定されていない場合は、コンテナー全体の変更の読み取りが開始されます。
ChangeFeedOptions

変更フィードのオプションを指定します

これらのオプションの一部は、変更フィードからの読み取りを開始する場所とタイミングを制御します。 優先順位は次のとおりです。

  • 継続
  • 開始時間
  • startFromBeginning (開始から開始)

これらのオプションのいずれも設定されていない場合は、最初の ChangeFeedIterator.fetchNext() 呼び出しからの変更の読み取りが開始されます。
ChangeFeedPullModelIterator

Items.getChangeFeedIterator() を使用して、パーティション キー、フィード範囲、またはコンテナー全体のすべての変更を反復処理できる反復子を返します。
ClientEncryptionIncludedPath

暗号化のパスとそれに関連する設定を表します。
ClientEncryptionKeyProperties

Azure Cosmos DB サービスで使用するクライアント暗号化キーの詳細。
ClientEncryptionKeyRequest

Cosmos DB のクライアント暗号化キーの要求を表すインターフェイス。
ClientEncryptionOptions

CosmosClient に関連付けられている暗号化オプションを表します。
ClientEncryptionPolicy

コンテナに関連付けられたクライアント暗号化ポリシーを表します。
CompositePath

インデックス作成ポリシーの複合パスを表します。
ComputedProperty
ConflictDefinition
ConflictResolutionPolicy

異なるリージョンからの書き込みが Azure Cosmos DB サービスのコレクション内のドキュメントで競合する場合に、競合を解決する方法を指定するための競合解決ポリシー構成を表します。
ConnectionPolicy

Azure Cosmos DB データベース サービスの CosmosClient に関連付けられている接続ポリシーを表します。
ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosEncryptedNumber

このインターフェイスは、Cosmos DB SDK で暗号化された番号を表します。

例

import { CosmosEncryptedNumber, CosmosEncryptedNumberType } from "@azure/cosmos";

const encryptedNumber1: CosmosEncryptedNumber = {
  value: 4,
  numberType: CosmosEncryptedNumberType.Integer,
};
const encryptedNumber2: CosmosEncryptedNumber = {
  value: 4.1,
  numberType: CosmosEncryptedNumberType.Float,
};
const encryptedNumber3: CosmosEncryptedNumber = {
  value: 4,
  numberType: CosmosEncryptedNumberType.Float, // represents 4.0
};
CosmosHeaders
CreateOperationInput
DatabaseDefinition
DatabaseRequest
DeleteOperationInput
DiagnosticNode

診断情報をキャプチャするための構造のようなツリーを表します。
EncryptionKeyResolver

さまざまなキー・プロバイダのキー・リゾルバのインタフェースを提供します。 すべてのリゾルバーは、このインターフェイスを実装する必要があります。
EncryptionKeyWrapMetadata

カスタマー マネージド キーを使用してデータ暗号化キーをラップ/ラップ解除するために使用されるメタデータ
ErrorBody
ExtendedOperationResponse

executeBulkOperations API を使用した一括で成功した操作の応答
FailedRequestAttemptDiagnostic

この型は、サーバー API への失敗した要求に関する診断情報をキャプチャします。
FeedOptions

フィード オプションとクエリ メソッド。
FullTextIndex

インデックス作成ポリシーのフルテキスト インデックスを表します。
FullTextPath

Azure Cosmos DB サービスでインデックスを作成するフルテキスト パスを表します。
FullTextPolicy

Azure Cosmos DB サービス内のコレクションのフルテキスト ポリシーを表します。
GroupByAliasToAggregateType
IndexedPath
IndexingPolicy
ItemDefinition

Cosmos DB の項目は単なる JSON オブジェクトです。 ほとんどの Item 操作では、非常に単純な ItemDefinition を拡張する独自の型を提供できます。

予約キーは使用できません。 予約キーの一覧は、<xref:ItemBody>
JSONArray
JSONObject
Location

使用可能な場所を指定するために使用され、読み取りはインデックス 1、書き込みはインデックス 0 です。
MetadataLookUpDiagnostic

この型には、サーバーへの 1 つのメタデータ要求に関する診断情報が含まれています。
OfferDefinition
OperationBase
OperationResponse
PartitionKeyDefinition
PartitionKeyRangePropertiesNames
PatchOperationInput
PermissionBody
PermissionDefinition
ReadOperationInput
ReplaceOperationInput
RequestOptions

Azure Cosmos DB サーバーに対して発行された要求に対して指定できるオプション。=
Resource
RestError

失敗したパイプライン要求のカスタム エラーの種類。
RetryOptions

Azure Cosmos DB データベース サービスの調整された要求で割り当てられた再試行ポリシーを表します。
SharedOptions

Azure Cosmos DB サーバーに対して発行された要求に対して指定できるオプション。=
SpatialIndex
SqlParameter

SqlQuerySpec で指定された、パラメーター化された SQL クエリのパラメーターを表します。
SqlQuerySpec

Azure Cosmos DB サービスの SQL クエリを表します。

SQL インジェクションから保護するには、入力を含むクエリをパラメーター化する必要があります。

例

パラメーター化された SQL クエリ

import { SqlQuerySpec } from "@azure/cosmos";

const query: SqlQuerySpec = {
  query: `SELECT * FROM Families f where f.lastName = @lastName`,
  parameters: [{ name: "@lastName", value: "Wakefield" }],
};
StoredProcedureDefinition
TriggerDefinition
UniqueKey

UniqueKeyPolicy の一部として渡される 1 つの一意キーのインターフェイス
UniqueKeyPolicy

コンテナーの作成時に一意のキーを設定するためのインターフェイス
UpsertOperationInput
UserDefinedFunctionDefinition
UserDefinition
VectorEmbedding

ベクター埋め込みを表します。 ベクター埋め込みは、ドキュメント内のベクター フィールドを定義するために使用されます。
VectorEmbeddingPolicy

Azure Cosmos DB サービス内のベクター埋め込みのポリシー構成を表します。
VectorIndex

Azure Cosmos DB サービスのベクター インデックスを表します。 ベクター インデックスは、ドキュメント内のベクター フィールドにインデックスを付けるために使用されます。

型エイリアス

AggregateType
BulkOperationResponse
BulkPatchOperation
ClientConfigDiagnostic

この型は、CosmosClient の初期化に関連する情報を保持します
ClientSideRequestStatistics

これは、すべてのクライアント側の診断情報のコレクションの種類です。
CreateOperation
DeleteOperation
ExistingKeyOperation
GatewayStatistics
GroupByExpressions
JSONValue
MetadataLookUpDiagnostics

この型には、CosmosDB クライアント操作中のサーバーへのすべてのメタデータ要求に関する診断情報が含まれます。
NonePartitionKeyType

返されるオブジェクトは、パーティション キーの値を持たない項目の作成とアクセスを可能にするパーティション キー値を表します。
NullPartitionKeyType

返されるオブジェクトは、パーティション キーの null 値を持つ項目の作成とアクセスを可能にするパーティション キー値を表します。
Operation
OperationInput
OperationWithItem
PartitionKey

コンテナーの PartitionKey。
PatchOperation
PatchRequestBody
PrimitivePartitionKeyValue

プリミティブ パーティション キーの値。
ReadOperation
RemoveOperation
ReplaceOperation
RetryDiagnostics

この型は、CosmosDB クライアント操作中の再試行に関する診断情報をキャプチャします。
TokenProvider
UpsertOperation

列挙型

ChangeFeedMode
ConflictResolutionMode
ConnectionMode

CosmosClient の接続動作を決定します。 現時点では、ゲートウェイ モードのみがサポートされています。
ConsistencyLevel

Azure Cosmos DB クライアント操作でサポートされる整合性レベルを表します。
要求された ConsistencyLevel は、データベース アカウントに対してプロビジョニングされた ConsistencyLevel と一致するか、それより弱い必要があります。 整合性レベル。

強度の順序による整合性レベルは、Strong、BoundedStaleness、Session、Consistent Prefix、および Eventual です。

整合性レベルの詳細なドキュメントについては、https://aka.ms/cosmos-consistency を参照してください。
CosmosDbDiagnosticLevel

Cosmos DB 診断レベル
CosmosEncryptedNumberType

この列挙型は、Cosmos DB SDK の数値の種類を表します。
DataType

Azure Cosmos DB サービスのインデックス パス仕様のターゲット データ型を定義します。
EncryptionAlgorithm

データ暗号化でサポートされる暗号化アルゴリズム
EncryptionKeyResolverName

の実装の名前

EncryptionKeyResolverを参照してください
EncryptionType

実行する暗号化の種類。
GeospatialType
IndexKind

サポートされているインデックスの種類を指定します。
IndexingMode

サポートされているインデックス作成モードを指定します。
KeyEncryptionAlgorithm

データ暗号化キーをキー暗号化キーでラップ/ラップ解除するために使用されるアルゴリズム。
MetadataLookUpType

これは、可能なメタデータ参照の型の列挙型です。
PartitionKeyDefinitionVersion

PartitionKey 定義のバージョン
PartitionKeyKind

PartitionKey の種類 (ハッシュ、MultiHash など)
PermissionMode

アクセス許可モードの値の列挙型。
PriorityLevel

各 Azure Cosmos DB クライアント要求に関連付けられている優先度レベルを表します。
優先度の低い要求は常に、優先度の高い要求の前に調整されます。

既定では、すべての要求は優先度の高い要求と見なされます。

優先度ベースの調整に関する詳細なドキュメントについては、https://aka.ms/CosmosDB/PriorityBasedExecution を参照してください。
SpatialType
TriggerOperation

トリガー操作値の列挙型。 は、トリガーを実行する操作を指定します。
TriggerType

トリガーの種類の値の列挙型。 トリガーの種類を指定します。
UserDefinedFunctionType

udf 型の値の列挙型。 ユーザー定義関数の種類を指定します。
VectorEmbeddingDataType

ベクターのデータ型を表します。
VectorEmbeddingDistanceFunction

ベクトル間の距離計算に使用する距離関数を表します。
VectorIndexType

ベクターのインデックスの種類を表します。

関数

createAuthorizationSasToken(string, SasTokenProperties)

試験段階の内部では、sas トークンのアクセス許可構成を表すペイロードのみが生成されます。

関数の詳細

createAuthorizationSasToken(string, SasTokenProperties)

試験段階の内部では、sas トークンのアクセス許可構成を表すペイロードのみが生成されます。

function createAuthorizationSasToken(masterKey: string, sasTokenProperties: SasTokenProperties): Promise<string>

パラメーター

masterKey

string

sasTokenProperties
SasTokenProperties

戻り値

Promise<string>