Руководство. Определение пользовательских метаданных
В этом руководстве определите пользовательские метаданные, которые помогут упорядочить API и другие сведения в центре API. Используйте пользовательские и встроенные метаданные для поиска и фильтрации и применения стандартов управления в организации.
Дополнительные сведения о метаданных в Центре API Azure см. в следующем разделе:
В этом руководстве вы узнаете, как использовать портал для:
- Определение пользовательских метаданных в центре API
- Просмотр схемы метаданных
Необходимые компоненты
- Центр API в подписке Azure. Если вы еще не создали его, см . краткое руководство. Создание центра API.
Определение метаданных
Здесь вы определяете два примера пользовательских метаданных: бизнес и общедоступная, если вы предпочитаете, определите другие метаданные. При добавлении или обновлении API и других сведений в инвентаризации вы задали значения для пользовательских и любых общих встроенных метаданных.
Внимание
Не включать конфиденциальную, конфиденциальную или личную информацию в заголовки (имена) заданных метаданных. Эти заголовки отображаются в журналах мониторинга, используемых корпорацией Майкрософт для улучшения функциональности службы. Однако другие сведения о метаданных и значениях являются защищенными данными клиента.
В портал Azure перейдите в центр API.
В меню слева в разделе "Активы" выберите "Метаданные > и новые метаданные".
На вкладке "Сведения" введите сведения о метаданных.
В поле "Заголовок" введите строку бизнеса.
При необходимости введите Описание.
Выберите стандартные варианты выбора типа и введите такие варианты, как маркетинг, финансы, ИТ-отдел, продажи и т. д. При необходимости включите включение выбора нескольких значений. Выберите Далее.
На вкладке "Назначения" выберите "Обязательный для API". Выберите " Необязательно" для развертываний и сред. (Вы добавите эти сущности в последующих руководствах.) Нажмите кнопку "Далее".
На вкладке "Просмотр и создание" просмотрите параметры и нажмите кнопку "Создать".
Метаданные добавляются в список на странице метаданных .
Выберите +Создать метаданные , чтобы добавить другой пример.
На вкладке "Сведения" введите сведения о метаданных.
В поле "Заголовок" введите public-facing.
Выберите логический тип.
На вкладке "Назначения" выберите "Обязательный для API". Выберите "Неприменимо для развертываний и сред".
На вкладке "Просмотр и создание" просмотрите параметры и нажмите кнопку "Создать".
Метаданные добавляются в список.
Просмотр схемы метаданных
Вы можете просмотреть и скачать схему JSON для метаданных, определенных в центре API. Схема включает встроенные и пользовательские метаданные.
В меню слева в разделе "Активы" выберите схему метаданных представления метаданных>.
Выберите API-интерфейсы схемы > метаданных, чтобы просмотреть схему метаданных для API, которая включает встроенные и настраиваемые метаданные. Вы также можете просмотреть схему метаданных, определенную для развертываний и сред в центре API.
Следующие шаги
В этом руководстве вы узнали, как использовать портал для:
- Определение пользовательских метаданных в центре API
- Просмотр схемы метаданных
Теперь, когда вы подготовили схему метаданных, добавьте API в инвентаризацию в центре API.