Публикации расширений

• Применяется к:

  ✅ Windows Admin Center, ✅ Windows Admin Center Preview

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

Варианты публикации

Существует три основных варианта для настраиваемых источников пакетов, поддерживаемых Windows Admin Center:

• Общедоступный веб-канал NuGet Центра администрирования Windows
• Собственный частный веб-канал NuGet
• Локальный или сетевой файловый ресурс

Публикация в веб-канале расширения Windows Admin Center

По умолчанию Windows Admin Center подключен к веб-каналу NuGet, поддерживаемом командой продуктов Windows Admin Center в Майкрософт. Ранние предварительные версии новых расширений, разработанных корпорацией Майкрософт, можно опубликовать в этом веб-канале и сделать доступными для пользователей Windows Admin Center. Внешние разработчики, планируя сборку и выпуск расширений, также могут отправить запрос на публикацию расширения в веб-канале Windows Admin Center. Перед публикацией в этом веб-канале внешние разработчики должны согласиться с соглашением издателя расширений Windows Admin Center и политикой участия в расширении.

Публикация в другом веб-канале NuGet

Вы также можете создать собственный веб-канал NuGet для публикации расширений с помощью одного из множества различных вариантов настройки частного источника или использования службы размещения NuGet. Веб-канал NuGet должен поддерживать API NuGet версии 2. Так как Windows Admin Center в настоящее время не поддерживает проверку подлинности веб-канала, веб-канал должен быть настроен, чтобы разрешить доступ на чтение любому пользователю.

Публикация в общей папке

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

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

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

• Управление отображением вашего инструмента
• Строки и локализация

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

Если вы выпускаете предварительную версию расширения для оценки, рекомендуется:

• Добавьте "(предварительная версия)" в конец заголовка расширения в .nuspec файле
• Объяснить ограничения в описании расширения в .nuspec файле

Создание пакета расширения

Windows Admin Center использует пакеты и веб-каналы NuGet для распространения и скачивания расширений. Для отправки пакета необходимо создать пакет NuGet, содержащий подключаемые модули и расширения. Один пакет может содержать расширение пользовательского интерфейса и подключаемый модуль шлюза. В следующем разделе описан процесс.

Создание расширения

Как только вы будете готовы упаковать расширение, создайте новый каталог в файловой системе, откройте консоль, а затем cd в него. Этот каталог является корневым каталогом, который мы используем для хранения всех каталогов nuspec и содержимого, составляющих наш пакет. Мы называем эту папку пакетом NuGet для остальной части этой статьи.

Расширения пользовательского интерфейса

Чтобы начать процесс сбора всего содержимого, необходимого для расширения пользовательского интерфейса, запустите "gulp build" в средстве и убедитесь, что сборка выполнена успешно. Этот процесс упаковает все компоненты вместе в папку с именем "пакет", расположенную в корневом каталоге расширения (на том же уровне каталога src). Скопируйте этот каталог и все его содержимое в папку "Пакет NuGet".

Подключаемые модули шлюза

Используя инфраструктуру сборки (которая может быть простой, как открытие Visual Studio и нажатие кнопки "Сборка"), компиляция и сборка подключаемого модуля. Откройте выходной каталог сборки, скопируйте библиотеки DLL или библиотеки DLL, представляющие подключаемый модуль, и поместите их в новую папку в каталог NuGet Package с именем "package". Не нужно копировать библиотеку DLL FeatureInterface, только библиотеки DLL или библиотеки DLL, представляющие код.

Создание файла nuspec

Чтобы создать пакет NuGet, необходимо сначала создать .nuspec файл. .nuspec Файл представляет собой XML-манифест, содержащий метаданные пакета NuGet. Этот манифест используется при построении пакета и содержит дополнительные сведения для его потребителей. Поместите этот файл в корне папки "Пакет NuGet".

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

Внимание

Значение <id> в файле должно соответствовать .nuspec значению в "name" файле проекта manifest.json или в противном случае опубликованное расширение не будет успешно загружено в Windows Admin Center.

<?xml version="1.0">
<package>
  <metadata>
    <id>contoso.project.extension</id>
    <version>1.0.0</version>
    <title>Contoso Hello Extension</title>
    <authors>Contoso</authors>
    <owners>Contoso</owners>
    <requireLicenseAcceptance>false</requireLicenseAcceptance>
    <projectUrl>https://msft-sme.myget.org/feed/windows-admin-center-feed/package/nuget/contoso.sme.hello-extension</projectUrl>
    <licenseUrl>http://YourLicenseLink</licenseUrl>
    <iconUrl>http://YourLogoLink</iconUrl>
    <description>Hello World extension by Contoso</description>
    <copyright>(c) Contoso. All rights reserved.</copyright>
    <tags></tags>
  </metadata>
  <files>
    <file src="bundle\**\*.*" target="ux" />
    <file src="package\**\*.*" target="gateway" />
  </files>
</package>

Обязательные или рекомендуемые свойства

