Como chamar um provedor de tipos em uma configuração

Nesta página, descrevemos como usar um provedor de tipos criado com o Deployment Manager. Ela não descreve como criar provedores de tipos. Para saber como criar um provedor de tipos, leia sobre como criar um provedor de tipos.

Antes de começar

Como acessar provedores de tipo

Os provedores de tipos são recursos por projeto. Eles podem ser acessados de acordo com as permissões descritas no documento Controle de acesso. Isto é:

  • Os editores e visualizadores de um projeto podem criar e usar os tipos disponíveis nesse projeto.
  • Os visualizadores de tipos podem conseguir uma lista dos tipos e usar aqueles disponíveis para o projeto.

Também é possível adicionar outro projeto como visualizador de tipos, a fim de que ele possa acessar os tipos. Leia Compartilhamento de tipos entre projetos.

Como usar um provedor de tipos

Para usar um tipo exposto por um provedor de tipos na configuração, use a sintaxe a seguir:

type: [PROJECT_ID]/[TYPE_NAME]:[COLLECTION]

  • Se essa API for respaldada por uma especificação OpenAPI, [COLLECTION] será o identificador REST do caminho para o recurso. Por exemplo:

    type: my-project/emailAddressesTypeProvider:emailAddresses/v1beta/people

  • Se a API estiver respaldada em um documento do Google Discovery, [COLLECTION] será o caminho dos recursos que direcionam para o recurso que você quer na API. Por exemplo, para criar uma chave de conta de serviço, a coleção será:

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

Agora, continue a configurar o tipo conforme exigido pela API de base:

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

Próximas etapas