Utiliser des runbooks et des modules existants

  • Article

Au lieu de créer vos propres runbooks et modules dans Azure Automation, vous pouvez accéder à des scénarios déjà générés par Microsoft et la communauté. Vous pouvez obtenir des runbooks PowerShell et Python en rapport avec Azure à partir de la galerie de runbooks dans le portail Azure, ainsi que des modules et des runbooks (qui peuvent être propres ou non à Azure) à partir de PowerShell Gallery. Vous pouvez également contribuer à la communauté en partageant les scénarios que vous développez.

Remarque

Le centre de scripts TechNet est en retrait. Tous les runbooks du Centre de scripts dans la galerie de runbooks ont été déplacés vers notre organisation GitHub Automation. Pour plus d'informations, consultez Azure Automation Runbooks moving to GitHub.

Importer des runbooks à partir de GitHub avec le portail Azure

Remarque

  • L’option Parcourir la galerie dans le portail Azure offre une expérience utilisateur améliorée.
  • Dans le panneau Automatisation de processus>Runbook, vous pouvez importer des runbooks à l’aide de l’option Importer un runbook ou Parcourir la Galerie, tandis que la page Runbooks affiche deux nouvelles colonnes : Version du runtime et Type de runbook.

  1. Dans le portail Azure, sélectionnez votre compte Automation.

  2. Sélectionnez le panneau Runbooks sous Automatisation de processus.

  3. Dans la page Runbooks, cliquez sur Importer un runbook.

    Screenshot of selecting a runbook from import runbook option.

  4. Dans la page Importer un runbook, vous pouvez importer un fichier stocké sur votre ordinateur local ou à partir de GitHub à l’aide respectivement de la commande Rechercher le fichier ou Rechercher dans la galerie.

  5. Sélectionnez le fichier .

  6. Entrez le Nom, la Version du runtime et la Description.

  7. Cliquez sur Importer.

    Screenshot of selecting a runbook from file or gallery.

  8. Vous pouvez également sélectionner Parcourir la galerie dans la page Runbooks pour parcourir les runbooks disponibles.

    Screenshot of selecting browsing gallery option from runbook blade.

  9. Vous pouvez utiliser les filtres situés au-dessus de la liste pour affiner l’affichage par éditeur, par type et par ordre de tri. Recherchez l’élément de la galerie qui vous intéresse et sélectionnez-le pour afficher les informations le concernant.

    Browsing runbook gallery.

  10. Cliquez sur Sélectionner pour sélectionner un runbook choisi.

  11. Dans la page Importer un runbook, entrez le nom, puis sélectionnez les Versions du runtime.

  12. Les champs Type de runbook et Description sont remplis automatiquement.

  13. Cliquez sur Importer.

    Gallery item import.

  14. Ce runbook apparaît sur l’onglet Runbooks du compte Automation.

Important

Vous devez valider le contenu de tous les runbooks que vous obtenez à partir de PowerShell Gallery. Soyez extrêmement vigilant lors de leur installation et de leur exécution dans un environnement de production.

PowerShell Gallery fournit un éventail de runbooks provenant de Microsoft et de la communauté, et que vous pouvez importer dans Azure Automation. Pour utiliser l’un de ces runbooks, vous pouvez en télécharger un à partir de la galerie, ou importer directement des runbooks à partir de la galerie, ou à partir de votre compte Automation sur le portail Azure.

Remarque

Les runbooks graphiques ne sont pas pris en charge dans PowerShell Gallery.

Seul le portail Azure permet d’importer des runbooks directement à partir de PowerShell Gallery. Vous ne pouvez pas exécuter cette fonction à l’aide de PowerShell. La procédure est la même que celle présentée dans Importer des runbooks à partir de GitHub avec le portail Azure, sauf que la source sera PowerShell Gallery.

Showing runbook gallery source selection.

Les modules PowerShell contiennent des cmdlets que vous pouvez utiliser dans vos runbooks. Des modules existants qui peuvent être installés dans Azure Automation sont disponibles dans PowerShell Gallery. Vous pouvez lancer cette galerie sur le Portail Azure et installer les modules directement dans Azure Automation, ou bien les télécharger et les installer manuellement.

Vous trouverez également des modules à importer dans le portail Azure. Ils sont répertoriés pour votre compte Automation dans les Modules sous Ressources partagées.

Important

N’incluez pas le mot clé « AzureRm » dans un script conçu pour être exécuté avec le module Az. L’inclusion de ce mot clé, même dans un commentaire, peut entraîner le chargement d’AzureRm, puis un conflit avec le module Az.

