Veröffentlichen von Erweiterungen
Nachdem Sie Ihre Erweiterung entwickelt haben, möchten Sie sie veröffentlichen und anderen zum Testen oder Verwenden zur Verfügung stellen. In diesem Artikel werden einige Veröffentlichungsoptionen sowie die Schritte und Anforderungen je nach Zielgruppe und Zweck der Veröffentlichung vorgestellt.
Veröffentlichungsoptionen
Es gibt drei primäre Optionen für konfigurierbare Paketquellen, die Windows Admin Center unterstützt:
- Öffentlicher NuGet-Feed zu Windows Admin Center von Microsoft
- Ihr eigener privater NuGet-Feed
- Lokale Dateifreigabe oder Netzwerkdateifreigabe
Veröffentlichen im Windows Admin Center-Erweiterungsfeed
Standardmäßig ist Windows Admin Center mit einem NuGet-Feed verbunden, der vom Windows Admin Center-Produktteam bei Microsoft verwaltet wird. Frühe Vorschauversionen neuer Erweiterungen, die von Microsoft entwickelt wurden, können in diesem Feed veröffentlicht und Windows Admin Center-Benutzer*innen zur Verfügung gestellt werden. Externe Entwickler*innen, die Erweiterungen öffentlich erstellen und veröffentlichen möchten, können auch eine Anforderung zum Veröffentlichen Ihrer Erweiterung im Windows Admin Center-Feed übermitteln. Vor der Veröffentlichung in diesem Feed müssen externe Entwickler*innen der Erweiterungsherausgebervereinbarung und der Erweiterungsbeteiligungsrichtlinie von Windows Admin Center zustimmen.
Veröffentlichen in einem anderen NuGet-Feed
Sie können auch einen eigenen NuGet-Feed erstellen, um Ihre Erweiterungen zu veröffentlichen, indem Sie eine der vielen verschiedenen Optionen zum Einrichten einer privaten Quelle oder zum Verwenden eines NuGet-Hostingdiensts verwenden. Der NuGet-Feed muss die NuGet v2-API unterstützen. Da Windows Admin Center derzeit keine Feedauthentifizierung unterstützt, muss der Feed so konfiguriert werden, dass jede Person Lesezugriff hat.
Veröffentlichen in einer Dateifreigabe
Um den Zugriff auf Ihre Erweiterung auf Ihre Organisation oder eine begrenzte Gruppe von Personen einzuschränken, können Sie eine SMB-Dateifreigabe als Erweiterungsfeed verwenden. Wenn Sie eine Dateifreigabe zum Hosten Ihres Erweiterungsfeeds verwenden, werden Datei- und Ordnerberechtigungen angewendet, um den Zugriff auf den Feed zu verwalten.
Vorbereiten der Erweiterung für die Veröffentlichung
Stellen Sie sicher, dass Sie die folgenden Entwicklungsartikel lesen und berücksichtigen:
Erwägen der Veröffentlichung als Vorschauversion
Wenn Sie eine Vorschauversion Ihrer Erweiterung zu Testzwecken veröffentlichen, empfehlen wir Folgendes:
- Anfügen von „(Vorschau)“ am Ende des Erweiterungstitels in der Datei vom Typ
.nuspec - Erläutern der Einschränkungen in der Beschreibung Ihrer Erweiterung in der Datei vom Typ
.nuspec
Erstellen eines Erweiterungspakets
Windows Admin Center verwendet NuGet-Pakete und -Feeds zum Verteilen und Herunterladen von Erweiterungen. Damit Ihr Paket versendet wird, müssen Sie ein NuGet-Paket mit Ihren Plug-Ins und Erweiterungen generieren. Ein einzelnes Paket kann eine UI-Erweiterung und ein Gateway-Plug-In enthalten. Im folgenden Abschnitt wird der Prozess Schritt für Schritt beschrieben.
Erstellen Ihrer Erweiterung
Sobald Sie mit dem Packen Ihrer Erweiterung beginnen können, erstellen Sie ein neues Verzeichnis in Ihrem Dateisystem. Öffnen Sie dann eine Konsole und geben Sie darin „CD“ ein. Dieses Verzeichnis ist das Stammverzeichnis, das wir verwenden, um alle NUSPEC- und Inhaltsverzeichnisse aufzunehmen, aus denen unser Paket besteht. Im restlichen Artikel wird dieser Ordner NuGet-Paket genannt.
UI-Erweiterungen
Um mit dem Sammeln aller für eine UI-Erweiterung erforderlichen Inhalte zu beginnen, führen Sie „gulp build“ für Ihr Tool aus, und stellen Sie sicher, dass der Build erfolgreich ist. Bei diesem Prozess werden alle Komponenten in einem Ordner namens „bundle“ zusammengefasst, der sich im Stammverzeichnis Ihrer Erweiterung (auf derselben Ebene des src-Verzeichnisses) befindet. Kopieren Sie dieses Verzeichnis und den gesamten Inhalt in den Ordner „NuGet-Paket“.
Gateway-Plug-Ins
Kompilieren und erstellen Sie Ihr Plug-In mithilfe Ihrer Buildinfrastruktur. (Unter Umständen müssen Sie dazu lediglich Visual Studio öffnen und die Schaltfläche „Erstellen“ auswählen.) Öffnen Sie Ihr Buildausgabeverzeichnis, kopieren Sie die DLLs, die Ihr Plug-In darstellen, und legen Sie sie in einem neuen Ordner namens „package“ im Verzeichnis „NuGet-Paket“ ab. Sie müssen die FeatureInterface-DLL nicht kopieren, nur die DLLs, die Ihren Code darstellen.
Erstellen der NUSPEC-Datei
Zum Erstellen des NuGet-Pakets müssen Sie zunächst eine Datei vom Typ .nuspec erstellen. Bei einer Datei vom Typ .nuspec handelt es sich um eine XML-Manifestdatei, die NuGet-Paketmetadaten enthält. Diese Manifestdatei wird sowohl für die Erstellung des Pakets als auch zur Bereitstellung von Informationen für die Benutzer verwendet. Platzieren Sie diese Datei im Stammverzeichnis des Ordners „NuGet-Paket“.
Im Folgenden finden Sie eine .nuspec-Beispieldatei und die Liste der erforderlichen oder empfohlenen Eigenschaften. Das vollständige Schema finden Sie in der NUSPEC-Referenz. Speichern Sie die Datei vom Typ .nuspec im Stammordner Ihres Projekts mit einem Dateinamen Ihrer Wahl.
Wichtig
Der Wert <id> in der .nuspec-Datei muss mit dem Wert "name" in der Datei manifest.json Ihres Projekts übereinstimmen, andernfalls wird die veröffentlichte Erweiterung in Windows Admin Center nicht erfolgreich geladen.
<?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>
Erforderliche oder empfohlene Eigenschaften
| Eigenschaftenname | Erforderlich / Empfohlen | Beschreibung |
|---|---|---|
| Kennung | Erforderlich | Eindeutiger Paketbezeichner innerhalb des Feeds. Dieser Wert muss mit dem Wert „name“ in der manifest.json-Datei Ihres Projekts übereinstimmen. Informationen finden Sie unter Choosing a unique package identifier (Auswählen eines eindeutigen Paketbezeichners). |
| title | Erforderlich für die Veröffentlichung im Windows Admin Center-Feed | Anzeigename für das Paket, das im Windows Admin Center-Erweiterungs-Manager angezeigt wird |
| Version | Erforderlich | Erweiterungsversion. Die Verwendung der semantischen Versionsverwaltung (SemVer-Konvention) wird empfohlen, ist jedoch nicht erforderlich. |
| authors | Erforderlich | Wenn Sie im Namen Ihres Unternehmens veröffentlichen, verwenden Sie den Namen Ihres Unternehmens. |
| description | Erforderlich | Geben Sie eine Beschreibung der Funktionen für die Erweiterung an. |
| iconUrl | Empfohlen für die Veröffentlichung im Windows Admin Center-Feed | URL für Symbol, das im Erweiterungs-Manager angezeigt werden soll. |
| projectUrl | Erforderlich für die Veröffentlichung im Windows Admin Center-Feed | URL zur Website Ihrer Erweiterung. Wenn Sie keine separate Website haben, verwenden Sie die URL für die Paketwebseite im NuGet-Feed. |
| licenseUrl | Erforderlich für die Veröffentlichung im Windows Admin Center-Feed | URL zum Endbenutzer-Lizenzvertrag Ihrer Erweiterung. |
| files | Erforderlich | Mit diesen beiden Einstellungen wird die Ordnerstruktur eingerichtet, die Windows Admin Center für UI-Erweiterungen und Gateway-Plug-Ins erwartet. |
Hinweis
Ab Windows Admin Center 2410 ist das feld "packageType" veraltet und sollte nicht verwendet werden. Die fortgesetzte Verwendung dieses Felds kann dazu führen, dass die NuGet-Datei nicht ordnungsgemäß gelesen wird.
Erstellen des NuGet-Erweiterungspakets
Mithilfe der von Ihnen erstellten Datei vom Typ .nuspec müssen Sie nun die .nupkg-Datei des NuGet-Pakets erstellen, die Sie hochladen und im NuGet-Feed veröffentlichen können.
- Laden Sie das CLI-Tool „nuget.exe“ von der Website für NuGet-Clienttools herunter.
- Führen Sie
nuget.exe pack <>.nuspec file name>aus, um die Datei.nupkgzu erstellen.
Signieren des NuGet-Erweiterungspakets
Alle Dateien vom Typ .dll, die in Ihrer Erweiterung enthalten sind, müssen mit einem Zertifikat einer vertrauenswürdigen Zertifizierungsstelle (Certificate Authority, CA) signiert werden. Standardmäßig wird die Ausführung nicht signierter Dateien vom Typ .dll blockiert, wenn Windows Admin Center im Produktionsmodus ausgeführt wird.
Alle Javascript-Dateien, die in Ihrer Erweiterung enthalten sind, müssen mit einem Zertifikat von einer vertrauenswürdigen Zertifizierungsstelle (Ca) signiert werden.
Das NuGet-Erweiterungspaket muss auch signiert werden, um die Integrität des Pakets sicherzustellen. Windows Admin Center verwendet einen Kestrel-Server, der TLS/SSL-Zertifikate anhand des Betreffnamens des Zertifikats lädt. Stellen Sie sicher, dass nur ein Zertifikat mit einem eindeutigen Subjektnamen installiert ist und dass das Zertifikat gültig ist.
Wenn Sie eine Erweiterung im Erweiterungsfeed des Windows Admin Centers von Microsoft veröffentlichen, signiert Microsoft das Paket zusätzlich zu Ihrer Signatur.
Tipp
Um zu überprüfen, ob Ihr Paket ordnungsgemäß signiert ist, können Sie den folgenden Befehl verwenden:
nuget.exe verify -All <packageName>.nuget
Testen des NuGet-Erweiterungspakets
Ihr Erweiterungspaket kann jetzt getestet werden. Laden Sie die .nupkg-Datei in einen NuGet-Feed hoch, oder kopieren Sie sie in eine Dateifreigabe. Zum Anzeigen und Herunterladen von Paketen aus einem anderen Feed oder einer anderen Dateifreigabe müssen Sie Ihre Feedkonfiguration so ändern, dass sie auf Ihren NuGet-Feed oder Ihre Dateifreigabe verweist. Stellen Sie beim Testen sicher, dass die Eigenschaften im Erweiterungs-Manager ordnungsgemäß angezeigt werden und Sie die Erweiterung erfolgreich installieren und deinstallieren können.
Veröffentlichen ihrer Erweiterung im Windows Admin Center-Feed
Durch die Veröffentlichung im Windows Admin Center-Feed können Sie Ihre Erweiterung allen Windows Admin Center-Benutzer*innen zur Verfügung stellen. Da sich das Windows Admin Center SDK noch in der Vorschauphase befindet, möchten wir eng mit Ihnen zusammenarbeiten, um Entwicklungsprobleme zu beheben und Sie dabei zu unterstützen, dass Sie Ihren Benutzer*innen ein qualitativ hochwertiges Produkt und die bestmögliche Benutzererfahrung bieten können.
Bevor Sie eine Anforderung zur Überprüfung der Erweiterung an Microsoft senden, müssen Sie eine E-Mail an wacextensionrequest@microsoft.com senden. Darin erklären Sie Ihre Absicht, eine Erweiterung im öffentlichen Feed zu veröffentlichen. Wir stellen Ihnen Kopien der Erweiterungsherausgebervereinbarung und der Erweiterungsbeteiligungsrichtlinie zur Verfügung, um sie zu überprüfen und schriftlich zu bestätigen.
Vor der Veröffentlichung der ersten Version Ihrer Erweiterung wird empfohlen, dass Sie mindestens 2 bis 3 Wochen vor der Veröffentlichung eine Anforderung zur Überprüfung der Erweiterung an Microsoft senden. Ein Zeitraum von 2 bis 3 Wochen vor der Veröffentlichung stellt sicher, dass wir genügend Zeit haben, Ihre Erweiterung zu überprüfen und gegebenenfalls Änderungen an Ihrer Erweiterung vorzunehmen. Sobald Ihre Erweiterung veröffentlicht werden kann, müssen Sie sie zur Überprüfung an uns senden. Wenn Ihre Erweiterung genehmigt wird, veröffentlichen wir sie für Sie im Feed. Indem Sie Microsoft Ihr Erweiterungspaket senden, erklären Sie sich damit einverstanden, sich an die Bedingungen der Erweiterungsherausgebervereinbarung und der Erweiterungsteilnahmerichtlinie zu halten.
Wenn Sie anschließend ein Update für Ihre Erweiterung freigeben möchten, müssen Sie eine weitere Anforderung zur Überprüfung übermitteln. Je nach Änderungsumfang ist die Bearbeitungszeit für Updateüberprüfungen jedoch in der Regel kürzer.
Senden einer Anforderung zur Überprüfung der Erweiterung an Microsoft
Um eine Anforderung zur Überprüfung der Erweiterung zu senden, geben Sie die folgenden Informationen ein, und senden Sie als E-Mail an wacextensionrequest@microsoft.com. Wir beantworten Ihre E-Mail innerhalb einer Woche.
Windows Admin Center – Informationen zur Anforderung der Erweiterungsüberprüfung:
- Name und E-Mail-Adresse des Erweiterungsbesitzers bzw. der Erweiterungsbesitzerin/des Entwicklers bzw. der Entwicklerin (bis zu drei Benutzer*innen). Wenn Sie eine Erweiterung im Namen Ihres Unternehmens veröffentlichen, geben Sie die E-Mail-Adresse Ihres Unternehmens an.
- Firmenname (nur erforderlich, wenn Sie eine Erweiterung im Namen Ihres Unternehmens veröffentlichen)
- Name der Erweiterung
- Zieldatum für die Veröffentlichung (Schätzung)
- Bei Übermittlung einer neuen Erweiterung: Erweiterungsbeschreibung (frühe Entwürfe, Bildschirmmodelle oder Produktscreenshots empfohlen)
- Bei Überprüfung des Erweiterungsupdates: Beschreibung der Änderungen (Produktscreenshots einschließen, wenn sich die Benutzeroberfläche erheblich geändert hat)
Übermitteln des Erweiterungspakets zur Überprüfung und Veröffentlichung
Befolgen Sie unbedingt die obigen Anweisungen zum Erstellen eines Erweiterungspakets. Die .nuspec-Datei muss ordnungsgemäß definiert und die Dateien müssen signiert sein. Es wird auch empfohlen, dass Sie über eine Projektwebsite verfügen, die Folgendes enthält:
- Detaillierte Beschreibung Ihrer Erweiterung einschließlich Screenshots oder Video
- E-Mail-Adresse oder Websitefunktion, um Feedback oder Fragen zu senden
Wenn Sie bereit sind, Ihre Erweiterung zu veröffentlichen, senden Sie eine E-Mail an wacextensionrequest@microsoft.com. Wir stellen Anweisungen dazu bereit, wie Sie uns Ihr Erweiterungspaket senden können. Nachdem wir Ihr Paket erhalten haben, überprüfen wir es. Nach der Genehmigung Ihres Erweiterungspakets veröffentlichen wir es im Windows Admin Center-Feed.