@azure/cosmos package
クラス
AbortError |
このエラーは、非同期操作が中止されたときにスローされます。
エラーの name プロパティが と一致することをテスト 例
|
ChangeFeedIterator |
変更フィードの反復子を提供します。 反復子のインスタンスを取得するには、 を使用 |
ChangeFeedIteratorResponse |
Azure Cosmos DB 変更フィードからの 1 つの応答ページ |
ChangeFeedResponse |
Azure Cosmos DB 変更フィードからの 1 つの応答ページ |
ChangeFeedStartFrom |
ChangeFeedIterator を開始する場所の基本クラス。 |
ClientSideMetrics | |
Conflict |
特定の 競合 を ID で読み取ったり削除したりするには、 を使用します。 すべての競合を照会または読み取る場合は、「競合」を参照してください。 |
ConflictResponse | |
Conflicts |
すべての競合を照会または読み取るために使用します。 |
Container |
特定の既存のコンテナーを ID で読み取り、置換、または削除するための操作。 新しい コンテナー を作成し、すべてのコンテナーの読み取り/クエリを行う場合は、「コンテナー」を参照してください。を使用します 注: これらの操作はすべて、固定予算に対して呼び出しを行います。
これらの呼び出しがアプリケーションと共にサブリニアにスケーリングされるように、システムを設計する必要があります。
たとえば、コンテナーが存在することを確認するために、1 回 |
ContainerResponse |
コンテナー操作の応答オブジェクト |
Containers |
新しいコンテナーを作成し、すべてのコンテナーの読み取り/クエリを実行するための操作 既存 のコンテナー の読み取り、置換、または削除については、「コンテナー」を参照してください。を使用します 注: これらの操作はすべて、固定予算に対して呼び出しを行います。
これらの呼び出しがアプリケーションと共にサブリニアにスケーリングされるように、システムを設計する必要があります。
たとえば、コンテナーが存在することを確認するために、1 回 |
CosmosClient |
Azure Cosmos DB データベース アカウントのクライアント側の論理表現を提供します。 このクライアントは、Azure Cosmos DB データベース サービスで要求を構成して実行するために使用されます。 例 クライアントをインスタンス化し、新しいデータベースを作成する
例 カスタム接続ポリシーを使用してクライアントをインスタンス化する
|
CosmosDiagnostics |
|
Database |
既存のデータベースの読み取りまたは削除のための操作。 新しい データベース を作成し、すべてのデータベースの読み取り/クエリを行う場合は、「データベース」を参照してください。を使用します 注: これらの操作はすべて、固定予算に対して呼び出しを行います。
これらの呼び出しがアプリケーションと共にサブリニアにスケーリングされるように、システムを設計する必要があります。
たとえば、データベースが存在することを確認するために、1 回 |
DatabaseAccount |
Azure Cosmos DB データベース サービスの DatabaseAccount を表します。 |
DatabaseResponse |
データベース操作の応答オブジェクト |
Databases |
新しいデータベースを作成し、すべてのデータベースの読み取り/クエリを実行するための操作 既存 のデータベース の読み取りまたは削除については、「データベース」を参照してください。を使用します 注: これらの操作はすべて、固定予算に対して呼び出しを行います。
これらの呼び出しがアプリケーションと共にサブリニアにスケーリングされるように、システムを設計する必要があります。
たとえば、データベースが存在することを確認するために、1 回 |
ErrorResponse | |
FeedRange |
changefeed のフィード範囲を指定します。 |
FeedResponse | |
Item |
特定の項目に対する操作を実行するために使用されます。 すべての アイテム に対する操作については、「アイテム」を参照してください。「」を参照してください |
ItemResponse | |
Items |
新しいアイテムを作成し、すべてのアイテムの読み取り/クエリを実行するための操作 既存のコンテナーの読み取り、置換、または削除については、「 項目 」を参照してください。を使用します |
Offer |
既存の プラン を ID で読み取ったり置き換えたりするには、 を使用します。 「すべての オファー のクエリまたは読み取りを行うオファー」を参照してください。 |
OfferResponse | |
Offers |
を使用して、すべてのオファーのクエリまたは読み取りを行います。 |
PartitionKeyBuilder |
PartitionKey をビルドするための Builder クラス。 |
Permission |
特定の アクセス許可 を ID で読み取り、置換、または削除するには、 を使用します。 「すべての アクセス許可 を作成、アップサート、クエリ、または読み取りするためのアクセス許可」を参照してください。 |
PermissionResponse | |
Permissions |
を使用して、すべてのアクセス許可の作成、置換、クエリ、読み取りを行います。 ID による特定 のアクセス許可 の読み取り、置換、または削除のアクセス許可に関するページを参照してください。 |
QueryIterator |
QueryIterator オブジェクトを表します。これは、Azure Cosmos DB データベース サービスでのトラバーサルと応答の反復処理を可能にするフィードまたはクエリ応答の実装です。 |
QueryMetrics | |
QueryPreparationTimes | |
ResourceResponse | |
RestError |
失敗したパイプライン要求のカスタム エラーの種類。 |
RuntimeExecutionTimes | |
SasTokenProperties | |
Scripts | |
StoredProcedure |
ID による特定の既存のストアド プロシージャの読み取り、置換、削除、または実行のための操作。 ストアド プロシージャを作成、読み取り、またはクエリする操作の場合は、 |
StoredProcedureResponse | |
StoredProcedures |
すべてのストアド プロシージャの作成、アップサート、または読み取り/クエリを行う操作。 ID で特定の既存のストアド プロシージャを読み取り、置換、削除、または実行する操作については、「」を参照してください |
TimeoutError | |
Trigger |
トリガーの読み取り、置換、または削除を行う操作。 を使用して |
TriggerResponse | |
Triggers |
すべてのトリガーの作成、アップサート、クエリ、読み取りを行う操作。 トリガーの読み取り、置換、または削除を行う場合に使用 |
User |
ユーザーの読み取り、置換、削除に使用します。 さらに、 と 「 ユーザー 」を参照して、すべてを作成、アップサート、クエリ、または読み取りを行います。 |
UserDefinedFunction |
ID で指定されたユーザー定義関数の読み取り、置換、または削除に使用されます。 作成、アップサート、クエリ、すべてのユーザー定義関数の読み取りについては、「 UserDefinedFunction 」を参照してください。 |
UserDefinedFunctionResponse | |
UserDefinedFunctions |
すべてのユーザー定義関数の作成、アップサート、クエリ、または読み取りに使用されます。 特定のユーザー定義関数を id で読み取り、置換、または削除するには、「 UserDefinedFunction 」を参照してください。 |
UserResponse | |
Users |
すべてのユーザーの作成、アップサート、クエリ、読み取りに使用されます。 特定 のユーザー を ID で読み取り、置換、または削除するには、「ユーザー」を参照してください。 |
インターフェイス
Agent | |
BulkOptions |
一括実行を変更するために使用される Options オブジェクト。 continueOnError (既定値: false) - 操作が失敗したときに一括実行を続行します ** 注: 4.0 リリースでは既定値は TRUE になります |
ChangeFeedIteratorOptions |
変更フィードのオプションを指定します これらのオプションが設定されていない場合は、コンテナー全体の変更の読み取りが開始されます。 |
ChangeFeedOptions |
変更フィードのオプションを指定します これらのオプションの一部では、変更フィードからの読み取りを開始する場所とタイミングを制御します。 優先順位は次のとおりです。
これらのオプションが設定されていない場合は、最初 |
ChangeFeedPullModelIterator |
パーティション キー、フィード範囲、またはコンテナー全体のすべての変更を反復処理できる反復子を返すには、 を使用 |
ConflictDefinition | |
ConflictResolutionPolicy |
異なるリージョンからの書き込みが Azure Cosmos DB サービスのコレクション内のドキュメントで競合する場合に、競合を解決する方法を指定するための競合解決ポリシー構成を表します。 |
ConnectionPolicy |
Azure Cosmos DB データベース サービスの CosmosClient に関連付けられている接続ポリシーを表します。 |
ContainerDefinition | |
ContainerRequest | |
CosmosClientOptions | |
CosmosHeaders | |
CreateOperationInput | |
DatabaseDefinition | |
DatabaseRequest | |
DeleteOperationInput | |
DiagnosticNode |
診断情報をキャプチャするための構造のようなツリーを表します。 |
ErrorBody | |
FailedRequestAttemptDiagnostic |
この型は、サーバー API に対する失敗した要求に関する診断情報をキャプチャします。 |
FeedOptions |
フィード オプションとクエリ メソッド。 |
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 | |
RetryOptions |
Azure Cosmos DB データベース サービスで調整された要求で割り当てられた再試行ポリシーを表します。 |
SharedOptions |
Azure Cosmos DB サーバーに発行された要求に対して指定できるオプション。= |
SpatialIndex | |
SqlParameter |
SqlQuerySpec で指定されたパラメーター化された SQL クエリのパラメーターを表します。 |
SqlQuerySpec |
Azure Cosmos DB サービスの SQL クエリを表します。 SQL インジェクションから保護するには、入力を含むクエリをパラメーター化する必要があります。 例 パラメーター化された SQL クエリ
|
StoredProcedureDefinition | |
TriggerDefinition | |
UniqueKey |
UniqueKeyPolicy の一部として渡される 1 つの一意キーのインターフェイス |
UniqueKeyPolicy |
コンテナーの作成時に一意のキーを設定するためのインターフェイス |
UpsertOperationInput | |
UserDefinedFunctionDefinition | |
UserDefinition |
型エイリアス
AggregateType | |
BulkOperationResponse | |
BulkPatchOperation | |
ClientConfigDiagnostic |
この型は、 の初期化に関連する情報を保持します。 |
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 |
列挙型
ConflictResolutionMode | |
ConnectionMode |
CosmosClient の接続動作を決定します。 現時点では、ゲートウェイ モードのみがサポートされています。 |
ConsistencyLevel |
Azure Cosmos DB クライアント操作でサポートされる整合性レベルを表します。 強度の順序による整合性レベルは、Strong、BoundedStaleness、Session、Consistent Prefix、および Eventual です。 整合性レベルの詳細なドキュメントを参照してください https://aka.ms/cosmos-consistency 。 |
CosmosDbDiagnosticLevel |
Cosmos DB 診断レベル |
DataType |
Azure Cosmos DB サービスのインデックス パス仕様のターゲット データ型を定義します。 |
GeospatialType | |
IndexKind |
サポートされているインデックスの種類を指定します。 |
IndexingMode |
サポートされているインデックス作成モードを指定します。 |
MetadataLookUpType |
これは、可能なメタデータ参照の型の列挙型です。 |
PartitionKeyDefinitionVersion |
PartitionKey 定義のバージョン |
PartitionKeyKind |
PartitionKey の種類 (ハッシュ、MultiHash など) |
PermissionMode |
アクセス許可モードの値の列挙型。 |
PriorityLevel |
各 Azure Cosmos DB クライアント要求に関連付けられている優先度レベルを表します。 既定では、すべての要求は優先度の高い要求と見なされます。 優先度ベースの調整に関する詳細なドキュメントを参照してください https://aka.ms/CosmosDB/PriorityBasedExecution 。 |
SpatialType | |
TriggerOperation |
トリガー操作値の列挙型。 は、トリガーを実行する操作を指定します。 |
TriggerType |
トリガーの種類の値の列挙型。 トリガーの種類を指定します。 |
UserDefinedFunctionType |
udf 型の値の列挙型。 ユーザー定義関数の種類を指定します。 |
機能
create |
試験的な内部のみ SAS トークンのアクセス許可構成を表すペイロードを生成します。 |
関数の詳細
createAuthorizationSasToken(string, SasTokenProperties)
試験的な内部のみ SAS トークンのアクセス許可構成を表すペイロードを生成します。
function createAuthorizationSasToken(masterKey: string, sasTokenProperties: SasTokenProperties): Promise<string>
パラメーター
- masterKey
-
string
- sasTokenProperties
- SasTokenProperties
戻り値
Promise<string>