Подготовка приложения к установке клиента

Применимо к: ISV

Используйте эту статью перед отправкой приложения SharePoint Embedded клиенту. SharePoint Embedded поддерживает только API, поэтому установка клиента зависит от регистрации типа контейнера, согласия, разрешений и конфигурации выставления счетов, а не от традиционного развертывания сайта SharePoint. Ваша цель — предоставить администратору клиента полный, повторяющийся пакет подключения.

Важно!

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

Поток установки клиента

Клиентское приложение SharePoint Embedded обычно выполняется следующим образом:

1. Выберите модель приложения и модель клиента для продукта.
2. Зарегистрируйте или настройте владеющее приложение в клиенте разработчика.
3. Создайте стандартный рабочий тип контейнера для этого владеющего приложения.
4. Выберите стандартное выставление счетов или сквозное выставление счетов для типа контейнера.
5. Подготовьте Microsoft Entra сведения о согласии для администратора клиента.
6. Предоставьте клиенту инструкции по настройке.
7. Попросите клиента при необходимости выполнить регистрацию типа контейнера, согласие администратора и настройку выставления счетов.
8. Убедитесь, что приложение может создавать и использовать контейнеры в используемом клиенте.

Следующее решение в пути публикации см. в статье Выбор модели выставления счетов для приложения.

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

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

Область	Требование
Клиент Microsoft 365	Доступен активный клиент SharePoint.
Роль администратора	Глобальный администратор или администратор SharePoint Embedded может управлять типами контейнеров.
Приложение	У вас есть Microsoft Entra приложение, которому будет принадлежать тип контейнера.
Тип контейнера	У вас есть рабочий стандартный тип контейнера, а не тип контейнера пробной версии.
Решение о выставлении счетов	Вы знаете, использует ли приложение стандартное или сквозное выставление счетов.
Пакет клиента	Вы можете указать идентификаторы приложений, URL-адреса перенаправления, разрешения, контакты поддержки и шаги проверки.

Понимание ответственности разработчика

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

Разработчики могут использовать расширение sharePoint Embedded Visual Studio Code или API Microsoft Graph fileStorageContainerType для создания, перечисления, обновления и удаления типов контейнеров. Создание графа является делегированным и не требует роли администратора. Дополнительные сведения см. в статье Создание и настройка типа контейнера.

Сведения о решениях модели и клиента см. в разделе Выбор модели приложения.

Упаковка конфигурации приложения

Предоставьте клиентам точные идентификаторы и URL-адреса, необходимые для проверки и утверждения приложения. Не просите администратора клиента вывести эти значения из кода.

Включите в пакет установки следующие сведения:

• Название продукта и имя издателя.
• Владение идентификатором приложения.
• Идентификатор типа контейнера после его создания.
• Имя типа контейнера.
• Модель выставления счетов: стандартная или сквозная.
• URL-адрес перенаправления приложения, если он настроен для типа контейнера.
• URL-адрес входа для клиента.
• URL-адрес службы поддержки для клиентов.
• Список разрешений Microsoft Entra, запрошенных приложением.
• Использует ли приложение делегированные разрешения, разрешения приложения или и то, и другое.
• Указывает, требуется ли гостевой приложению доступ к приложению-владельцем.
• Расположение, хранение и границы поддержки данных для вашего приложения.
• Шаги проверки, которые клиент может выполнить после установки.

Подтвердите связь типа приложения-хозяйки и контейнера

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

Создайте рабочий тип контейнера с помощью расширения Visual Studio Code SharePoint Embedded или API Создания файла Microsoft GraphStorageContainerType. Создание Microsoft Graph является делегированным и не требует роли администратора.

Настройка типа производственного контейнера

Создайте стандартный тип контейнера для использования клиентом. SharePoint Embedded поддерживает два варианта выставления счетов в рабочей среде:

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

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

Важно!

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

Определите, что должен сделать клиент

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

Задачи независимого поставщика программного обеспечения

Выполните следующие задачи, прежде чем клиент начнет настройку:

