You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: This article describes the types of runbooks that you can use in Azure Automation and considerations for determining which type to use.
4
4
services: automation
5
5
ms.subservice: process-automation
6
-
ms.date: 12/28/2022
6
+
ms.date: 03/29/2023
7
7
ms.topic: conceptual
8
8
ms.custom: references_regions
9
9
---
@@ -35,12 +35,12 @@ The PowerShell version is determined by the **Runtime version** specified (that
35
35
The same Azure sandbox and Hybrid Runbook Worker can execute **PowerShell 5.1** and **PowerShell 7.1 (preview)** runbooks side by side.
36
36
37
37
> [!NOTE]
38
-
> - Currently, PowerShell 7.2 (preview) runtime version is supported in five regions for Cloud jobs only: West Central US, East US, South Africa North, North Europe, Australia Southeast
38
+
> - Currently, PowerShell 7.2 (preview) runtime version is supported for both Cloud and Hybrid jobs in all Public regions except Australia Central2, Korea South, Sweden South, Jio India Central, Brazil Southeast, Central India, West India, UAE Central, and Gov clouds.
39
39
> - At the time of runbook execution, if you select **Runtime Version** as **7.1 (preview)**, PowerShell modules targeting 7.1 (preview) runtime version are used and if you select **Runtime Version** as **5.1**, PowerShell modules targeting 5.1 runtime version are used. This applies for PowerShell 7.2 (preview) modules and runbooks.
40
40
41
41
Ensure that you select the right Runtime Version for modules.
42
42
43
-
For example: if you are executing a runbook for a SharePoint automation scenario in **Runtime version***7.1 (preview)*, then import the module in **Runtime version****7.1 (preview)**; if you are executing a runbook for a SharePoint automation scenario in **Runtime version****5.1**, then import the module in **Runtime version***5.1*. In this case, you would see two entries for the module, one for **Runtime Version****7.1(preview)** and other for **5.1**.
43
+
For example: if you're executing a runbook for a SharePoint automation scenario in **Runtime version***7.1 (preview)*, then import the module in **Runtime version****7.1 (preview)**; if you're executing a runbook for a SharePoint automation scenario in **Runtime version****5.1**, then import the module in **Runtime version***5.1*. In this case, you would see two entries for the module, one for **Runtime Version****7.1(preview)** and other for **5.1**.
@@ -65,7 +65,7 @@ The following are the current limitations and known issues with PowerShell runbo
65
65
- Runbooks can't use [parallel processing](automation-powershell-workflow.md#use-parallel-processing) to execute multiple actions in parallel.
66
66
- Runbooks can't use [checkpoints](automation-powershell-workflow.md#use-checkpoints-in-a-workflow) to resume runbook if there's an error.
67
67
- You can include only PowerShell, PowerShell Workflow runbooks, and graphical runbooks as child runbooks by using the [Start-AzAutomationRunbook](/powershell/module/az.automation/start-azautomationrunbook) cmdlet, which creates a new job.
68
-
- Runbooks can't use the PowerShell [#Requires](/powershell/module/microsoft.powershell.core/about/about_requires) statement, it is not supported in Azure sandbox or on Hybrid Runbook Workers and might cause the job to fail.
68
+
- Runbooks can't use the PowerShell [#Requires](/powershell/module/microsoft.powershell.core/about/about_requires) statement, it isn't supported in Azure sandbox or on Hybrid Runbook Workers and might cause the job to fail.
69
69
70
70
**Known issues**
71
71
@@ -80,19 +80,19 @@ The following are the current limitations and known issues with PowerShell runbo
80
80
**Limitations**
81
81
82
82
- You must be familiar with PowerShell scripting.
83
-
- The Azure Automation internal PowerShell cmdlets are not supported on a Linux Hybrid Runbook Worker. You must import the `automationassets` module at the beginning of your Python runbook to access the Automation account shared resources (assets) functions.
84
-
- For the PowerShell 7 runtime version, the module activities are not extracted for the imported modules.
85
-
-*PSCredential* runbook parameter type is not supported in PowerShell 7 runtime version.
86
-
- PowerShell 7.x does not support workflows. See [this](/powershell/scripting/whats-new/differences-from-windows-powershell#powershell-workflow) for more details.
87
-
- PowerShell 7.x currently does not support signed runbooks.
83
+
- The Azure Automation internal PowerShell cmdlets aren't supported on a Linux Hybrid Runbook Worker. You must import the `automationassets` module at the beginning of your Python runbook to access the Automation account shared resources (assets) functions.
84
+
- For the PowerShell 7 runtime version, the module activities aren't extracted for the imported modules.
85
+
-*PSCredential* runbook parameter type isn't supported in PowerShell 7 runtime version.
86
+
- PowerShell 7.x doesn't support workflows. See [this](/powershell/scripting/whats-new/differences-from-windows-powershell#powershell-workflow) for more details.
87
+
- PowerShell 7.x currently doesn't support signed runbooks.
88
88
- Source control integration doesn't support PowerShell 7.1 (preview) Also, PowerShell 7.1 (preview) runbooks in source control gets created in Automation account as Runtime 5.1.
89
-
- PowerShell 7.1 module management is not supported through `Get-AzAutomationModule` cmdlets.
89
+
- PowerShell 7.1 module management isn't supported through `Get-AzAutomationModule` cmdlets.
90
90
- Runbook will fail with no log trace if the input value contains the character '.
91
91
92
92
93
93
**Known issues**
94
94
95
-
- Executing child scripts using `.\child-runbook.ps1`is not supported in this preview.
95
+
- Executing child scripts using `.\child-runbook.ps1`isn't supported in this preview.
96
96
**Workaround**: Use `Start-AutomationRunbook` (internal cmdlet) or `Start-AzAutomationRunbook` (from *Az.Automation* module) to start another runbook from parent runbook.
97
97
- Runbook properties defining logging preference is not supported in PowerShell 7 runtime.
98
98
**Workaround**: Explicitly set the preference at the start of the runbook as below -
@@ -103,7 +103,7 @@ The following are the current limitations and known issues with PowerShell runbo
103
103
```
104
104
- Avoid importing `Az.Accounts` module to version 2.4.0 version for PowerShell 7 runtime as there can be an unexpected behavior using this version in Azure Automation.
105
105
- You might encounter formatting problems with error output streams for the job running in PowerShell 7 runtime.
106
-
- When you import a PowerShell 7.1 module that's dependent on other modules, you may find that the import button is gray even when PowerShell 7.1 version of the dependent module is installed. For example, Az.Compute version 4.20.0, has a dependency on Az.Accounts being >= 2.6.0. This issue occurs when an equivalent dependent module in PowerShell 5.1 doesn't meet the version requirements. For example, 5.1 version of Az.Accounts was < 2.6.0.
106
+
- When you import a PowerShell 7.1 module that's dependent on other modules, you may find that the import button is gray even when PowerShell 7.1 version of the dependent module is installed. For example, Az.Compute version 4.20.0, has a dependency on Az.Accounts being >= 2.6.0. This issue occurs when an equivalent dependent module in PowerShell 5.1 doesn't meet the version requirements. For example, 5.1 version of Az.Accounts were < 2.6.0.
107
107
- When you start PowerShell 7 runbook using the webhook, it auto-converts the webhook input parameter to an invalid JSON.
108
108
109
109
@@ -112,18 +112,17 @@ The following are the current limitations and known issues with PowerShell runbo
112
112
**Limitations**
113
113
114
114
> [!NOTE]
115
-
> Currently, PowerShell 7.2 (preview) runtime version is supported in five regions for Cloud jobs only: West Central US, East US, South Africa North, North Europe, and Australia Southeast.
115
+
> Currently, PowerShell 7.2 (preview) runtime version is supported for both Cloud and Hybrid jobs in all Public regions except Australia Central2, Korea South, Sweden South, Jio India Central, Brazil Southeast, Central India, West India, UAE Central, and Gov clouds.
116
116
117
117
- You must be familiar with PowerShell scripting.
118
-
- For the PowerShell 7 runtime version, the module activities are not extracted for the imported modules.
119
-
-*PSCredential* runbook parameter type is not supported in PowerShell 7 runtime version.
120
-
- PowerShell 7.x does not support workflows. See [this](/powershell/scripting/whats-new/differences-from-windows-powershell#powershell-workflow) for more details.
121
-
- PowerShell 7.x currently does not support signed runbooks.
122
-
- Source control integration doesn't support PowerShell 7.2 (preview). Also, PowerShell 7.2 (preview) runbooks in source control gets created in Automation account as Runtime 5.1.
123
-
- Currently, only cloud jobs are supported for PowerShell 7.2 (preview) runtime versions.
118
+
- For the PowerShell 7 runtime version, the module activities aren't extracted for the imported modules.
119
+
-*PSCredential* runbook parameter type isn't supported in PowerShell 7 runtime version.
120
+
- PowerShell 7.x doesn't support workflows. See [this](/powershell/scripting/whats-new/differences-from-windows-powershell#powershell-workflow) for more details.
121
+
- PowerShell 7.x currently doesn't support signed runbooks.
122
+
- Source control integration doesn't support PowerShell 7.2 (preview). Also, PowerShell 7.2 (preview) runbooks in source control get created in Automation account as Runtime 5.1.
124
123
- Logging job operations to the Log Analytics workspace through linked workspace or diagnostics settings are not supported.
125
-
- Currently, PowerShell 7.2 (preview) runbooks are only supported from Azure portal. Rest API and PowerShell is not supported.
126
-
- Az module 8.3.0 is installed by default and cannot be managed at the automation account level. Use custom modules to override the Az module to the desired version.
124
+
- Currently, PowerShell 7.2 (preview) runbooks are only supported from Azure portal. Rest API and PowerShell isn't supported.
125
+
- Az module 8.3.0 is installed by default and can't be managed at the automation account level. Use custom modules to override the Az module to the desired version.
127
126
- The imported PowerShell 7.2 (preview) module would be validated during job execution. Ensure that all dependencies for the selected module are also imported for successful job execution.
128
127
- PowerShell 7.2 module management is not supported through `Get-AzAutomationModule` cmdlets.
129
128
@@ -166,12 +165,7 @@ PowerShell Workflow runbooks are text runbooks based on [Windows PowerShell Work
166
165
167
166
Python runbooks compile under Python 2, Python 3.8 (preview) and Python 3.10 (preview). You can directly edit the code of the runbook using the text editor in the Azure portal. You can also use an offline text editor and [import the runbook](manage-runbooks.md) into Azure Automation.
168
167
169
-
* Python 3.10 (preview) runbooks are currently supported in five regions for cloud jobs only:
170
-
- West Central US
171
-
- East US
172
-
- South Africa North
173
-
- North Europe
174
-
- Australia Southeast
168
+
Currently, Python 3.10 (preview) runtime version is supported for both Cloud and Hybrid jobs in all Public regions except Australia Central2, Korea South, Sweden South, Jio India Central, Brazil SouthEast, Central India, West India, UAE Central, and Gov clouds.
175
169
176
170
### Advantages
177
171
@@ -193,7 +187,7 @@ Following are the limitations of Python runbooks
193
187
# [Python 2.7](#tab/py27)
194
188
195
189
- You must be familiar with Python scripting.
196
-
- For Python 2.7.12 modules use wheel files cp27-amd6.
190
+
- For Python 2.7.12 modules, use wheel files cp27-amd6.
197
191
- To use third-party libraries, you must [import the packages](python-packages.md) into the Automation account.
198
192
- Azure Automation doesn't support **sys.stderr**.
199
193
- The Python **automationassets** package is not available on pypi.org, so it's not available for import onto a Windows machine.
@@ -206,33 +200,29 @@ Following are the limitations of Python runbooks
206
200
- To use third-party libraries, you must [import the packages](python-packages.md) into the Automation account.
207
201
- Using **Start-AutomationRunbook** cmdlet in PowerShell/PowerShell Workflow to start a Python 3.8 (preview) runbook (preview) doesn't work. You can use **Start-AzAutomationRunbook** cmdlet from Az.Automation module or **Start-AzureRmAutomationRunbook** cmdlet from AzureRm.Automation module to work around this limitation.
208
202
- Azure Automation doesn't support **sys.stderr**.
209
-
- The Python **automationassets** package is not available on pypi.org, so it's not available for import onto a Windows machine.
203
+
- The Python **automationassets** package isn't available on pypi.org, so it's not available for import onto a Windows machine.
210
204
211
205
# [Python 3.10 (preview)](#tab/py10)
212
206
213
207
**Limitations**
214
208
215
-
- For Python 3.10 (preview) modules, currently, only the wheel files targeting cp310 Linux OS are supported. [Learn more](./python-3-packages.md)
216
-
- Currently, only cloud jobs are supported for Python 3.10 (preview) runtime versions.
217
-
- Custom packages for Python 3.10 (preview) are only validated during job runtime. Job is expected to fail if the package is not compatible in the runtime or if required dependencies of packages are not imported into automation account.
218
-
- Currently, Python 3.10 (preview) runbooks are only supported from Azure portal. Rest API and PowerShell is not supported.
209
+
- For Python 3.10 (preview) modules, currently, only the wheel files targeting cp310 Linux OS are supported. [Learn more](./python-3-packages.md).
210
+
- Custom packages for Python 3.10 (preview) are only validated during job runtime. Job is expected to fail if the package is not compatible in the runtime or if necessary dependencies of packages are not imported into automation account.
211
+
- Currently, Python 3.10 (preview) runbooks are only supported from Azure portal. Rest API and PowerShell isn't supported.
219
212
220
213
---
221
214
222
215
### Multiple Python versions
223
216
224
-
It is applicable for Windows Hybrid workers. For a Windows Runbook Worker, when running a Python 2 runbook it looks for the environment variable `PYTHON_2_PATH` first and validates whether it points to a valid executable file. For example, if the installation folder is `C:\Python2`, it would check if `C:\Python2\python.exe` is a valid path. If not found, then it looks for the `PATH` environment variable to do a similar check.
217
+
It's applicable for Windows Hybrid workers. For a Windows Runbook Worker, when running a Python 2 runbook it looks for the environment variable `PYTHON_2_PATH` first and validates whether it points to a valid executable file. For example, if the installation folder is `C:\Python2`, it would check if `C:\Python2\python.exe` is a valid path. If not found, then it looks for the `PATH` environment variable to do a similar check.
225
218
226
219
For Python 3, it looks for the `PYTHON_3_PATH` env variable first and then falls back to the `PATH` environment variable.
227
220
228
221
When using only one version of Python, you can add the installation path to the `PATH` variable. If you want to use both versions on the Runbook Worker, set `PYTHON_2_PATH` and `PYTHON_3_PATH` to the location of the module for those versions.
229
222
230
223
### Known issues
231
224
232
-
For cloud jobs, Python 3.8 jobs sometimes fail with an exception message `invalid interpreter executable path`. You might see this exception if the job is delayed, starting more than 10 minutes, or using **Start-AutomationRunbook** to start Python 3.8 runbooks. If the job is delayed, restarting the runbook should be sufficient. Hybrid jobs should work without any issue if using the following steps:
233
-
234
-
1. Create a new environment variable called `PYTHON_3_PATH` and specify the installation folder. For example, if the installation folder is `C:\Python3`, then this path needs to be added to the variable.
235
-
1. Restart the machine after setting the environment variable.
225
+
For cloud jobs, Python 3.8 jobs sometimes fail with an exception message `invalid interpreter executable path`. You might see this exception if the job is delayed, starting more than 10 minutes, or using **Start-AutomationRunbook** to start Python 3.8 runbooks. If the job is delayed, restarting the runbook should be sufficient.
@@ -81,8 +81,8 @@ Perform the following steps using a 64-bit Linux machine with Python 3.10.x and
81
81
1. On the **Add Python Package** page, select a local package to upload. The package can be a **.whl** or **.tar.gz** file for Python 3.8 (preview) and **.whl** file for Python 3.10 (preview).
82
82
1. Enter a name and select the **Runtime Version** as Python 3.8 (preview) or Python 3.10 (preview).
83
83
> [!NOTE]
84
-
> Python 3.10 (preview) runtime version is currently supported in five regions for Cloud jobs only: West Central US, East US, South Africa North, North Europe, Australia Southeast.
85
-
1. Select **Import**
84
+
> Currently, Python 3.10 (preview) runtime version is supported for both Cloud and Hybrid jobs in all Public regions except Australia Central2, Korea South, Sweden South, Jio India Central, Brazil Southeast, Central India, West India, UAE Central, and Gov clouds.
85
+
1. Select **Import**.
86
86
87
87
:::image type="content" source="media/python-3-packages/upload-package.png" alt-text="Screenshot shows the Add Python 3.8 (preview) Package page with an uploaded tar.gz file selected.":::
0 commit comments