Publication d’extensions
Une fois que vous avez développé votre extension, vous voudrez la publier et la mettre à la disposition d’autres utilisateurs pour qu’ils la testent ou l’utilisent. Dans cet article, nous présentons quelques options de publication ainsi que les étapes et les exigences en fonction de votre public et de votre objectif de publication.
Options de publication
Il existe trois options principales pour les sources de package configurables que Windows Admin Center prend en charge :
- Flux NuGet Windows Admin Center public de Microsoft
- Votre propre flux NuGet privé
- Partage de fichiers local ou réseau
Publication dans le flux d’extension Windows Admin Center
Par défaut, Windows Admin Center est connecté à un flux NuGet géré par l’équipe produit Windows Admin Center chez Microsoft. Les préversions des nouvelles extensions développées par Microsoft peuvent être publiées sur ce flux et rendues disponibles pour les utilisateurs de Windows Admin Center. Les développeurs externes qui prévoient de créer et de publier des extensions publiquement peuvent également envoyer une demande pour Publier votre extension sur le flux Windows Admin Center. Avant de publier sur ce flux, les développeurs externes doivent accepter le Contrat d’éditeur d’extensions et la Politique de participation aux extensions de Windows Admin Center.
Publication dans un autre flux NuGet
Vous pouvez aussi créer votre propre flux NuGet pour publier vos extensions en utilisant une des nombreuses options de configuration d’une source privée ou en utilisant un service d’hébergement NuGet. Le flux NuGet doit prendre en charge l’API NuGet v2. Comme Windows Admin Center ne prend actuellement pas en charge l’authentification des flux, le flux doit être configuré pour autoriser l’accès en lecture à tout le monde.
Publication sur un partage de fichiers
Pour restreindre l’accès de votre extension à votre organisation ou à un groupe limité de personnes, vous pouvez utiliser un partage de fichiers SMB comme flux d’extension. Lorsque vous utilisez un partage de fichiers pour héberger votre flux d’extension, les autorisations de fichier et de dossier sont appliquées pour gérer l’accès au flux.
Préparation de votre extension pour la mise en production
Veillez à lire et à prendre en compte les articles suivants sur le développement :
Envisager la publication en tant que version préliminaire
Si vous publiez une préversion de votre extension à des fins d’évaluation, nous vous recommandons ce qui suit :
- Ajoutez « (Préversion) » à la fin du titre de votre extension dans le fichier
.nuspec
- Expliquez les limitations dans la description de votre extension dans le fichier
.nuspec
Création d’un package d’extension
Windows Admin Center utilise des packages et des flux NuGet pour distribuer et télécharger les extensions. Pour que votre package soit délivré, vous devez générer un package NuGet contenant vos plug-ins et vos extensions. Un même package peut contenir une extension d’interface utilisateur et un plug-in de passerelle. La section suivante vous guide tout au long de ce processus.
Créer votre extension
Dès que vous êtes prêt à commencer à empaqueter votre extension, créez un répertoire sur votre système de fichiers, ouvrez une console et accédez-y via une commande cd. Il s’agit du répertoire racine que nous utilisons pour contenir tous les répertoires nuspec et de contenu qui composent notre package. Nous appelons ce dossier Package NuGet pour le reste de cet article.
Extensions d’interface utilisateur
Pour commencer le processus de collecte de tout le contenu nécessaire pour une extension d’interface utilisateur, exécutez « gulp build » sur votre outil et assurez-vous que la génération a réussi. Ce processus regroupe tous les composants dans un dossier appelé « bundle » situé dans le répertoire racine de votre extension (au même niveau que le répertoire src). Copiez ce répertoire et tout son contenu dans le dossier « Package NuGet ».
Plug-ins de passerelle
En utilisant votre infrastructure de génération (qui peut consister simplement à ouvrir Visual Studio et à cliquer sur le bouton Générer), compilez et générez votre plug-in. Ouvrez votre répertoire de sortie de génération, copiez la ou les DLL qui représentent votre plug-in, puis placez-les dans un nouveau dossier « package » dans le répertoire « Package NuGet ». Vous n’avez pas besoin de copier la DLL FeatureInterface, mais seulement la ou les DLL qui représentent votre code.
Créer le fichier nuspec
Pour créer le package NuGet, vous devez d’abord créer un fichier .nuspec
. Un fichier .nuspec
est un manifeste XML qui contient des métadonnées de package NuGet. Ce manifeste est utilisé à la fois pour générer le package et pour fournir des informations aux consommateurs. Placez ce fichier à la racine du dossier « Package NuGet ».
Voici un exemple de fichier .nuspec
et la liste des propriétés obligatoires ou recommandées. Pour obtenir le schéma complet, consultez les Informations de référence sur nuspec. Enregistrez le fichier .nuspec
dans le dossier racine de votre projet en utilisant le nom de fichier de votre choix.
Important
La valeur de <id>
dans le fichier .nuspec
doit correspondre à la valeur de "name"
du fichier manifest.json
de votre projet ; sinon, votre extension publiée ne se chargera pas correctement dans 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>
Propriétés obligatoires ou recommandées
Nom de la propriété | Obligatoire/Recommandée | Description |
---|---|---|
id | Requise | Identificateur de package unique dans le flux. Cette valeur doit correspondre à la valeur « name » dans le fichier manifest.json de votre projet. Pour obtenir des conseils, consultez Choix d’un identificateur de package unique. |
title | Requis pour la publication dans le flux Windows Admin Center | Nom convivial du package, qui est affiché dans le gestionnaire d’extensions de Windows Admin Center. |
version | Requise | Version de l’extension. L’utilisation du Contrôle de version sémantique (convention SemVer) est recommandée, mais pas obligatoire. |
authors | Requise | Si vous publiez pour le compte de votre entreprise, utilisez le nom de votre société. |
description | Requise | Fournissez une description des fonctionnalités de l’extension. |
iconUrl | Recommandé lors de la publication dans le flux Windows Admin Center | URL de l’icône à afficher dans le gestionnaire d’extensions. |
projectUrl | Requis pour la publication dans le flux Windows Admin Center | URL du site web de votre extension. Si vous n’avez pas de site web distinct, utilisez l’URL de la page web du package sur le flux NuGet. |
licenseUrl | Requis pour la publication dans le flux Windows Admin Center | URL du contrat de licence utilisateur final de votre extension. |
files | Requise | Ces deux paramètres configurent la structure de dossiers que Windows Admin Center attend pour les extensions d’interface utilisateur et les plug-ins de passerelle. |
Remarque
Depuis Windows Admin Center 2410, le champ packageType
a été déconseillé et ne doit pas être utilisé. L’utilisation continue de ce champ peut entraîner une lecture incorrecte du fichier NuGet.
Générer le package NuGet d’extension
En utilisant le fichier .nuspec
que vous avez créé, vous devez maintenant créer le .nupkg
du package NuGet, que vous pouvez charger et publier sur le flux NuGet.
- Téléchargez l’outil CLI nuget.exe à partir du site web des outils clients NuGet.
- Exécutez
nuget.exe pack <>.nuspec file name>
pour créer le fichier.nupkg
.
Signer votre package NuGet d’extension
Tous les fichiers .dll
inclus dans votre extension doivent être signés avec un certificat d’une autorité de certification approuvée. Par défaut, l’exécution des fichiers .dll
non signés est bloquée quand Windows Admin Center s’exécute en mode production.
Tous les fichiers Javascript inclus dans votre extension doivent être signés avec un certificat d’une autorité de certification approuvée.
Le package NuGet d’extension doit également être signé pour garantir l’intégrité du package. Windows Admin Center utilise un serveur Kestrel qui charge des certificats TLS/SSL par le nom d’objet du certificat. Vérifiez qu’un seul certificat est installé avec un nom d’objet unique et que le certificat est valide.
Lorsque vous publiez une extension dans le flux d’extension Windows Admin Center de Microsoft, Microsoft signe le package au-dessus de votre signature.
Conseil
Pour vérifier que votre package est correctement signé, vous pouvez utiliser la commande suivante :
nuget.exe verify -All <packageName>.nuget
Tester votre package NuGet d’extension
Votre package d’extension est maintenant prêt pour les tests ! Chargez le fichier .nupkg
sur un flux NuGet ou copiez-le dans un partage de fichiers. Pour voir et télécharger des packages provenant d’un autre flux ou d’un partage de fichiers, vous devez modifier la configuration de votre flux pour qu’elle pointe vers votre flux NuGet ou votre partage de fichiers. Lors des tests, vérifiez que les propriétés sont affichées correctement dans le Gestionnaire d’extensions et que vous pouvez installer et désinstaller correctement votre extension.
Publier votre extension sur le flux Windows Admin Center
En publiant sur le flux Windows Admin Center, vous pouvez mettre votre extension à la disposition de n’importe quel utilisateur Windows Admin Center. Comme le SDK Windows Admin Center est toujours en préversion, nous aimerions travailler en étroite collaboration avec vous pour résoudre les problèmes de développement, et vous aider à délivrer un produit et une expérience de qualité à vos utilisateurs.
Avant de soumettre une demande de révision d’extension à Microsoft, vous devez envoyer un e-mail à wacextensionrequest@microsoft.com exprimer votre intention de publier une extension dans le flux public. Nous vous fournissons des copies du Contrat d’éditeur d’extensions et de la Politique de participation aux extensions : vous devez les passer en revue et en accuser réception par écrit.
Avant de publier la version initiale de votre extension, nous vous recommandons d’envoyer une demande de révision d’extension à Microsoft au moins 2 à 3 semaines avant la publication. Ce délai de 2 à 3 semaines nous donne suffisamment de temps pour passer en revue votre demande et vous permet d’apporter si nécessaire des modifications à votre extension. Une fois que votre extension est prête à être publiée, vous devez nous l’envoyer pour examen. Si votre extension est approuvée, nous la publions pour vous sur le flux. En envoyant à Microsoft votre package d’extension, vous acceptez d’être lié par les termes du Contrat d’éditeur d’extensions et de la Politique de participation aux extensions.
Par la suite, si vous voulez publier une mise à jour de votre extension, vous devez envoyer une autre demande de révision. En fonction de l’étendue de la modification, les délais d’examen des mises à jour sont généralement plus courts.
Envoyer une demande de révision d’extension à Microsoft
Pour envoyer une demande de révision d’extension, fournissez les informations suivantes et envoyez-les par e-mail à wacextensionrequest@microsoft.com. Nous répondons à votre e-mail sous une semaine.
Windows Admin Center - Informations de demande de révision d’extension :
- Nom et adresse e-mail du propriétaire/développeur de l’extension (jusqu’à 3 utilisateurs). Si vous publiez une extension pour le compte de votre entreprise, indiquez l’adresse e-mail de votre entreprise.
- Nom de l’entreprise (obligatoire seulement si vous publiez une extension pour le compte de votre entreprise)
- Nom de l’extension
- Date cible de publication (estimation)
- Pour la soumission d’une nouvelle extension - Description de l’extension (les premières ébauches de conception, les maquettes d’écran ou les captures d’écran du produit sont recommandées)
- Pour l’examen de la mise à jour d’une extension – Description des modifications (inclure des captures d’écran du produit si l’interface utilisateur a considérablement changé)
Envoyer votre package d’extension pour révision et publication
Veillez à suivre les instructions précédentes pour créer un package d’extension et vérifiez que le fichier .nuspec
est défini correctement et que les fichiers sont signés. Nous vous recommandons également d’avoir un site web de projet incluant :
- Description détaillée de votre extension, y compris des captures d’écran ou une vidéo
- Une adresse e-mail ou une fonctionnalité de site web pour recevoir les commentaires ou questions
Quand vous êtes prêt à publier votre extension, envoyez un e-mail à wacextensionrequest@microsoft.com. Nous fournissons des instructions sur la façon de nous envoyer votre package d’extension. Une fois votre package reçu, nous l’examinerons. Une fois votre package d’extension approuvé, nous le publierons sur le flux Windows Admin Center.