実験的な :クラウドプロバイダーを通じて管理するキーを使用して、保管時の暗号化の構成を更新します。
MongoDB Cloud は、独自のキー管理を使用しない場合でも、すべてのストレージを暗号化します。このリソースでは、リクエスト元のAPIキーにプロジェクト オーナーのロールが必要です。この機能は、M0 無料クラスター、M2、M5、またはサーバーレス クラスターでは使用できません。MongoDB Cloudプロジェクトでカスタマー キー管理プロバイダーを使った保管時の暗号化を少なくとも 1 つ設定すると、プロジェクトオーナーは暗号化が必要なMongoDB Cloud クラスターごとにカスタマーキー管理を使った保管時の暗号化を有効にできます。カスタマー キー管理プロバイダーを使用した保管時の暗号化は、クラスタークラウドサービス プロバイダーと一致する必要はありません。MongoDB Cloud は、ユーザーが管理する暗号化キーを自動的にローテーションしません。キー ローテーションのベストプラクティスについては、カスタマー キー管理プロバイダーのドキュメントとガイダンスを利用して、ご希望の保管時の暗号化を行ってください。MongoDB Cloudプロジェクトでキー管理を使って、カスタマー キー管理を使った保管時の暗号化を設定すると、 MongoDB Cloud は自動的に 90 日間のキー ローテーションアラートを作成します。MongoDB Cloud は、独自のキー管理を使用するかどうかに関係なく、すべてのストレージを暗号化します。このコマンドは、OpsID: 'updateEncryptionAtRest' を使用してエンドポイントを呼び出します。フラグ、--ファイルの形式、および例の詳細については、次を参照してください: https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Encryption-at- REST- using-カスタマー キー管理/ 操作/updateEncryptionAtRest
構文
atlas api encryptionAtRestUsingCustomerKeyManagement updateEncryptionAtRest [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-- envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ | |
--file | string | false | APIリクエストの内容を含むファイルへのパス |
--groupId | string | true | プロジェクトを識別する一意の 24 桁の 16 進数の文字列 |
-h, --help | false | updateEncryptionAtRest のヘルプ | |
--出力 | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- output-file | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。 |
--pretty | false | レスポンス本体を pretty-print形式にするかどうかを示すフラグ | |
--version | string | false | API 呼び出し [options: "2023-01-01"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2023-01-01" |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |