Руководство: Определение пользовательских метаданных

В этом руководстве объясняется, как определить пользовательские метаданные, которые помогут упорядочить API и другие сведения в центре API. Вы можете использовать пользовательские и встроенные метаданные для поиска и фильтрации и применения стандартов управления в организации.

Дополнительные сведения о метаданных в Центре API Azure см. в следующем разделе:

• Основные понятия — метаданные
• Использование метаданных для управления API

В этом руководстве вы узнаете, как использовать портал Azure для:

• Определение пользовательских метаданных в центре API
• Просмотр схемы метаданных

Предпосылки

• Центр API в подписке Azure. Чтобы создать его, см. Краткое руководство: Создание центра API.

Определение метаданных

Здесь вы устанавливаете два примера пользовательских метаданных: направление бизнеса и публичная; если вы предпочитаете, определите другие метаданные. При добавлении или обновлении API и других сведений в инвентаризации задайте значения для пользовательских и любых общих встроенных метаданных.

Это важно

Не включать конфиденциальную, конфиденциальную или личную информацию в заголовки (имена) заданных метаданных. Эти заголовки отображаются в журналах мониторинга, используемых корпорацией Майкрософт для улучшения функциональности службы. Однако другие сведения о метаданных и значениях являются защищенными данными клиента.

1. Войдите на портал Azure, а затем перейдите в центр API.

2. В меню боковой панели в разделе "Активы" выберите "Метаданные>+ Добавить метаданные.

3. На вкладке "Сведения" введите сведения о метаданных.

   1. Введите Название должности, затем Направление бизнеса.

   2. При необходимости введите Описание.

   3. Выберите стандартные варианты выбора типа и введите такие варианты, как маркетинг, финансы, ИТ-отдел, продажи и т. д. При необходимости включите включение выбора нескольких значений. Нажмите кнопку Далее.

   

4. На вкладке "Назначения" выберите "Обязательный для API". Выберите Необязательно для развертываний и окружений. Эти сущности можно добавить в последующие руководства. Нажмите кнопку Далее.

   

5. На вкладке "Просмотр и создание " просмотрите параметры и нажмите кнопку "Создать".

   Метаданные добавляются в список на странице метаданных .

6. Выберите +Создать метаданные , чтобы добавить другой пример.

7. На вкладке "Сведения" введите сведения о метаданных.

   1. Для заголовка введите для публичного использования.

   2. Выберите логический тип.

8. На вкладке "Назначения" выберите "Обязательный для API". Выберите "Неприменимо" для развертываний и сред.

9. На вкладке "Просмотр и создание " просмотрите параметры и нажмите кнопку "Создать".

   Метаданные добавляются в список.

Просмотр схемы метаданных

Вы можете просмотреть и скачать схему JSON для метаданных, определенных в центре API. Схема включает встроенные и пользовательские метаданные.

1. В меню слева в разделе "Активы" выберите "Метаданные">Просмотр схемы метаданных.

2. Выберите Просмотр схемы метаданных> API, чтобы увидеть схему метаданных для API, которая включает встроенные и настраиваемые метаданные. Вы также можете просмотреть схему метаданных, определенную для развертываний и сред в центре API.

   

Следующий шаг

Добавьте API-интерфейсы в каталог в центре API.

Регистрация API в инвентаризации API