在配置中调用类型提供程序

本页面介绍如何使用通过 Deployment Manager 创建的类型提供程序。本页面不涉及如何创建类型提供程序。如需了解如何创建类型提供程序,请阅读创建类型提供程序

准备工作

访问类型提供程序

类型提供程序是属于项目范围的资源,可以根据访问权限控制文档中描述的权限进行访问。具体来说:

  • 项目编辑者和查看者可以创建和使用该项目可用的类型。
  • 类型查看者可以获取该项目可用的列表和使用类型。

您还可以将另一个项目添加为 Type Viewer,以便该项目访问您的类型。请阅读跨项目共享类型

使用类型提供程序

要在配置中使用由类型提供程序公开的类型,请使用以下语法:

type: [PROJECT_ID]/[TYPE_NAME]:[COLLECTION]
  • 如果此 API 由 OpenAPI 规范提供支持,则 [COLLECTION] 将是资源路径的 REST 标识符。例如:

    type: my-project/emailAddressesTypeProvider:emailAddresses/v1beta/people
    
  • 如果 API 由 Google Discovery 文档提供支持,则 [COLLECTION] 是指向 API 中所需资源的资源路径。例如,要创建一个服务帐号密钥,集合将如下所示:

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

现在,您可以根据底层 API 的要求继续配置类型:

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

后续步骤