利用可能なリソース設定形式

Auth0 Deploy CLI の使用時に利用できる設定形式について説明します。

Auth0 のリソースの状態は、YAML とディレクトリ (JSON) という 2 つの設定ファイル形式で表されます。Deploy CLI の export コマンドを使用すると、どちらの形式を使用するか選択するよう求められます。

​

YAML

YAML 形式は、主にフラットな tenant.yaml ファイルで表され、Actions やメールテンプレートなどのリソースには補助的なコードファイルが使われます。単一のファイルにまとめることで、バージョン管理における経時的な変更の追跡がより容易になります。また、単一ファイルにすることで、すぐには分かりにくいディレクトリ名やファイル名に関する多少の曖昧さも解消されます。

​

ディレクトリ (JSON)

ディレクトリ形式では、リソースタイプごとに別々のディレクトリに分け、各リソースは専用の JSON ファイルに格納されます。この形式を使用すると、リソースタイプごとの違いだけでなく、個々のリソースも概念的に整理しやすくなります。また、Deploy CLI は Auth0 Management API で定義されているデータ構造を忠実に反映しているため、この形式を使用する場合は、ドキュメント内の JSON の例を参照すると役立ちます。

​

選び方

どの形式を使うかは、基本的には好みで決めて問題ありません。どちらの形式も同じ目的を達成できる実用的な選択肢ですが、前述のとおり、それぞれに異なる長所と短所があります。必ず、ご自身のユースケースに照らしてそれぞれを評価してください。重要なのは、この選択は固定ではなく、必要に応じて import コマンドを使って一方からもう一方へ切り替えられるという点です。