你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

教程:定义自定义元数据

在本教程中,定义自定义元数据,来帮助你在 API 中心组织 API 和其他信息。 使用自定义和内置元数据进行搜索和筛选,并强制实施组织中的治理标准。

有关 Azure API 中心内的元数据的背景信息,请参阅:

本教程介绍如何使用门户来完成以下操作:

  • 在 API 中心定义自定义元数据
  • 查看元数据架构

先决条件

定义元数据

这里定义了两个自定义元数据示例:“业务线”和“面向公众”;如果需要,可自行定义其他元数据。 在清单中添加或更新 API 和其他信息时,需要为自定义元数据和任何常见的内置元数据设置值。

重要

不要在你定义的元数据的标题(名称)中包含任何敏感、机密或个人信息。 这些标题在 Microsoft 用于改进服务功能的监视日志中可见。 但是,其他元数据详细信息和值则是受保护的客户数据。

  1. Azure 门户中,导航到 API 中心。

  2. 在左侧菜单中“资产”下,选择“元数据”>“+ 新建元数据”。

  3. 在“详细信息”选项卡上,输入元数据的相关信息。

    1. 在“标题”中,输入“业务线”。

    2. (可选)输入说明。

    3. 选择“预定义的选项”类型,然后输入市场营销、财务、IT、销售等选项。 (可选)启用“允许选择多个值”。 选择下一步

    显示在门户中添加自定义元数据的屏幕截图。

  4. 在“分配”选项卡上,为 API 选择“必需”。 为“部署和环境”选择“可选”。 (你将在后面的教程中添加这些实体。)选择“下一页”。

    门户中的元数据分配的屏幕截图。

  5. 在“查看 + 创建”选项卡上,查看设置并选择“创建”。

    元数据会添加到“元数据”页上的列表中。

  6. 选择“+ 新建元数据”来另外添加一个示例。

  7. 在“详细信息”选项卡上,输入元数据的相关信息。

    1. 在“标题”中,输入“面向公众”。

    2. 选择“布尔值”类型。

  8. 在“分配”选项卡上,为 API 选择“必需”。 为“部署和环境”选择“不适用”。

  9. 在“查看 + 创建”选项卡上,查看设置并选择“创建”。

    元数据会添加到列表中。

查看元数据架构

可查看和下载在 API 中心定义的元数据的 JSON 架构。 该架构包括内置元数据和自定义元数据。

  1. 在左侧菜单中“资产”下,选择“元数据”>“查看元数据架构”。

  2. 选择“查看元数据架构”>“API”来查看 API 的元数据架构,其中包括内置元数据和自定义元数据。 还可以在 API 中心查看为部署和环境定义的元数据架构。

    门户中元数据架构的屏幕截图。

后续步骤

本教程介绍如何使用门户来完成以下操作:

  • 在 API 中心定义自定义元数据
  • 查看元数据架构

准备好元数据架构后,请将 API 添加到 API 中心内的清单。