SharePoint Embedded для Visual Studio Code

Расширение SharePoint Embedded Visual Studio Code помогает разработчикам бесплатно приступить к разработке приложений SharePoint Embedded.

Важно!

Чтобы начать сборку с SharePoint Embedded, вам потребуется административный доступ к клиенту Microsoft 365. Если у вас еще нет клиента, вы можете получить собственный клиент с помощью Программы разработчика Microsoft 365, Microsoft Customer Digital Experience или создать бесплатную пробную версию лицензии Microsoft 365 E3.

Установка SharePoint Embedded для Visual Studio Code

1. Откройте новое окно в Visual Studio Code и перейдите к разделу "Расширения" на панели действий.
2. Выполните поиск "SharePoint Embedded" в представлении Расширения. Расширение также можно просмотреть в Visual Studio Marketplace.
3. Выберите "Установить", и на панели действий появится значок SharePoint Embedded.
4. Если она уже установлена, обновите до последней версии, если она доступна.
5. Щелкните значок, чтобы открыть представление SharePoint Embedded и создать тип контейнера с пробной конфигурацией.

Вход с учетными данными администратора

Чтобы использовать расширение, необходимо войти в клиент Microsoft 365 с учетной записью администратора.

• Проверка подлинности открывает новую вкладку во внешнем браузере для предоставления разрешений

  

• Внимательно просмотрите запрошенные разрешения, а затем во всплывающем окне нажмите кнопку Принять с запросом согласия администратора.

  

После успешной авторизации выберите открыть диалоговое окно для перенаправления в VSCode:

Создание типа контейнера с конфигурацией пробной версии

После входа вам будет предложено создать тип контейнера с пробной конфигурацией. Тип контейнера позволяет приступить к вызову API SharePoint Embedded и созданию приложения для подтверждения концепции с помощью SharePoint Embedded. Дополнительные сведения о типах контейнеров.

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

Примечание.

В настоящее время SharePoint Embedded для Visual Studio Code поддерживает только типы контейнеров с пробной конфигурацией. Другие типы контейнеров со стандартными или сквозными конфигурациями выставления счетов должны создаваться с помощью модуля PowerShell SharePoint Online.

Создание приложения Microsoft Entra ID

Каждый тип контейнера принадлежит приложению Microsoft Entra ID. Первым шагом при создании типа контейнера бесплатной пробной версии является создание нового или выбор существующего приложения Microsoft Entra ID в качестве владеющего приложения. Можно либо указать имя нового приложения, либо выбрать одно из существующих приложений. Дополнительные сведения об архитектуре приложений SharePoint Embedded

• Следуйте инструкциям, чтобы присвоить имя новому приложению Entra или выбрать идентификатор существующего приложения:

Примечание.

Если вы выберете существующее приложение, расширение обновит параметры конфигурации этого приложения, чтобы оно работало как с SharePoint Embedded, так и с этим расширением. Это не рекомендуется делать в рабочих приложениях.

После создания типа контейнера и настройки приложения вы сможете просматривать регистрацию локального клиента в виде дерева на панели навигации слева.

Регистрация типа контейнера

После создания типа контейнера необходимо зарегистрировать этот тип контейнера в локальном клиенте. Дополнительные сведения о регистрации типов контейнеров.

• Следуйте инструкциям и выберите Зарегистрировать в локальном клиенте в правом нижнем углу окна VS Code.

  

• Если запрос не отображается, можно щелкнуть правой кнопкой мыши <container-type-name> и выбрать в меню пункт Зарегистрировать .

  

Предоставление разрешений

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

Откроется окно внешнего браузера для входа и предоставления согласия администратора.

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

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

• Щелкните правой кнопкой мыши раскрывающийся список Контейнеры в дереве на панели навигации слева и выберите Создать контейнер.
• Введите имя контейнера, который вы хотите создать.

контейнера

Контейнеры для повторной переработки

Вы также можете перезаработать и восстановить контейнеры в расширении.

Загрузка примера приложения

Создав тип контейнера бесплатной пробной версии, вы можете использовать расширение для загрузки одного из примеров приложений SharePoint Embedded и автоматически заполнить файл конфигурации среды выполнения сведениями о вашем Microsoft Entra ID приложении и типе контейнера.

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

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

Важно!

Это не предназначено для рабочих сред. Дополнительные сведения о настройке регистрации приложений для рабочих сред см. здесь.

Использование примера приложения

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

1. клиентское приложение React — интерфейсный пользовательский интерфейс, работающий через порт 8080
2. сервер приложений функции Azure — сервер API серверной части, обрабатывающий операции SharePoint Embedded.

# Navigate to your sample application directory
cd [your-path]\SharePoint-Embedded-Samples\Samples\spe-typescript-react-azurefunction

# Install dependencies and start the application
npm run start

Примечание.

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

Это позволит установить зависимости и запустить сервер и клиентское приложение. После запуска в терминале вы увидите следующее, после чего сможете перейти http://localhost:8080 к приложению.

После успешного выполнения обоих приложений:

1. Откройте веб-браузер и перейдите по адресу http://localhost:8080
2. Войдите с помощью учетной записи администратора Microsoft 365 (той же учетной записи, которая используется в расширении VS Code)
3. На домашней странице выберите "Контейнеры" , чтобы начать создание контейнеров и отправку файлов.
4. Следуйте инструкциям на экране, чтобы взаимодействовать с контейнерами SharePoint Embedded

Важно!

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

Устранение неполадок

При возникновении проблем:

• Порт уже используется: если порт 8080 уже используется, приложение автоматически попытается использовать следующий доступный порт.
• Зависимости не устанавливаются. Попробуйте запустить npm install вручную, прежде чем npm run start
• Ошибки проверки подлинности. Убедитесь, что приложение Microsoft Entra ID правильно настроено с правильными URI перенаправления.

Экспорт среды Postman

Коллекция SharePoint Embedded Postman позволяет просматривать и вызывать API SharePoint Embedded. Коллекции требуется файл среды с переменными, используемыми для проверки подлинности и различных идентификаторов. Это расширение автоматизирует создание этого заполненного файла среды, поэтому вы можете импортировать его в Postman и немедленно вызывать api SharePoint Embedded.