Создание ресурсов с помощью REST API

Важно!

Поддержка единого единого каталога Microsoft Purview и классических возможностей управления данными Microsoft Purview (ранее Azure Purview) прекращается. Корпорация Майкрософт консолидирует возможности управления данными в Microsoft Fabric. Вы больше не можете создавать новые учетные записи, а существующие возможности будут оставаться в режиме обслуживания до 12 ноября 2027 г. Сроки прекращения поддержки, руководство по переходу и рекомендуемые дальнейшие действия см. в объявлении о прекращении поддержки управления данными Microsoft Purview.

В этом руководстве вы узнаете, как создавать ресурсы в Схеме данных Microsoft Purview, которые пользователи могут искать и просматривать в Едином каталоге Microsoft Purview.

Примечание.

Если вы используете бесплатную версию Microsoft Purview, только пользователи в группе ролей куратора данных смогут получить доступ к этим ресурсам.

Если у вас уже есть субъект-служба и маркер проверки подлинности, можно перейти непосредственно к действиям по созданию ресурсов с помощью REST API. В противном случае следуйте указаниям по вызову REST API.

Предварительные условия

Создание субъекта-службы (приложения)

Чтобы клиент REST API мог получить доступ к Microsoft Purview для создания сущностей, клиент должен иметь субъект-службу (приложение) и удостоверение, которое Microsoft Purview распознает и настраивает как доверенное.

Клиенты, которые использовали существующие субъекты-службы (идентификаторы приложений), часто сталкиваются со сбоями. Поэтому рекомендуется создать новый субъект-службу для вызова API.

Чтобы создать новый субъект-службу:

  1. Войдите на портал Azure.

  2. На портале найдите и выберите Microsoft Entra ID.

  3. На странице Microsoft Entra ID выберите "Регистрация приложений" на панели слева.

  4. Выберите Новая регистрация.

  5. На странице Регистрация приложения :

    1. Введите имя приложения (имя субъекта-службы).
    2. Выберите "Учетные записи" только в этом каталоге организации (<только имя> клиента — один клиент).
    3. В поле "URI перенаправления (необязательно)" выберите "Интернет " и введите значение. Это значение не обязательно должно быть допустимой конечной точкой. https://exampleURI.com сойдет.
    4. Нажмите Зарегистрировать.
  6. На новой странице субъекта-службы скопируйте значения Отображаемого имени и идентификатора приложения (клиента), чтобы сохранить их для дальнейшего использования.

    Идентификатор приложения — это client_id значение в примере кода.

Чтобы использовать субъект-службу (приложение), необходимо знать пароль субъекта-службы:

  1. Выберите субъект-службу (приложение) в списке "Регистрация приложений".
  2. Выберите "Сертификаты & секреты" на панели слева.
  3. Щелкните Создать секрет клиента.
  4. На странице "Добавление секрета клиента " введите описание, выберите время окончания срока действия в разделе "Истекает", а затем нажмите кнопку "Добавить".
  5. На странице "Секреты клиента " строка в столбце "Значение " нового секрета - это ваш пароль. Сохранить это значение.

Настройка проверки подлинности с помощью субъекта-службы

После создания нового субъекта-службы необходимо назначить разрешения, чтобы субъект-служба мог получить доступ к вашей учетной записи Microsoft Purview. Разрешения, которые необходимо назначить, зависят от того, используете ли вы классический интерфейс Microsoft Purview или новый портал Microsoft Purview.

Выберите вкладку для используемого интерфейса.

  1. Перейдите на портал управления Microsoft Purview.

  2. Выберите "Схема данных" в меню слева.

  3. Выберите "Коллекции".

  4. Выберите корневую коллекцию в меню коллекций. Это коллекция, которая занимает первое место в списке, ее имя совпадает с именем вашей учетной записи Microsoft Purview.

    Примечание.

    Вы также можете назначить разрешение субъекта-службы для любых подколлекций вместо корневой коллекции. Однако все API будут ограничены этой коллекцией (и подколлекциями, наследующими разрешения), и пользователи, пытающиеся вызвать API для другой коллекции, будут получать ошибки.

  5. Откройте вкладку "Назначения ролей ".

  6. Назначьте роль "Куратор данных" субъекту службы, созданному ранее. Подробные инструкции см. в статье Назначение ролей Azure с помощью портала управления Microsoft Purview.

