Atlas CLI 環境変数

項目一覧

Precedence

サポートされている環境変数

スクリプトを容易にするために、環境変数を使用して構成設定を指定できます。

Precedence

コマンドを実行する場合、環境変数で指定した各設定は、構成ファイルに保存されているプロファイルよりも優先されます。
--projectIdオプションを使用してコマンドを実行すると、コマンドラインオプションは環境変数と構成ファイルに保存されているプロファイルの両方よりも優先されます。

サポートされている環境変数

重要

Atlas CLI は、MongoDB CLI 環境変数と Atlas CLI 環境変数の両方をサポートしています。 MongoDB CLI 環境変数と Atlas CLI 環境変数のいずれかを使用できますが、両方を併用することはできません。

Atlas CLI は、次の環境変数をサポートしています。

変数

説明

DO_NOT_TRACK

Atlas CLI でテレメトリが無効になっているかどうかを示すフラグ。テレメトリを無効にするには、 1に設定します。

MONGODB_ATLAS_TELEMETRY_ENABLEDを使用してテレメトリを有効または無効にすることもできますが、両方を指定する必要はありません。

MONGODB_ATLAS_PUBLIC_API_KEY

Atlas と対話するコマンドの公開 APIキーを設定します。

MONGODB_ATLAS_PRIVATE_API_KEY

Atlas と対話するコマンドのプライベートAPIキーを設定します。

MONGODB_ATLAS_ORG_ID

--orgIdオプションを必要とするコマンドの組織 ID を設定します。

MONGODB_ATLAS_PROJECT_ID

--projectIdオプションを必要とするコマンドのプロジェクト ID を設定します。

MONGODB_ATLAS_OUTPUT

出力フィールドと形式を設定します。有効な値は以下のとおりです。

値	出力形式
Empty default	Atlas CLI が返すすべてのフィールドを含む、人間が判読可能な出力。
`json`	Atlas CLI が返すすべてのフィールドを含む JSON 出力。
`json-path`	指定したフィールドを含む JSON 出力。
`go-template`	Go テンプレートで指定したフィールドを含むカスタム形式の出力。

MONGODB_ATLAS_MONGOSH_PATH

MongoDB Shell へのローカルシステム上のフルパス、 mongosh 。

MONGODB_ATLAS_SKIP_UPDATE_CHECK

yesに設定すると、Atlas CLI は新しいバージョンへの更新を要求しません。

MONGODB_ATLAS_ACCESS_TOKEN

Atlas アカウントへのアクセスを許可する string。アクセストークンの有効期限は 12 時間です。

MONGODB_ATLAS_REFRESH_TOKEN

stringAtlas現在のアクセストークンの有効期限が切れたときにが新しいアクセストークンを自動的にリクエストできるようにし。

MONGODB_ATLAS_TELEMETRY_ENABLED

Atlas CLI でテレメトリが有効になっているかどうかを示すフラグ。テレメトリを無効にするには、 falseに設定します。

DO_NOT_TRACKを使用してテレメトリを有効または無効にすることもできますが、両方を指定する必要はありません。

HTTP_PROXY

hostname[:port]形式の絶対URLまたはホスト名とポート。

次の例は、さまざまな状況で環境変数を設定する方法を示しています。

プロキシ構成で認証が必要ない場合は、次の手順に従います。
```
HTTP_PROXY=<my.proxy.address>
```
プロキシ構成で認証が必要な場合は、
```
HTTP_PROXY=<username>:<password>@<my.proxy.address>
```
スキームがsocks5の場合:
```
HTTP_PROXY=socks5://<my.proxy.address>
```

HTTPS_PROXY

絶対URL 。 HTTP_PROXYも設定されている場合、これはすべてのリクエストに対してHTTP_PROXYよりも優先されます。

次の例は、環境変数を設定する方法を示しています。

HTTPS_PROXY=https://<my.proxy.address>

NO_PROXY

URL にプロキシが構成されていないため、 URLのプロキシがないと表示されます。

戻る

自動化

出力をカスタマイズする