MongoDB\Driver\ClientEncryption::rewrapManyDataKey

(mongodb >=1.15.0)

MongoDB\Driver\ClientEncryption::rewrapManyDataKey — 重新包裝資料金鑰

final public MongoDB\Driver\ClientEncryption::rewrapManyDataKey(陣列|物件 $filter, ?陣列 $options = null): 物件

重新包裝（即解密並重新加密）金鑰保管庫集合中符合指定 filter 的零個或多個資料金鑰。

如果未指定 "provider" 選項，則符合的資料金鑰將使用其目前的 KMS 提供者重新包裝。否則，符合的資料金鑰將根據指定的 "provider" 和 "masterKey" 選項重新加密。

» 查詢述詞。空的述詞將符合集合中的所有文件。

注意：在評估查詢條件時，MongoDB 會根據其本身的 » BSON 類型比較規則比較類型和值，這與 PHP 的比較和類型轉換規則不同。當匹配特殊的 BSON 類型時，查詢條件應使用各自的 BSON 類別（例如，使用 MongoDB\BSON\ObjectId 來匹配 » ObjectId）。

選項

選項類型說明

provider

將用於重新加密匹配資料金鑰的 KMS 提供者（例如 "local"、"aws"）。

如果未指定 KMS 提供者，則匹配的資料金鑰將使用其目前的 KMS 提供者重新加密。

masterKey

masterKey 標識用於加密新資料金鑰的 KMS 特定金鑰。不應在未指定 "provider" 選項的情況下指定此選項。如果指定了 "provider" 而不是 "local"，則需要此選項。

**`"aws"` 提供者選項**
選項	類型	說明
region	字串	必填。
key	字串	必填。AWS 客戶主要金鑰 (CMK) 的 Amazon 資源名稱 (ARN)。
endpoint	字串	選填。要將 KMS 請求發送到的替代主機識別碼。可能包含埠號。

**`"azure"` 提供者選項**
選項	類型	說明
keyVaultEndpoint	字串	必填。包含選用埠號的主機（例如「example.vault.azure.net」）。
keyName	字串	必填。
keyVersion	字串	選填。指定金鑰的特定版本。預設使用金鑰的主要版本。

**`"gcp"` 提供者選項**
選項	類型	說明
projectId	字串	必填。
location	字串	必填。
keyRing	字串	必填。
keyName	字串	必填。
keyVersion	字串	選填。指定金鑰的特定版本。預設使用金鑰的主要版本。
endpoint	字串	選填。包含選用埠號的主機。預設為「cloudkms.googleapis.com」。

**`"kmip"` 提供者選項**
選項	類型	說明
keyId	字串	選填。96 位元組 KMIP 秘密資料管理物件的唯一識別碼。如果未指定，驅動程式會建立一個隨機的 96 位元組 KMIP 秘密資料管理物件。
endpoint	字串	選填。包含選用埠號的主機。

傳回一個物件，該物件將具有一個選用的 bulkWriteResult 屬性，其中包含內部 bulkWrite 操作的結果作為一個物件。如果沒有資料金鑰符合篩選條件或寫入未確認，則 bulkWriteResult 屬性將為 null。

此頁面沒有使用者提供的註記。