La liste ci-dessous contient quelques runbooks qui fournissent des scénarios courants. Pour obtenir la liste complète des runbooks créés par l’équipe Azure Automation, consultez Profil AzureAutomationTeam.

  • Update-ModulesInAutomationToLatestVersion : importe la version la plus récente de tous les modules dans un compte Automation à partir de PowerShell Gallery.
  • Enable-AzureDiagnostics : configure Diagnostics Azure et Log Analytics pour recevoir les journaux Azure Automation contenant l’état des travaux et les flux des travaux.
  • Copy-ItemFromAzureVM : copie un fichier distant à partir d’une machine virtuelle Microsoft Azure.
  • Copy-ItemToAzureVM : copie un fichier local vers une machine virtuelle Azure.

Contribuer à la communauté

Nous vous encourageons vivement à contribuer au développement de la communauté Azure Automation. Partagez les runbooks exceptionnels que vous avez créés avec la communauté. Vos contributions seront appréciées !

Vous pouvez ajouter de nouveaux runbooks PowerShell ou Python à la galerie de runbooks avec ce workflow GitHub.

  1. Créez un dépôt public sur GitHub, puis ajoutez le runbook et tous les autres fichiers nécessaires (par exemple readme.md, description, et ainsi de suite).

  2. Ajoutez la rubrique azureautomationrunbookgallery pour être sûr que le dépôt soit découvert par notre service et puisse être affiché dans la galerie de runbooks Automation.

  3. Si le runbook que vous avez créé est un workflow PowerShell, ajoutez la rubrique PowerShellWorkflow. S’il s’agit d’un runbook Python 3, ajoutez Python3. Aucune autre rubrique spécifique n’est requise pour les runbooks Azure, mais nous vous encourageons à ajouter d’autres rubriques susceptibles d’être utilisées pour la catégorisation et la recherche dans la galerie de runbooks.

    Remarque

    Consultez les runbooks existants dans la galerie pour en savoir plus sur des éléments tels que la mise en forme, les en-têtes et les étiquettes existantes (comme Azure Automation ou Linux Azure Virtual Machines) que vous pouvez utiliser.

Pour suggérer des modifications à un runbook existant, soumettez une demande de tirage (pull request).

Si vous décidez de cloner et de modifier un runbook existant, la bonne pratique consiste à lui attribuer un nom différent. Si vous réutilisez l’ancien nom, il sera affiché deux fois dans la galerie de runbooks.

Remarque

La synchronisation entre GitHub et la galerie de runbooks Automation, pour les runbooks nouveaux et mis à jour, prend au moins 12 heures.

Microsoft vous invite à ajouter à PowerShell Gallery des runbooks dont vous pensez qu’ils pourraient être utiles à d’autres utilisateurs. PowerShell Gallery accepte les modules PowerShell et les scripts PowerShell. Vous pouvez ajouter un runbook en le chargeant dans PowerShell Gallery.

  1. Dans le portail Azure, sélectionnez votre compte Automation.

  2. Sous Ressources partagées, sélectionnez Modules.

  3. Dans la page Modules, sélectionnez Parcourir la galerie pour ouvrir la liste des modules.

    View of the module gallery.

  4. Sur la page Parcourir la galerie, vous pouvez effectuer des recherches en fonction des champs suivants :

    • Nom du module
    • Balises
    • Auteur
    • Nom Applet de commande/Ressource DSC

  5. Recherchez un module qui vous intéresse et sélectionnez-le pour en afficher les détails.

    Lorsque vous explorez un module spécifique, vous pouvez afficher plus d’informations. Ces informations incluent un lien vers PowerShell Gallery, toutes les dépendances nécessaires et toutes les applets de commande ou ressources DSC que contient le module.

    Detailed view of a module from the gallery.

  6. Pour installer le module directement dans Azure Automation, cliquez sur Importer.

  7. Dans le volet Importer, vous pouvez voir le nom du module à importer. Si toutes les dépendances sont installées, le bouton OK est activé. S'il manque des dépendances, vous devez les importer avant de pouvoir importer ce module.

  8. Dans le volet Importer, cliquez sur OK pour importer le module. Quand il importe un module dans votre compte, le logiciel Azure Automation extrait les métadonnées sur le module et les cmdlets. Cette action peut prendre quelques minutes, car chaque activité doit être extraite.

  9. Vous recevez une première notification indiquant que le module est en cours de déploiement, puis une autre, signalant que le processus est terminé.

  10. Après avoir importé le module, vous pouvez voir les activités disponibles. Vous pouvez utiliser les ressources du module dans vos runbooks et ressources DSC.

Remarque

Les modules qui prennent uniquement en charge PowerShell Core ne sont pas gérés dans Azure Automation et ne sont pas importables dans le Portail Azure, ni déployables directement à partir de PowerShell Gallery.

Demander un runbook ou un module

Vous pouvez envoyer des demandes à User Voice. Si vous avez besoin d’aide pour écrire un runbook ou si vous avez une question à propos de PowerShell, publiez une question sur notre page de questions Microsoft Q&A.

Étapes suivantes