1. Создайте или настройте приложение, владеющее Microsoft Entra.
2. Создайте рабочий тип контейнера.
3. Настройте параметры типа контейнера, которые применяются ко всем контейнерам.
4. Документирование Microsoft Entra требований к согласию.
5. Задокументируйте, требуется ли выставление счетов за сквозную передачу.
6. Подготовьте контрольный список проверки.
7. Укажите контакты эскалации на сбои установки.

Задачи администрирования клиента

Попросите администратора клиента выполнить следующие задачи в своем клиенте:

1. Ознакомьтесь с издателем приложения, разрешениями и документацией по обработке данных.
2. При необходимости предоставьте согласие администратора.
3. Зарегистрируйте тип контейнера в используемом клиенте с помощью потока регистрации приложения.
4. Настройте выставление счетов, если приложение использует сквозное выставление счетов.
5. Убедитесь, что приложение отображается в интерфейсе администрирования клиента.
6. Убедитесь, что контейнеры можно создавать и управлять ими.

Инструкции по настройке клиента см. в разделе Руководство по настройке клиента.

Руководство по подготовке разрешений

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

Как минимум, приложение SharePoint Embedded, установленное на потребляющий клиент, запрашивает следующие разрешения Microsoft Graph:

Разрешение	Тип	Назначение
FileStorageContainerTypeReg.Selected	Делегировано или приложение	Зарегистрируйте тип контейнера в используемом клиенте. С делегированным разрешением пользователь, выполняющий регистрацию, должен быть администратором SharePoint Embedded или глобальным администратором. Для разрешения приложения требуется согласие администратора; делегированное разрешение не имеет.
FileStorageContainer.Selected	Делегировано или приложение	Взаимодействие с содержимым SharePoint Embedded для типа контейнера. Для разрешения приложения требуется согласие администратора; делегированное разрешение не имеет.

Важно!

Рекомендуется использовать SharePoint Embedded от имени пользователя (делегированный доступ). Это повышает безопасность и возможность аудита действий, выполняемых приложением.

Для приложений с одним клиентом можно создать URL-адрес согласия администратора и предоставить его администратору Microsoft Entra клиента, например:

https://login.microsoftonline.com/{tenant}/v2.0/adminconsent?client_id={client_id}&redirect_uri={redirect_uri}

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

Если ваше приложение использует доступ к гостевым приложениям, объясните, как администратор клиента может просматривать разрешения гостевого приложения в средствах администрирования.

Предостережение

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

Подготовка руководства по выставлению счетов

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

Для стандартного выставления счетов:

• Объясните, что вашему клиенту разработчика принадлежит отношение выставления счетов за потребление SharePoint Embedded.
• Сообщите клиенту, входит ли использование SharePoint Embedded в ваше коммерческое соглашение.
• Убедитесь, что клиенту не нужно настраивать подписку на Azure для выставления счетов SharePoint Embedded.

Для выставления счетов за сквозную передачу:

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

Подготовка материалов для передачи администратора

Создайте краткий пакет передачи администратора, который включает в себя:

• Общие сведения об установке.
• Сведения об удостоверениях издателя и приложения.
• Сводка по безопасности и соответствию требованиям.
• Сводка по модели выставления счетов.
• Microsoft Entra шаги согласия.
• Действия по настройке клиента.
• Контрольный список проверки.
• Руководство по откату или удалению.
• Поддержка контактов и ожидаемое время отклика.

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

Предоставление контрольного списка проверки

Добавьте контрольный список, который клиент может заполнить с вами после установки:

• Администратор клиента может определить приложение SharePoint Embedded в клиенте.
• Администратор клиента предоставил ожидаемое согласие.
• При необходимости включено сквозное выставление счетов.
• Приложение может создать тестовый контейнер.
• Приложение может передавать, считывать и удалять тестовое содержимое.
• Администратор клиента может просматривать сведения о контейнере.
• Поведение внешнего общего доступа соответствует политике клиента.
• Тестовые данные удаляются после проверки.

Подробные сведения см. в разделе Проверка установки клиентского приложения.

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

Выберите правильный вариант выставления счетов, прежде чем отправлять инструкции по установке клиенту: Выберите модель выставления счетов для приложения.