Skip to content

Commit e5d34c4

Browse files
authored
Merge pull request #69190 from georgewallace/gw_gallery
Updates to gallery article
2 parents e1baa51 + 68aee6e commit e5d34c4

File tree

3 files changed

+25
-39
lines changed

3 files changed

+25
-39
lines changed

articles/automation/automation-runbook-gallery.md

Lines changed: 25 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -6,65 +6,48 @@ ms.service: automation
66
ms.subservice: process-automation
77
author: georgewallace
88
ms.author: gwallace
9-
ms.date: 09/11/2018
9+
ms.date: 03/20/2019
1010
ms.topic: conceptual
1111
manager: carmonm
1212
---
1313
# Runbook and module galleries for Azure Automation
1414

1515
Rather than creating your own runbooks and modules in Azure Automation, you can access scenarios that have already been built by Microsoft and the community.
1616

17-
You can get runbooks from the [Runbook Gallery](#runbooks-in-runbook-gallery) and modules from the [PowerShell Gallery](#modules-in-powerShell-gallery). You can also contribute to the community by sharing scenarios that you develop, see [Adding a runbook to the gallery](automation-runbook-gallery.md#adding-a-runbook-to-the-runbook-gallery)
17+
You can get [PowerShell runbooks](#runbooks-in-runbook-gallery) and [modules](#modules-in-powerShell-gallery) from the PowerShell Gallery and [Python runbooks](#python-runbooks) from the Script Center Gallery. You can also contribute to the community by sharing scenarios that you develop, see [Adding a runbook to the gallery](#adding-a-runbook-to-the-runbook-gallery)
1818

19-
## Runbooks in Runbook Gallery
19+
## Runbooks in PowerShell Gallery
2020

21-
The [Runbook Gallery](https://gallery.technet.microsoft.com/scriptcenter/site/search?f\[0\].Type=RootCategory&f\[0\].Value=WindowsAzure&f\[1\].Type=SubCategory&f\[1\].Value=WindowsAzure_automation&f\[1\].Text=Automation) provides a variety of runbooks from Microsoft and the community that you can import into Azure Automation. To use one, download a runbook from the gallery, which is hosted in the [TechNet Script Center](https://gallery.technet.microsoft.com/scriptcenter/site/upload), or you can directly import runbooks from the gallery in the Azure portal.
21+
The [PowerShell Gallery](https://www.powershellgallery.com/packages) provides a variety of runbooks from Microsoft and the community that you can import into Azure Automation. To use one, download a runbook from the gallery, or you can directly import runbooks from the gallery, or from your Automation Account in the Azure portal.
2222

23-
You can only import directly from the Runbook Gallery using the Azure portal. You cannot perform this function using Windows PowerShell.
23+
You can only import directly from the PowerShell Gallery using the Azure portal. You cannot perform this function using PowerShell.
2424

2525
> [!NOTE]
26-
> You should validate the contents of any runbooks that you get from the Runbook Gallery and use extreme caution in installing and running them in a production environment.
26+
> You should validate the contents of any runbooks that you get from the PowerShell Gallery and use extreme caution in installing and running them in a production environment.
2727
28-
### To import a runbook from the Runbook Gallery with the Azure portal
28+
### To import a PowerShell runbook from the Runbook Gallery with the Azure portal
2929

3030
1. In the Azure portal, open your Automation account.
3131
2. Under **Process Automation**, click on **Runbooks gallery**
32-
3. Locate the gallery item you want and select it to view its details. On the left, you can enter additional search parameters for the publisher and type.
32+
3. Select **Source: PowerShell Gallery**.
33+
4. Locate the gallery item you want and select it to view its details. On the left, you can enter additional search parameters for the publisher and type.
3334

3435
![Browse gallery](media/automation-runbook-gallery/browse-gallery.png)
3536

36-
4. Click on **View source project** to view the item in the [TechNet Script Center](https://gallery.technet.microsoft.com/).
37-
5. To import an item, click on it to view its details and then click the **Import** button.
37+
5. Click on **View source project** to view the item in the [TechNet Script Center](https://gallery.technet.microsoft.com/).
38+
6. To import an item, click on it to view its details and then click the **Import** button.
3839

3940
![Import button](media/automation-runbook-gallery/gallery-item-detail.png)
4041

41-
6. Optionally, change the name of the runbook and then click **OK** to import the runbook.
42-
7. The runbook appears on the **Runbooks** tab for the Automation Account.
43-
44-
### Adding a runbook to the runbook gallery
45-
46-
Microsoft encourages you to add runbooks to the Runbook Gallery that you think would be useful to other customers. You can add a runbook by [uploading it to the Script Center](https://gallery.technet.microsoft.com/site/upload) taking into account the following details.
47-
48-
* You must specify *Windows Azure* for the **Category** and *Automation* for the **Subcategory** for the runbook to be displayed in the wizard.
49-
* The upload must be a single `.ps1` or `.graphrunbook` file. If the runbook requires any modules, child runbooks, or assets, then you should list those items in the description of the submission and in the comments section of the runbook. If you have a scenario requiring multiple runbooks, then upload each separately and list the names of the related runbooks in each of their descriptions. Make sure that you use the same tags so that they show up in the same category. A user will have to read the description to know that other runbooks are required the scenario to work.
50-
* Add the tag "GraphicalPS" if you're publishing a **Graphical runbook** (not a Graphical Workflow).
51-
* Insert either a PowerShell or PowerShell Workflow code snippet into the description using **Insert code section** icon.
52-
* The Summary for the upload is displayed in the Runbook Gallery results so you should provide detailed information that helps a user identify the functionality of the runbook.
53-
* You should assign one to three of the following Tags to the upload. The runbook is listed in the wizard under the categories that match its tags. Any tags not on this list are ignored by the wizard. If you don’t specify any matching tags, the runbook is listed under the Other category.
54-
55-
* Backup
56-
* Capacity Management
57-
* Change Control
58-
* Compliance
59-
* Dev / Test Environments
60-
* Disaster Recovery
61-
* Monitoring
62-
* Patching
63-
* Provisioning
64-
* Remediation
65-
* VM Lifecycle Management
66-
67-
* Automation updates the Gallery once an hour, so you won’t see your contributions immediately.
42+
7. Optionally, change the name of the runbook and then click **OK** to import the runbook.
43+
8. The runbook appears on the **Runbooks** tab for the Automation Account.
44+
45+
### Adding a PowerShell runbook to the gallery
46+
47+
Microsoft encourages you to add runbooks to the PowerShell Gallery that you think would be useful to other customers. The PowerShell Gallery accepts PowerShell modules and PowerShell scripts. You can add a runbook by [uploading it to the PowerShell Gallery](/powershell/gallery/how-to/publishing-packages/publishing-a-package).
48+
49+
> [!NOTE]
50+
> Graphical runbooks are not supported in PowerShell Gallery.
6851
6952
## Modules in PowerShell Gallery
7053

@@ -94,15 +77,18 @@ PowerShell modules contain cmdlets that you can use in your runbooks, and existi
9477
6. To install the module directly into Azure Automation, click the **Import** button.
9578
7. When you click the Import button, on the **Import** pane, you see the module name that you're about to import. If all the dependencies are installed, the **OK** button is activated. If you're missing dependencies, you need to import those dependencies before you can import this module.
9679
8. On the **Import** page, click **OK** to import the module. While Azure Automation imports a module to your account, it extracts metadata about the module and the cmdlets. This action may take a couple of minutes since each activity needs to be extracted.
97-
9. You receive an initial notification that the module is being deployed and another notification when it has completed.
80+
9. You receive an initial notification that the module is being deployed and another notification when it has completed.
9881
10. After the module is imported, you can see the available activities. You can use its resources in your runbooks and Desired State Configuration.
9982

10083
> [!NOTE]
10184
> Modules that only support PowerShell core are not supported in Azure Automation and are unable to be imported in the Azure portal, or deployed directly from the PowerShell Gallery.
10285
10386
## Python Runbooks
10487

105-
Python Runbooks are available in the [Script Center gallery](https://gallery.technet.microsoft.com/scriptcenter/site/search?f%5B0%5D.Type=RootCategory&f%5B0%5D.Value=WindowsAzure&f%5B1%5D.Type=ProgrammingLanguage&f%5B1%5D.Value=Python&f%5B1%5D.Text=Python&sortBy=Date&username=). You can contribute Python runbooks to the Script Center gallery. When you do, ensure that you add the tag **Python** when uploading your contribution.
88+
Python Runbooks are available in the [Script Center gallery](https://gallery.technet.microsoft.com/scriptcenter/site/search?f%5B0%5D.Type=RootCategory&f%5B0%5D.Value=WindowsAzure&f%5B1%5D.Type=ProgrammingLanguage&f%5B1%5D.Value=Python&f%5B1%5D.Text=Python&sortBy=Date&username=). You can contribute Python runbooks to the Script Center gallery by clicking **Upload a contribution**. When you do, ensure that you add the tag **Python** when uploading your contribution.
89+
90+
> [!NOTE]
91+
> In order to upload content to [Script Center](https://gallery.technet.microsoft.com/scriptcenter) a minimum of 100 points is required.
10692
10793
## Requesting a runbook or module
10894

95.4 KB
Loading
54.5 KB
Loading

0 commit comments

Comments
 (0)