Руководство. Автоматизация настройки установки приложения-шаблона с помощью функции Azure

Приложения-шаблоны — отличный способ для клиентов начать получать аналитические сведения из своих данных. Приложения-шаблоны быстро получают их и работают, подключая их к своим данным. Приложения шаблона предоставляют клиентам предварительно созданные отчеты, которые они могут настроить, если это необходимо.

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

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

Когда клиент входит на портал, он выбирает специальную ссылку, которую вы подготовили. Эта ссылка:

• Запускает автоматизацию, которая собирает необходимые сведения.
• Предварительно настраивает параметры приложения-шаблона.
• Перенаправляет клиента в учетную запись Power BI, где они могут установить приложение.

Все, что нужно сделать, — установить и пройти проверку подлинности в источнике данных, и они хороши для работы!

Здесь показано взаимодействие с клиентами.

В этом руководстве вы будете использовать пример автоматической установки Функции Azure, который мы создали для предварительной настройки и установки приложения-шаблона. Этот пример намеренно был сохранен простым для демонстрационных целей. Она инкапсулирует настройку функции Azure для использования API Power BI для установки приложения-шаблона и автоматической настройки для пользователей.

Дополнительные сведения о общем потоке автоматизации и API, которые использует приложение, см. в статье "Автоматизация настройки установки приложения шаблона".

Наше простое приложение использует функцию Azure. Дополнительные сведения о функциях Azure см. в документации по функциям Azure.

Базовый поток действий

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

1. Пользователь входит на портал поставщика программного обеспечения и выбирает указанную ссылку. Это действие инициирует поток. Портал поставщика программного обеспечения подготавливает конфигурацию конкретного пользователя на этом этапе.

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

3. С помощью REST API Power BI isV создает запрос на установку, который содержит конфигурацию параметра для конкретного пользователя, подготовленную isV.

4. IsV перенаправляет пользователя в Power BI с помощью POST метода перенаправления, который содержит запрос на установку.

5. Пользователь перенаправляется в учетную запись Power BI с запросом на установку и запрашивает установку приложения-шаблона. Когда пользователь выбирает "Установить", для них устанавливается приложение-шаблон.

Примечание

Хотя значения параметров настраиваются isV в процессе создания билета на установку, учетные данные, связанные с источником данных, предоставляются только пользователем на заключительных этапах установки. Это соглашение предотвращает их предоставление третьим лицам и обеспечивает безопасное подключение между пользователем и источниками данных приложения-шаблона.

Необходимые компоненты

• Ваш собственный клиент Microsoft Entra настроен. Инструкции по настройке одного из них см. в статье "Создание клиента Microsoft Entra".
• Субъект-служба (маркер только для приложений), зарегистрированный в предыдущем клиенте.
• Параметризованное приложение шаблона, готовое к установке. Приложение-шаблон необходимо создать в том же клиенте, в котором вы регистрируете приложение в идентификаторе Microsoft Entra. Дополнительные сведения см. в советах по шаблону приложения или создании приложения-шаблона в Power BI.
• Чтобы протестировать рабочий поток автоматизации, добавьте субъект-службу в рабочую область приложения-шаблона в качестве Администратор.
• Лицензия Power BI Pro. Если вы не зарегистрированы в Power BI Pro, зарегистрируйтесь для получения бесплатной пробной версии, прежде чем начать.

Настройка среды разработки приложений-шаблонов

Прежде чем продолжить настройку приложения, следуйте инструкциям в кратком руководстве. Создайте приложение Функции Azure с Конфигурация приложений Azure для разработки функции Azure вместе с конфигурацией приложения Azure. Создайте конфигурацию приложения, как описано в статье.

Регистрация приложения в идентификаторе Microsoft Entra

Создайте субъект-службу, как описано в разделе Внедрения содержимого Power BI с субъектом-службой и секретом приложения.

Обязательно зарегистрируйте приложение в качестве серверного веб-приложения . Вы регистрируете серверное веб-приложение для создания секрета приложения.

Сохраните идентификатор приложения (ClientID) и секрет приложения (ClientSecret) для дальнейших действий.

Вы можете быстро приступить к созданию регистрации приложения с помощью средства установки внедрения. Если вы используете средство регистрации приложений Power BI, выберите вариант Внедрения для клиентов.

Добавьте субъект-службу в рабочую область приложения-шаблона в качестве Администратор, чтобы вы могли протестировать рабочий поток автоматизации.

Подготовка приложения-шаблона

После создания приложения-шаблона и его готовности к установке сохраните следующие сведения для следующих действий:

• Идентификатор приложения, ключ пакета и идентификатор владельца, как они отображаются в URL-адресе установки в конце процесса определения свойств процесса приложения-шаблона при создании приложения.

  Вы также можете получить ту же ссылку, выбрав ссылку "Получить" в области управления выпусками приложения шаблона.

• Имена параметров, как они определены в семантической модели приложения шаблона. Имена параметров — это строки с учетом регистра. Они также можно получить на вкладке "Параметр Параметры" при определении свойств приложения-шаблона или из параметров семантической модели в Power BI.

Примечание

Вы можете протестировать предварительно настроенное приложение установки в приложении-шаблоне, если приложение шаблона готово к установке, даже если оно еще недоступно в AppSource. Чтобы пользователи за пределами клиента могли использовать приложение автоматической установки для установки приложения-шаблона, приложение-шаблон должно быть общедоступным в Marketplace приложений Power BI. Перед распространением приложения-шаблона с помощью создаваемого автоматического приложения установки обязательно опубликуйте его в Центре партнеров.

