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

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

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

​

YAML

YAML 形式は主に、Actions やメールテンプレートのようなリソース向けの補足コードファイルとあわせて、フラットな tenant.yaml ファイル 1 つで表現されます。ファイルが 1 つであるため、バージョン管理での経時的な変更の追跡がしやすくなります。さらに、単一ファイルにすることで、すぐには分かりにくいディレクトリ名やファイル名にまつわる曖昧さもある程度解消されます。

​

ディレクトリ (JSON)

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

​

選び方

どの形式を使うかは、基本的には好みで決めて構いません。どちらの形式も同じ目的を果たせる有効な選択肢ですが、上述のとおり、それぞれに異なる長所と短所があります。必ず、それぞれをご自身の状況に照らして検討してください。なお、この選択は固定ではなく、必要に応じて import コマンドを使って一方からもう一方へ切り替えることもできます。