Appeler un fournisseur de types dans une configuration

Cette page vous explique comment utiliser un fournisseur de types précédemment créé à l'aide de Deployment Manager. Elle n'explique pas comment en créer un. Consultez la section Créer un fournisseur de types pour savoir comment procéder.

Avant de commencer

Accéder aux fournisseurs de types

Les fournisseurs de types sont des ressources associées à un projet dont l'accès nécessite les autorisations décrites dans la documentation relative au contrôle des accès. Par exemple :

  • Les lecteurs et éditeurs de projet peuvent créer et utiliser des types disponibles pour ce projet.
  • Les lecteurs de type peuvent obtenir la liste des types disponibles pour ce projet et les utiliser.

Vous pouvez également ajouter un autre projet en tant que lecteur de type pour lui permettre d'accéder à vos types. Consultez la section Partager des types entre plusieurs projets pour en savoir plus.

Utiliser un fournisseur de types

Pour utiliser un type diffusé par un fournisseur dans votre configuration, suivez la syntaxe ci-dessous :

type: [PROJECT_ID]/[TYPE_NAME]:[COLLECTION]
  • Si l'API repose sur une spécification OpenAPI, [COLLECTION] représente l'identifiant REST du chemin d'accès à la ressource. Exemple :

    type: my-project/emailAddressesTypeProvider:emailAddresses/v1beta/people
    
  • Si l'API repose sur un document Google Discovery, [COLLECTION] correspond au chemin menant à la ressource souhaitée dans l'API. Par exemple, pour créer une clé de compte de service, la valeur "Collection" serait :

    type: my-project/example-type-provider:projects.serviceAccounts.keys
    

Poursuivez maintenant la configuration de votre type, comme exigé par l'API sous-jacente :

resources:
- name: Jane
  type: my-project/emailAddressesTypeProvider:emailAddresses/v1beta/people
  properties:
  - displayName: Jane
    email: jane@example.com
    ...

Étape suivante