Установка и настройка приложения-шаблона

В этом разделе вы будете использовать пример автоматической установки Функции Azure, созданный для предварительной настройки и установки приложения-шаблона. Этот пример намеренно был сохранен простым для демонстрационных целей. Он позволяет использовать функцию Azure и Конфигурация приложений Azure для простого развертывания и использования API автоматической установки для приложений-шаблонов.

Скачайте Visual Studio (версия 2017 или более поздняя версия)

Скачайте Visual Studio (версия 2017 или более поздняя). Обязательно скачайте последний пакет NuGet.

Скачайте пример автоматической установки Функции Azure

Скачайте пример автоматической установки Функции Azure из GitHub, чтобы приступить к работе.

Настройка конфигурации приложения Azure

Чтобы запустить этот пример, необходимо настроить конфигурацию приложения Azure со значениями и ключами, как описано здесь. Ключи — это идентификатор приложения, секрет приложения и значения AppId приложения шаблона, PackageKey и OwnerId. Дополнительные сведения о получении этих значений см. в следующих разделах.

Ключи также определены в файле Constants.cs .

Ключ конфигурации	Значение
TemplateAppInstall:Application:AppId	AppId из URL-адреса установки
TemplateAppInstall:Application:PackageKey	PackageKey из URL-адреса установки
TemplateAppInstall:Application:OwnerId	OwnerId из URL-адреса установки
TemplateAppInstall:ServicePrincipal:ClientId	Идентификатор приложения субъекта-службы
TemplateAppInstall:ServicePrincipal:ClientSecret	Секрет приложения субъекта-службы

Здесь показан файл Constants.cs .

Получение свойств приложения шаблона

Заполните все соответствующие свойства приложения-шаблона по мере их определения при создании приложения. Эти свойства — это значения AppId приложения шаблона, PackageKey и OwnerId.

Чтобы получить предыдущие значения, выполните следующие действия.

1. Войдите в Power BI.

2. Перейдите в исходную рабочую область приложения.

3. Откройте панель управления выпусками.

   

4. Выберите версию приложения и получите ее ссылку на установку.

   

5. Скопируйте ссылку на буфер обмена.

   

6. Этот URL-адрес установки содержит три параметра URL-адреса, значения которых вам нужны. Используйте значения appId, packageKey и ownerId для приложения. Пример URL-адреса будет похож на то, что показано здесь.

   HTML

   https://app.powerbi.com/Redirect?action=InstallApp&appId=3c386...16bf71c67&packageKey=b2df4b...dLpHIUnum2pr6k&ownerId=72f9...1db47&buildVersion=5
   

Получение идентификатора приложения

Заполните сведения applicationId идентификатором приложения из Azure. Значение applicationId используется приложением для идентификации пользователей, из которых запрашивается разрешение.

Чтобы получить идентификатор приложения, выполните следующие действия.

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

2. В левой области выберите все службы> Регистрация приложений.

   

3. Выберите приложение, которое требует идентификатора приложения.

   

4. Существует идентификатор приложения, который указан в качестве GUID. Используйте этот идентификатор приложения в качестве значения applicationId для приложения.

   

Получение секрета приложения

Введите сведения ApplicationSecret из раздела "Ключи" раздела Регистрация приложений в Azure. Этот атрибут работает при использовании субъекта-службы.

Чтобы получить секрет приложения, выполните следующие действия.

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

2. В левой области выберите все службы> Регистрация приложений.

   

3. Выберите приложение, которое должно использовать секрет приложения.

   

4. Выберите сертификаты и секреты в разделе "Управление".

5. Выберите новые секреты клиента.

6. Введите имя в поле "Описание " и выберите длительность. Затем нажмите кнопку "Сохранить", чтобы получить значение для приложения. При закрытии области "Ключи " после сохранения значения ключа поле "Значение " отображается только как скрытое. На этом этапе вы не сможете получить значение ключа. Если вы потеряете значение ключа, создайте новую в портал Azure.

   

Локальное тестирование функции

Выполните действия, описанные в разделе "Запуск функции локально для запуска функции".

Настройте портал для выдачи POST запроса НА URL-адрес функции. Например, POST http://localhost:7071/api/install. Текст запроса должен быть объектом JSON, описывающим пары "ключ-значение". Ключи — это имена параметров, определенные в Power BI Desktop. Значения — это требуемые значения, которые необходимо задать для каждого параметра в приложении-шаблоне.

Примечание

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

Требуемый поток должен быть следующим:

1. Портал подготавливает запрос для каждого пользователя или сеанса.
2. Запрос POST /api/install выдается функции Azure. Текст запроса состоит из пар "ключ-значение". Ключ — это имя параметра. Это значение является требуемым значением, которое необходимо задать.
3. Если все настроено правильно, браузер должен автоматически перенаправляться в учетную запись Power BI клиента и отображать поток автоматической установки.
4. После установки значения параметров задаются в шагах 1 и 2.

Связанный контент

Публикация проекта в Azure

Чтобы опубликовать проект в Azure, следуйте инструкциям в документации по Функции Azure. Затем вы можете интегрировать API автоматической установки приложения-шаблона в продукт и начать тестирование его в рабочих средах.