Exclure des ressources de la gestion

Découvrez comment exclure des ressources de la gestion avec l’Auth0 Deploy CLI.

Dans certains cas, il peut être utile d’exclure des ressources de la gestion. Par exemple, votre tenant peut contenir un grand nombre d’un type de ressource en particulier, ce qui rend leur gestion lourde sur le plan opérationnel. Ou encore, votre workflow de développement peut ne concerner qu’un sous-ensemble précis de ressources, et vous souhaitez laisser de côté toutes les autres pour des raisons de performance. Quoi qu’il en soit, plusieurs options s’offrent à vous pour exclure des ressources lorsque vous utilisez le Deploy CLI.

​

Exclure des ressources entières par type

Dans les tenants plus complexes, vous pourriez vouloir omettre des types de ressources entiers. Par exemple :

• Tenant Enterprise avec des milliers d’organisations, dont la gestion complète représenterait un lourd fardeau opérationnel.
• Le processus CI/CD vise uniquement la gestion des rôles, et vous souhaitez exclure tous les autres.
• Le développement d’une fonctionnalité concerne un hook, et vous souhaitez temporairement exclure tous les autres afin d’optimiser les performances.

Ce type d’exclusion s’exprime en transmettant un tableau de noms de ressources dans l’une ou l’autre des propriétés de configuration AUTH0_EXCLUDED ou AUTH0_INCLUDED_ONLY. La propriété de configuration AUTH0_EXCLUDED exclut uniquement les types de ressources qui lui sont fournis. À l’inverse, la propriété AUTH0_INCLUDED_ONLY exclut toutes les propriétés, sauf celles qui sont définies. L’exclusion fonctionne dans les deux sens, c’est-à-dire à la fois lors de l’exportation depuis Auth0 et de l’importation vers Auth0, que des fichiers de configuration des ressources existent ou non.

Toutes les valeurs de ressource prises en charge pour l’exclusion : 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.

​

Exemple d’exclusion

L’exemple suivant illustre comment exclure clients, connections, databases et organizations pour qu’ils ne soient pas gérés par le Deploy CLI.

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

​

Exemple d’inclusion

L’exemple suivant montre comment configurer le Deploy CLI pour qu’il ne gère que les actions, les clients et les connections.

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

​

Exclure des ressources individuelles par ID

Certains types de ressources permettent d’exclure une ressource précise par son ID. C’est utile si vous travaillez dans un contexte multi-environnement et souhaitez omettre une ressource propre à Production de vos environnements de niveau inférieur.

Cette méthode est prise en charge pour les rules, clients, databases, connections et les serveurs de ressources, avec les valeurs de configuration AUTH0_EXCLUDED_RULES, AUTH0_EXCLUDED_CLIENTS, AUTH0_EXCLUDED_DATABASES, AUTH0_EXCLUDED_CONNECTIONS, AUTH0_EXCLUDED_RESOURCE_SERVERS respectivement.

​

Exemple

{
  "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"]
}

L’exclusion de ressources par ID pourrait être dépréciée dans de futures versions majeures. Consultez la proposition d’exclusion de ressources pour en savoir plus.

​

Omission et états vides

En plus de l’exclusion de ressources, qui consiste à ignorer explicitement les configurations dans les deux sens, l’Auth0 Deploy CLI prend en charge deux concepts similaires : l’omission et les états vides.

​

Omission

Toute configuration de ressource absente, intentionnellement ou non, sera ignorée lors de l’importation. Par exemple, si votre configuration de ressource avait été supprimée, elle serait ignorée lors de l’importation et ne modifierait pas l’état du tenant distant.

La notion d’omission ne s’applique pas à l’exportation. Sauf exclusion explicite, toutes les configurations de votre tenant seront écrites dans des fichiers de configuration des ressources.

​

Exemple

roles: # la configuration des rôles n'est pas omise
  - name: Admin
    description: Can read and write things
    permissions: []
  - name: Reader
    description: Can only read things
    permissions: []
# L'omission de toutes les autres configurations signifie qu'elles seront ignorées

​

Vide

Configuration de ressource explicitement définie comme vide. Pour les configurations fondées sur des ensembles, comme hooks, organizations et actions, le fait de définir ces configurations comme un ensemble vide exprime une volonté explicite de vider ces ressources. Cela indique une suppression, à condition que la propriété de configuration de suppression AUTH0_ALLOW_DELETE soit activée. Pour en savoir plus sur cette propriété, consultez Configurer le Deploy CLI.

Pour les configurations de ressource qui ne sont pas fondées sur des ensembles, comme tenant et branding, la notion d’état vide ne s’applique pas et ne déclenche aucune suppression ni aucun retrait.

​

Exemple de vide

hooks: [] # Hooks vides
connections: [] # Connexions vides
tenant: {} # Équivaut à un no-op, l'état vide ne s'applique pas aux configurations de ressources non ensemblistes