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

教程:定义自定义元数据

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

有关 Azure API 中心中的元数据的详细信息,请参阅:

本教程介绍如何使用 Azure 门户:

  • 在 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 中心内的清单。