Имя свойства	Обязательный / рекомендуемый	Description
ID	Обязательное поле	Уникальный идентификатор пакета в веб-канале. Это значение должно соответствовать значению name в manifest.json файле проекта. Инструкции см. в разделе Выбор уникального идентификатора пакета.
title	Требуется для публикации в веб-канале Windows Admin Center	Понятное имя пакета, отображаемого в диспетчере расширений Windows Admin Center.
версия	Обязательное поле	Версия расширения. Использование семантического управления версиями (соглашение SemVer) рекомендуется, но не требуется.
authors	Обязательное поле	При публикации от имени вашей компании используйте имя вашей компании.
описание	Обязательное поле	Укажите описание функциональных возможностей расширения.
iconUrl	Рекомендуется при публикации в веб-канале Windows Admin Center	URL-адрес значка, отображаемого в диспетчере расширений.
projectUrl	Требуется для публикации в веб-канале Windows Admin Center	URL-адрес веб-сайта расширения. Если у вас нет отдельного веб-сайта, используйте URL-адрес веб-страницы пакета на веб-канале NuGet.
licenseUrl	Требуется для публикации в веб-канале Windows Admin Center	URL-адрес лицензионного соглашения конечного пользователя расширения.
files	Обязательное поле	Эти два параметра настраивают структуру папок, которую Windows Admin Center ожидает для расширений пользовательского интерфейса и подключаемых модулей шлюза.

Примечание.

По состоянию на Windows Admin Center 2410 поле packageType устарело и не должно использоваться. Продолжение использования этого поля может привести к неправильному чтению файла NuGet.

Создание пакета NuGet расширения

.nuspec Используя созданный файл, необходимо создать файл пакета .nupkg NuGet, который можно отправить и опубликовать в веб-канале NuGet.

1. Скачайте средство командной строки nuget.exe с веб-сайта клиентских средств NuGet.
2. Чтобы создать файл nuget.exe pack <>.nuspec file name>, выполните .nupkg.

Подписыв пакет NuGet расширения

Все .dll файлы, включенные в расширение, должны быть подписаны сертификатом из доверенного центра сертификации (ЦС). По умолчанию неподписанные .dll файлы блокируются при запуске Windows Admin Center в рабочем режиме.

Все файлы Javascript, включенные в расширение, должны быть подписаны сертификатом из доверенного центра сертификации (ЦС).

Пакет NuGet расширения также должен быть подписан, чтобы обеспечить целостность пакета. Windows Admin Center использует сервер Kestrel, который загружает TLS/SSL-сертификаты по имени субъекта сертификата. Убедитесь, что только один сертификат установлен с уникальным именем субъекта и что сертификат действителен.

При публикации расширения в канале расширений Windows Admin Center, Майкрософт подпишет пакет поверх вашей подписи.

Совет

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

nuget.exe verify -All <packageName>.nuget

Проверка пакета NuGet расширения

Пакет расширения теперь готов к тестированию! Отправьте файл в .nupkg веб-канал NuGet или скопируйте его в общую папку. Чтобы просмотреть и скачать пакеты из другого веб-канала или общей папки, необходимо изменить конфигурацию веб-канала, чтобы указать веб-канал NuGet или общую папку. При тестировании убедитесь, что свойства отображаются правильно в диспетчере расширений, и вы можете успешно установить и удалить расширение.

Публикация расширения в веб-канале Windows Admin Center

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

Перед отправкой запроса на проверку расширения в Корпорацию Майкрософт необходимо отправить электронное письмо, чтобы wacextensionrequest@microsoft.com выразить намерение опубликовать расширение в общедоступном веб-канале. Мы предоставляем вам копии соглашения издателя расширений и политику участия в расширении для проверки и подтверждения в письменной форме.

Перед выпуском начальной версии расширения рекомендуется отправить запрос на проверку расширения корпорации Майкрософт по крайней мере через 2–3 недели до выпуска. Разрешение на 2–3 недели до выпуска гарантирует, что у нас достаточно времени для проверки и внесения изменений в расширение при необходимости. После того как расширение будет готово к публикации, вам потребуется отправить его нам для проверки. Если расширение утверждено, мы опубликуем его в веб-канале. Отправив пакет расширения Майкрософт, вы соглашаетесь быть привязаны условиями соглашения издателя расширений и политикой участия в расширении.

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

Отправка запроса на проверку расширения в Корпорацию Майкрософт

Чтобы отправить запрос на проверку расширения, укажите следующие сведения и отправьте сообщение электронной почты wacextensionrequest@microsoft.com. Мы отвечаем на ваш адрес электронной почты в течение недели.

Windows Admin Center — сведения о запросе на проверку расширения:

• Имя и адрес электронной почты владельца или разработчика расширения (до 3 пользователей). Если вы выпускаете расширение от имени вашей компании, укажите адрес электронной почты вашей компании.
• Имя компании (требуется только в том случае, если вы выпускаете расширение от имени вашей компании)
• Имя расширения
• Дата целевого выпуска (оценка)
• Для новой отправки расширений — описание расширения (рекомендуется ранний дизайн проводных кадров, макетов экрана или снимков экрана продукта)
• Для проверки обновления расширения — описание изменений (включите снимки экрана продукта при значительном изменении пользовательского интерфейса)

Отправка пакета расширения для проверки и публикации

Убедитесь, что вы следуйте приведенным выше инструкциям по созданию пакета расширения, а файл определен правильно и .nuspec файлы подписаны. Мы также рекомендуем использовать веб-сайт проекта, в том числе:

• Подробное описание расширения, включая снимки экрана или видео
• Адрес электронной почты или функция веб-сайта для получения отзывов или вопросов

Когда вы будете готовы опубликовать расширение, отправьте сообщение электронной почты wacextensionrequest@microsoft.comв . Мы предоставляем инструкции по отправке пакета расширения. После получения пакета мы рассмотрим его. После утверждения пакета расширения мы опубликуем веб-канал Windows Admin Center.