Introduction aux applets de commande pour SharePoint Management Shell

Article
09/24/2014

Dernière modification : jeudi 14 janvier 2010

S’applique à : SharePoint Foundation 2010

Windows PowerShell™ est un nouvel outil de ligne de commande et un langage de script de prise en charge de Microsoft qui vient en complément de Cmd.exe dans le contexte de l’administration de Windows, et qui remplace l’outil d’administration Stsadm.exe. Même si Cmd.exe et Stsadm.exe seront maintenus de façon à assurer une compatibilité descendante, tout le développement actuel et futur de scripts et de fichiers d’administration dans SharePoint Foundation devrait utiliser cette nouvelle technologie de script.

Éléments de base de Windows PowerShell

Au contraire de la plupart des outils de ligne de commande, qui acceptent et retournent du texte, Windows PowerShell est construit sur Microsoft .NET Framework, et il accepte et retourne des objets .NET. Ce changement fondamental de l’environnement apporte des outils et des méthodes entièrement nouveaux qui améliorent grandement le contrôle, l’efficacité et la productivité pour les développeurs et les administrateurs.

Windows PowerShell est un outil de ligne de commande qui introduit le concept d’applet de commande. Une applet de commande est une combinaison verbe-nom comprenant une commande et un objet sur lequel la commande agit. Les noms des applets de commande de Windows PowerShell sont composés de verbes et de noms, séparés par un tiret (-), qui indiquent ensemble leurs propriétés fonctionnelles. Par exemple, le nom de l’applet de commande Get-SPSite combine le verbe (commande) « Get » avec le nom (objet) « SPSite » pour nommer l’applet de commande qui extrait un objet SPSite spécifié. Vous pouvez utiliser des applets de commande individuellement ou bien vous pouvez les chaîner ensemble dans des séquences liées pour effectuer des tâches complexes.

Les noms des applets de commande prennent des paramètres sous la forme de paires nom-valeur qui apportent une spécificité au nom de l’applet de commande. Lorsque les applets de commande sont appelées, elles retournent des objets en sortie. Les objets qui sont retournés ont aussi des propriétés qui s’affichent sous la forme de paires nom-valeur. Les applets de commande retournant des objets, ces objets peuvent être passés (ou « redirigés ») à une autre applet de commande, en séquence. De cette façon, les applets de commande peuvent être chaînées ensemble, offrant ainsi une grande souplesse.

Il s’agit en réalité d’une seule des différences significatives existant entre une applet de commande Windows PowerShell et les commandes dans stsadm.exe. Par exemple, il est important de noter qu’une applet de commande n’est pas un exécutable ; il s’agit plutôt d’une instance d’une classe .NET Framework. Ainsi, à quelques exceptions près, les applets de commande retournent des objets au lieu de flux de texte, et elles traitent des objets en entrée provenant d’un pipeline d’objets.

Comme vous pouvez le voir, Windows PowerShell n’est pas simplement un nouvel outil de ligne de commande. Il s’agit aussi, et ceci est peut-être plus important, d’un nouveau langage de script. Windows PowerShell d’installe en mode natif avec plus de 100 applets de commande Windows principales. La bibliothèque d’applets de commande SharePoint Foundation, qui contient actuellement plus de 500 applets, s’installe par dessus ces applets de commande Windows principales. Ces applets de commande spécifiques à SharePoint sont exposées dans un shell propriétaire spécial appelé SharePoint Management Shell.

Applets de commande pour SharePoint Management Shell

Windows PowerShell fournit à la fois des implémentations générales et des implémentations spécifiques à SharePoint. En réalité, cette différence est reflétée dans le fait que, alors que les applets de commande Windows PowerShell dérivent de la classe de base PSCmdlet, les applets de commande pour SharePoint Foundation dérivent pour leur part d’une classe de base SharePoint spécialisée, appelée SPCmdlet.

Important

La distinction entre les applets de commande Windows PowerShell, qui dérivent de la classe PSCmdlet, et les applets de commande SharePoint, qui dérivent de la classe SPCmdlet, est très importante. Toutes les applets de commande SharePoint livrées avec SharePoint Foundation et qui sont exposées dans le SharePoint Management Shell, sont dérivées de la classe SPCmdlet. De plus, toutes les applets de commande personnalisées que vous écrivez pour prendre en charge vos déploiements SharePoint doivent également être des applets de commande SharePoint.

Vous trouverez ci-dessous la signature pour la classe de base SPCmdlet. Notez que SPCmdlet dérive de la classe PSCmdlet.

public abstract class SPCmdlet : PSCmdlet

Notez que lorsque vous utilisez les applets de commande variable operator, qui comprennent Get, Set, New et Remove, vous devez utiliser les implémentations spécifiques de SPCmdlet, et non pas celles qui sont dérivées de la classe PSCmdlet. Ceci est cohérent avec le modèle de script pour l’utilisation des applets de commande Windows PowerShell dans SharePoint Foundation.

Pour les applets de commande qui manipulent des objets persistants :