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
Copy file name to clipboardExpand all lines: articles/automation/automation-runbook-types.md
+22-22Lines changed: 22 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ The same Azure sandbox and Hybrid Runbook Worker can execute **PowerShell 5.1**
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
@@ -115,14 +115,14 @@ The following are the current limitations and known issues with PowerShell runbo
115
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.
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.
123
123
- Logging job operations to the Log Analytics workspace through linked workspace or diagnostics settings are not supported.
124
-
- Currently, PowerShell 7.2 (preview) runbooks are only supported from Azure portal. Rest API and PowerShell is not supported.
125
-
- 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.
126
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.
127
127
- PowerShell 7.2 module management is not supported through `Get-AzAutomationModule` cmdlets.
128
128
@@ -187,7 +187,7 @@ Following are the limitations of Python runbooks
187
187
# [Python 2.7](#tab/py27)
188
188
189
189
- You must be familiar with Python scripting.
190
-
- For Python 2.7.12 modules use wheel files cp27-amd6.
190
+
- For Python 2.7.12 modules, use wheel files cp27-amd6.
191
191
- To use third-party libraries, you must [import the packages](python-packages.md) into the Automation account.
192
192
- Azure Automation doesn't support **sys.stderr**.
193
193
- The Python **automationassets** package is not available on pypi.org, so it's not available for import onto a Windows machine.
@@ -200,21 +200,21 @@ Following are the limitations of Python runbooks
200
200
- To use third-party libraries, you must [import the packages](python-packages.md) into the Automation account.
201
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.
202
202
- Azure Automation doesn't support **sys.stderr**.
203
-
- 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.
204
204
205
205
# [Python 3.10 (preview)](#tab/py10)
206
206
207
207
**Limitations**
208
208
209
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 required 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 is not supported.
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.
212
212
213
213
---
214
214
215
215
### Multiple Python versions
216
216
217
-
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.
218
218
219
219
For Python 3, it looks for the `PYTHON_3_PATH` env variable first and then falls back to the `PATH` environment variable.
0 commit comments