После назначения разрешений необходимо собрать маркер проверки подлинности.

  1. Чтобы получить маркер доступа, отправьте запрос POST на следующий URL:

    https://login.microsoftonline.com/{your-tenant-id}/oauth2/token

    Идентификатор клиента можно узнать, выполнив поиск свойств клиента на портале Azure. Идентификатор доступен на странице свойств клиента.

    Следующие параметры должны быть переданы на указанный выше URL-адрес:

    • client_id: идентификатор клиента приложения, зарегистрированного в Microsoft Entra ID и назначенного роли в плоскости данных для учетной записи Microsoft Purview.
    • client_secret: секрет клиента, созданный для указанного выше приложения.
    • grant_type. Должно быть "client_credentials".
    • resource: Это должно быть 'https://purview.azure.net'

    Вот пример запроса POST в PowerShell:

    $tenantID = "12a345bc-67d1-ef89-abcd-efg12345abcde"
    
    $url = "https://login.microsoftonline.com/$tenantID/oauth2/token"
    $params = @{ client_id = "00001111-aaaa-2222-bbbb-3333cccc4444"; client_secret = "abcd~a1234bcd56789012abcdabcd1234abcd"; grant_type = "client_credentials"; resource = ‘https://purview.azure.net’ }
    
    Invoke-WebRequest $url -Method Post -Body $params      -UseBasicParsing | ConvertFrom-Json
    

    Пример маркера ответа:

    {
        "token_type": "Bearer",
        "expires_in": "86399",
        "ext_expires_in": "86399",
        "expires_on": "1621038348",
        "not_before": "1620951648",
        "resource": "https://purview.azure.net",
        "access_token": "<<access token>>"
    }
    

    Совет

    Если вы получили следующее сообщение об ошибке: Активация маркеров независимо от источника разрешена только для клиента типа "Одностраничное приложение".

    • Проверьте заголовки запроса и убедитесь, что он не содержит заголовок "origin".
    • Убедитесь, что в субъекте-службе для URI перенаправления установлено значение " Интернет ".
    • Убедитесь, что программное обеспечение для приложения, используемого для отправки запроса POST, обновлено.
  2. Используйте маркер доступа выше для вызова API плоскости данных.

Создание ресурсов с помощью REST API

Теперь, когда у вас есть маркер и вы можете пройти проверку подлинности, вы готовы создать свои ресурсы.

Важно!

Конечные точки URL-адреса запроса зависят от того, какой интерфейс Microsoft Purview вы используете: классический интерфейс Microsoft Purview или новый портал Microsoft Purview

Создание ресурсов Azure

Ниже приведен пример, который можно использовать для создания сущностей для ресурсов Azure. Этот пример охватывает учетную запись хранения Azure, но ее можно использовать для любых других источников Azure.

Важно!

Чтобы использовать этот пример для своих ресурсов Azure, замените эти значения в полезных данных:

  • typeName
  • Владелец
  • квалифицированоИмя
  • name
  • Идентификатор эксперта
  • Сведения об эксперте
  • ИД владельца
  • Сведения о владельце
  • Создано пользователем
  • Обновлено

URL-адрес запроса: https://{accountName}.purview.azure.com/catalog/api/atlas/v2/entity

Метод: POST

Проверка подлинности: используйте маркер, полученный на предыдущем шаге, в качестве маркера носителя.

Пример полезных данных:

{
  "referredEntities": {},
  "entity": {
    "typeName": "azure_storage_account",
    "attributes": {
      "owner": "ExampleOwner",
      "modifiedTime": 0,
      "createTime": 0,
      "qualifiedName": "https://exampleaccount.core.windows.net",
      "name": "ExampleStorageAccount",
      "description": null,
      "publicAccessLevel": null
    },
    "contacts": {
      "Expert": [
        {
          "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2d2",
          "info": "Example Expert Info"
        }
      ],
      "Owner": [
        {
          "id": " 30435ff9-9b96-44af-a5a9-e05c8b1ae2d2",
          "info": "Example Owner Info"
        }
      ]
    },
    "status": "ACTIVE",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "version": 0
  }
}

Создание ресурсов для нескольких облаков

Ниже приведен пример, который можно использовать для создания сущностей для ресурсов мультиоблачной среды. В этом примере создается ресурс Snowflake, но его можно использовать для любых других источников

Важно!

Чтобы использовать этот пример для своих ресурсов Azure, замените эти значения в полезных данных:

  • typeName
  • Владелец
  • квалифицированоИмя
  • name
  • type
  • Идентификатор эксперта
  • Сведения об эксперте
  • ИД владельца
  • Сведения о владельце
  • Создано пользователем
  • Обновлено

URL-адрес запроса: https://{accountName}.purview.azure.com/catalog/api/atlas/v2/entity

Метод: POST

Проверка подлинности: используйте маркер, полученный на предыдущем шаге, в качестве маркера носителя.

Пример полезных данных:

{
  "referredEntities": {},
  "entity": {
    "typeName": "snowflake_table",
    "attributes": {
      "owner": "ExampleOwner",
      "modifiedTime": 0,
      "createTime": 0,
      "qualifiedName": "snowflake://microsoft_partner.east-us-2.azure.snowflakecomputing.com/databases/AZUREPURVIEW_TESTDB/schemas/COMPANY/tables/PROJECT_INFO",
      "name": "PROJECT_INFO",
      "description": null,
      "type": "TABLE"
    },
    "contacts": {
      "Expert": [
        {
          "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2d2",
          "info": "Example Expert Info"
        }
      ],
      "Owner": [
        {
          "id": "4b27e65f-6a15-4925-a4ef-2e640445079b",
          "info": "Example Owner Info"
        }
      ]
    },
    "status": "ACTIVE",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "version": 0
  }
}

Дальнейшие действия