管理対象からリソースを除外する

Auth0 Deploy CLI の使用時に、リソースを管理対象から除外する方法を説明します。

場合によっては、リソースを管理対象から除外すると便利です。たとえば、テナント内に特定種類のリソースが大量にあり、それらを管理するのが運用上の負担になる場合や、開発ワークフローが特定のリソース群のみに関係しており、パフォーマンス向上のためにそれ以外のリソースをすべて除外したい場合があります。いずれの場合も、Deploy CLI ではリソースを管理対象から除外するための方法がいくつか用意されています。

​

種類ごとにリソース全体を除外する

より複雑なテナントでは、リソースタイプごと丸ごと除外したくなることがあります。たとえば、次のようなケースです。

• 何千もの組織を持つエンタープライズテナントで、それらすべてを管理するのは運用上大きな負担になる場合。
• CI/CD プロセスではロールの管理にのみ注力しており、それ以外はすべて除外したい場合。
• 機能開発の対象がフックに関するもので、パフォーマンスを最適化するために一時的にそれ以外をすべて除外したい場合。

この種の除外は、AUTH0_EXCLUDED または AUTH0_INCLUDED_ONLY のいずれかの設定プロパティに、リソース名の配列を渡して指定します。AUTH0_EXCLUDED 設定プロパティは、指定されたリソースタイプのみを除外します。逆に、AUTH0_INCLUDED_ONLY プロパティは、定義したもの以外のすべてを除外します。除外は双方向に機能します。つまり、リソース設定ファイルの有無にかかわらず、Auth0 からのエクスポート時と Auth0 へのインポート時の両方に適用されます。

除外でサポートされるすべてのリソース値: actions, attackProtection, branding, clientGrants, clients, connections, customDomains, databases, emailProvider, emailTemplates, guardianFactorProviders, guardianFactorTemplates, guardianFactors, guardianPhoneFactorMessageTypes, guardianPhoneFactorSelectedProvider, guardianPolicies, logStreams, migrations, organizations, pages, prompts, resourceServers, roles, tenant, triggers.

​

除外の例

次の例では、Deploy CLI の管理対象から clients、connections、databases、organizations を除外する方法を示します。

{
  "AUTH0_DOMAIN": "example-site.us.auth0.com",
  "AUTH0_CLIENT_ID": "<YOUR_AUTH0_CLIENT_ID>",
  "AUTH0_EXCLUDED": ["clients", "connections", "databases", "organizations"]
}

​

含める場合の例

次の例は、Deploy CLI で actions、clients、connections のみを管理するように指定する方法を示しています。

{
  "AUTH0_DOMAIN": "example-site.us.auth0.com",
  "AUTH0_CLIENT_ID": "<YOUR_AUTH0_CLIENT_ID>",
  "AUTH0_INCLUDED_ONLY": ["actions", "clients", "connections"]
}

​

ID で個別のリソースを除外する

一部のリソースタイプでは、ID を指定して個々のリソースを除外できます。これは、複数の環境で作業していて、下位環境から本番環境固有のリソースを除外したい場合に便利です。

この方法は、ルール、クライアント、データベース、接続、および resource servers でサポートされており、それぞれ AUTH0_EXCLUDED_RULES、AUTH0_EXCLUDED_CLIENTS、AUTH0_EXCLUDED_DATABASES、AUTH0_EXCLUDED_CONNECTIONS、AUTH0_EXCLUDED_RESOURCE_SERVERS の構成値を使用します。

​

例

{
  "AUTH0_DOMAIN": "example-site.us.auth0.com",
  "AUTH0_CLIENT_ID": "<YOUR_AUTH0_CLIENT_ID>",
  "AUTH0_EXCLUDED_CLIENTS": ["Your Application Name"],
  "AUTH0_EXCLUDED_CONNECTIONS": ["con_O1H3KyRMFP1IWRq3", "con_9avEYuj19ihqKBOs"]
}

ID によるリソースの除外は、将来のメジャーバージョンで非推奨になる可能性があります。詳細については、resource exclusion proposalを参照してください。

​

省略と空の状態

Auth0 Deploy CLI では、双方向で設定を強制的に無視する「リソースの除外」に加えて、これに類似した 2 つの概念である「省略」と「空の状態」もサポートしています。

​

省略

意図的かどうかを問わず、存在しないリソース設定はインポート時にスキップされます。たとえば、リソース設定が削除されている場合、その設定はインポート時にスキップされ、リモートテナントの状態は変更されません。

エクスポートでは、省略という考え方はありません。明示的に除外しない限り、すべてのテナント設定がリソース設定ファイルに書き出されます。

​

例

roles: # rolesの設定は省略されていない
  - name: Admin
    description: Can read and write things
    permissions: []
  - name: Reader
    description: Can only read things
    permissions: []
# 他のすべての設定を省略した場合、それらはスキップされる

​

空

明示的に空であると定義されたリソース設定です。hooks、組織、アクションのような集合ベースの構成では、これらの構成を空集合に設定することで、それらのリソースを意図的に空にすることを示します。これは削除の意思表示となり、削除設定プロパティ AUTH0_ALLOW_DELETE が有効になっている場合に限り、削除として扱われます。このプロパティの詳細については、Deploy CLI を設定するを参照してください。

テナントやブランディングのような非集合ベースのリソース設定には、空という概念は適用されず、削除や除去は発生しません。

​

空の例

hooks: [] # 空のhooks
connections: [] # 空の接続
tenant: {} # 実質的にno-op。空の値は未設定のリソース設定には適用されない