シークレットの定義と管理

項目一覧

シークレットを定義する

シークレットを表示
シークレットを更新する
シークレットを使用する
シークレットを削除する

シークレットは、Atlasバックエンドに保存され、ユーザーから非表示のプライベート値です。シークレットは、 APIキーや内部識別子などの機密情報を保存するのに役立ちます。

シークレットを定義した後、その値を直接読み取ることはできません。代わりに、シークレットを別の値にリンクし、trigger関数から値にアクセスします。

シークレットを定義する

新しいシークレットは、 UIから、または App Services CLI を使用して定義できます。

ページに移動するValues

Triggersページに移動します。
1. まだ表示されていない場合は、プロジェクトを含む組織をナビゲーションバーの Organizations メニューで選択します。
2. まだ表示されていない場合は、ナビゲーションバーの Projects メニューからプロジェクトを選択します。
3. サイドバーで、 Services見出しの下のTriggersをクリックします。
  [ Triggers]ページが表示されます。
Linked App Service: Triggersリンクをクリックします。
サイドバーで、 Build見出しの下のValuesをクリックします。
[Create a Value] をクリックします。

秘密値の命名

シークレットの名前を入力します。この名前は関数でシークレットを参照する方法であり、プロジェクト内で一意である必要があります。

注意

シークレット名の制限

値名は64文字を超えることはできず、ASCII 文字、数字、アンダースコア、ハイフンのみを含めることができます。最初の文字は文字または数字である必要があります。

秘密値を定義する

Secretタイプを選択します。
Add Content入力ボックスに新しいシークレットの値を入力します。
秘密値は 500 文字を超えることはできません。

警告

シークレットを保存した後、その値を直接読み取ることはできません。

保存と配置

シークレットを定義したら、[ Save ] をクリックします。アプリケーション配置案が有効になっている場合は、 Review & Deployをクリックして変更を配置します。

MongoDB Atlas ユーザーの認証

MongoDB Atlas Administration APIキーを使用して、App Services CLI にログします。

appservices login --api-key="<API KEY>" --private-api-key="<PRIVATE KEY>"

アプリの最新の構成ファイルを取得する

次のコマンドを実行して、構成ファイルのローカルコピーを取得します。

appservices pull --remote=<App ID>

デフォルトでは、コマンドは現在の作業ディレクトリにファイルをプルします。任意の --localフラグを使用してディレクトリパスを指定できます。

新しいシークレットを作成する

以下のコマンドを実行して、新しいシークレットを定義します。

appservices secrets create --app=<Your App ID> \
  --name="<Secret Name>" \
  --value="<Secret Value>"

変更を配置する

次のコマンドを実行して、変更を配置します。

appservices push

シークレットを表示

UIまたは App Services CLI を使用して、アプリのすべてのシークレットのリストを表示できます。

Triggersページから、 Linked App Service: Triggersリンクをクリックします。
サイドバーで、 Build見出しの下のValuesをクリックします。

この表には、シークレットを含むすべての値が列挙され、その行は各値のタイプを示します。

すべてのシークレットの名前と ID を一覧表示するには、次のコマンドを実行します。

appservices secrets list --app=<Your App ID>

シークレットを更新する

シークレットは、 UIから、または App Services CLI を使用して更新できます。

Atlas UIからシークレットを更新するには

Triggersページから、 Linked App Service: Triggersリンクをクリックします。
サイドバーで、 Build見出しの下のValuesをクリックします。
テーブルで更新する値を見つけ、そのActionsメニューを開き、 Edit Secretを選択します。
シークレットの名前と値の両方を変更できます。
Saveをクリックし、必要に応じて変更を配置します。

App Services CLI を使用してシークレットの値をアップデートするには、次のコマンドを実行します。

appservices secrets update --app=<Your App ID> \
  --secret="<Secret ID or Name>" \
  --name="<Updated Secret Name>" \
  --value="<Updated Value>"

シークレットを使用する

シークレットを定義した後、その値を直接読み取ることはできません。

trigger 関数でシークレットを使用するには、次の手順に従います。

シークレットにリンクする新しい値を作成します。
context.valuesモジュールを使用して、関数内のシークレットの値にアクセスします。

シークレットを削除する

シークレットは、 UIから、または App Services CLI を使用して削除できます。

Atlas UIからシークレットを削除するには

Triggersページから、 Linked App Service: Triggersリンクをクリックします。
サイドバーで、 Build見出しの下のValuesをクリックします。
テーブルで削除する値を見つけ、そのActionsメニューを開き、 Delete Secretを選択します。
シークレットを削除することを確認します。

App Services CLI を使用してシークレットを削除するには、次のコマンドを実行します。

appservices secrets delete --app=<Your App ID> --secret=<Secret ID>

Tip

シークレットを削除するには、 nameまたはid値をカンマで区切ったリストとして指定します。

appservices secrets delete --app=<Your App ID> \
--secret=some-api-key,609af850b78eca4a8db4303f,another-key

戻る

集計

MongoDB API リファレンス