Skip to content

Commit 9ffa8d1

Browse files
committed
New feedback updated; added images; sections
1 parent 2fc1acc commit 9ffa8d1

File tree

7 files changed

+32
-12
lines changed

7 files changed

+32
-12
lines changed

articles/automation/manage-runtime-environment.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Manage Runtime environment and associated runbooks in Azure Automation
33
description: This article tells how to manage runbooks in Runtime environment and associated runbooks Azure Automation
44
services: automation
55
ms.subservice: process-automation
6-
ms.date: 12/29/2023
6+
ms.date: 01/16/2024
77
ms.topic: conceptual
88
ms.custom: references_regions
99
---
@@ -63,7 +63,7 @@ An Azure Automation account in supported public region (except Central India, Ge
6363

6464
:::image type="content" source="./media/manage-runtime-environment/create-runtime-environment.png" alt-text="Screenshot shows the entries in basics tab of create runtime environment.":::
6565

66-
1. Select **Next** and in the **Packages** tab, upload the packages required during the runbook execution. The *Az PowerShell package* is uploaded by default for all PowerShell Runtime environments, which includes all cmdlets for managing Azure resources. You can choose the version of Az package from the dropdown.
66+
1. Select **Next** and in the **Packages** tab, upload the packages required during the runbook execution. The *Az PowerShell package* is uploaded by default for all PowerShell Runtime environments, which includes all cmdlets for managing Azure resources. You can choose the version of Az package from the dropdown. Select **None** if you don't want the Package to be uploaded during runbook execution.
6767

6868
:::image type="content" source="./media/manage-runtime-environment/packages-runtime-environment.png" alt-text="Screenshot shows the selections in packages tab of create runtime environment.":::
6969

@@ -145,6 +145,15 @@ https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<reso
145145
```
146146
---
147147

148+
### View components of Az PowerShell package
149+
150+
To view all the component packages of *Az PowerShell package*, run `Get-Module -ListAvailable` cmdlet in a PowerShell runbook.
151+
152+
Job output would show all the component packages and their versions.
153+
154+
:::image type="content" source="./media/manage-runtime-environment/view-components-powershell-package.png" alt-text="Screenshot shows the components of powershell package." lightbox="./media/manage-runtime-environment/view-components-powershell-package.png":::
155+
156+
148157
### Delete Runtime environment
149158

150159
To delete the Runtime environment from the Automation account, follow these steps:
@@ -265,7 +274,7 @@ https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<reso
265274

266275
### Update Runbook
267276

268-
You can update runbook by changing the Runtime environment linked to the runbook. You can choose single or multiple runbooks for update.
277+
You can update runbook by changing the Runtime environment linked to the runbook. You can choose single or multiple runbooks for update. Runbook in running status would not be impacted by changing the Runtime environment linked to that runbook.
269278

270279
#### [Azure portal](#tab/update-runbook-portal)
271280
1. In your Automation account, under **Process Automation**, select **Runbooks**.
@@ -317,9 +326,10 @@ To test runbook execution before publishing Runtime environment changes, follow
317326
:::image type="content" source="./media/manage-runtime-environment/access-runbook.png" alt-text="Screenshot shows how to go to Runbooks page to select runbook." lightbox="./media/manage-runtime-environment/access-runbook.png":::
318327

319328
1. In the **Edit runbook** page, select **Edit in Portal** to open the text editor.
320-
1. The Runtime environment field shows the existing configuration. Select the new Runtime environment from the dropdown list .
329+
1. The Runtime environment field shows the existing configuration. Select the new Runtime environment from the dropdown list.
321330

322331
:::image type="content" source="./media/manage-runtime-environment/edit-runbook.png" alt-text="Screenshot shows how to select new Runtime environment." lightbox="./media/manage-runtime-environment/edit-runbook.png":::
332+
323333
1. Select **Test pane** to test runbook execution with the updated Runtime environment. Select **Start** to begin the test run.
324334
1. Close the test pane and make the required changes in Runbook code or Runtime environment if necessary.
325335
1. Select **Publish** to update the Runtime environment linked to the runbook.
125 KB
Loading
Loading
111 KB
Loading

articles/automation/quickstart-cli-support-powershell-runbook-runtime-environment.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Add support for Azure CLI in PowerShell 7.2 runbooks in Runtime environme
33
titleSuffix: Azure Automation
44
description: This article shows how to add support for Azure CLI in PowerShell 7.2 runbooks in Runtime environment.
55
services: automation
6-
ms.date: 01/03/2024
6+
ms.date: 01/16/2024
77
ms.topic: conceptual
88
ms.custom: references_regions
99
---
@@ -35,8 +35,11 @@ You can run Azure CLI commands in runbooks linked with PowerShell 7.2 Runtime en
3535
1. On **Packages** tab, in the **Package version** dropdown list, you would see **Az version 8.3** and **Azure CLI version 2.52.0** already present.
3636
1. Select **+Add from gallery** to add more packages from gallery and select **Next**.
3737
1. On **Review + create** tab, review the entries and select **Create**.
38-
38+
3939
A notification appears to confirm that a Runtime environment is successfully created.
40+
41+
:::image type="content" source="./media/quickstart-cli-support-powershell-runbook-runtime-environment/create-runtime-environment.png" alt-text="Screenshot shows how to create a runtime environment." lightbox="./media/quickstart-cli-support-powershell-runbook-runtime-environment/create-runtime-environment.png":::
42+
4043

4144
## Create Runbook
4245

articles/automation/quickstart-update-runbook-in-runtime-environment.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@ title: Update PowerShell runbook in Azure Runtime environment
33
titleSuffix: Azure Automation
44
description: This article shows how to update a runbook from PowerShell 5.1 to PowerShell 7.2 in Runtime environment.
55
services: automation
6-
ms.date: 01/02/2024
6+
ms.date: 01/16/2024
77
ms.topic: conceptual
88
ms.custom: references_regions
99
---
1010

1111
# Update runbook from PowerShell 5.1 to PowerShell 7.2
1212

13-
Using the Runtime environment, you can upgrade a runbook from one Runtime version to the other by creating a different Runtime environment and then linking the runbook to it.
13+
Using the Runtime environment, you can upgrade a runbook from one Runtime version to the other by creating a different Runtime environment and then linking the runbook to it. You can follow similar steps for updating Python runbooks.
1414

1515
> [!NOTE]
16-
> A runbook can be mapped to a single Runtime environment, while a specific Runtime environment can be mapped to multiple runbooks.
16+
> [PowerShell 7.1](https://learn.microsoft.com/powershell/scripting/install/powershell-support-lifecycle?view=powershell-7.3#powershell-end-of-support-dates) and [Python 2.7](https://devguide.python.org/versions/) are no longer supported by their respective parent products PowerShell and Python. We recommend that you update outdated runbooks to latest supported versions using Runtime environment.
1717
1818
## Prerequisites
1919

articles/automation/runtime-environment-overview.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Runtime environment in Azure Automation
33
description: This article provides an overview on Runtime environment in Azure Automation.
44
services: automation
55
ms.subservice: process-automation
6-
ms.date: 01/03/2024
6+
ms.date: 01/16/2024
77
ms.topic: conceptual
88
ms.custom: references_regions
99
---
@@ -41,6 +41,12 @@ Runtime environment captures the following details about the job execution envir
4141
> [!NOTE]
4242
> Azure CLI commands are supported (public preview) in runbooks associated with PowerShell 7.2 Runtime environment. Azure CLI commands version 2.52.0 is available as a default package in PowerShell 7.2 Runtime environment.
4343
44+
## Azure CLI package in Runtime environment
45+
46+
Azure CLI commands are supported (public preview) in runbooks associated with PowerShell 7.2 Runtime environment. **Azure CLI version 2.56.0** is available as a default package in PowerShell 7.2 Runtime environment. Azure Automation closely follows the release cadence of newer versions of Azure CLI and supports them in runbooks.
47+
48+
Runbooks linked to PowerShell 7.2 Runtime environment would always execute with the latest Azure CLI version supported by Azure Automation. Likewise, versions declared end-of-support by parent product Azure CLI would no longer be supported by Azure Automation as these could potentially suffer from bugs or security vulnerabilities. Ensure your runbooks are designed to execute seamlessly in newer versions of Azure CLI.
49+
4450
## System-generated Runtime environments
4551

4652
Azure Automation creates system-generated Runtime environments based on the Runtime language, version, and packages/modules present in your Azure Automation account. There are six system-generated Runtime environments:
@@ -52,12 +58,13 @@ Azure Automation creates system-generated Runtime environments based on the Runt
5258
- Python-3.8
5359
- Python-3.10
5460

61+
:::image type="content" source="./media/runtime-environment-overview/system-generated.png" alt-text="Screenshot shows the system generated Runtime environment." lightbox="./media/runtime-environment-overview/system-generated.png":::
62+
5563
You can't edit these Runtime environments. However, any changes that are made in Modules/Packages for the Automation account are automatically reflected in these system-generated Runtime environments.
5664

5765
> [!NOTE]
5866
> Packages present in System-generated Runtime environments are unique to your Azure Automation account and might vary across different accounts.
5967
60-
6168
## Key Benefits
6269

6370
- **Granular control** - enables you to configure the script execution environment by choosing the Runtime language, its version, and dependent modules.
@@ -74,7 +81,7 @@ You can't edit these Runtime environments. However, any changes that are made in
7481
- RBAC permissions cannot be assigned to Runtime environment.
7582
- Runtime environment can't be configured through Azure Automation extension for Visual Studio Code.
7683
- Deleted Runtime environments cannot be recovered.
77-
- The feature is only supported through Azure portal and REST API.
84+
- The feature is only supported through Azure portal and [REST API](https://review.learn.microsoft.com/rest/api/automation/operation-groups?view=rest-automation-2023-05-15-preview&branch=automation202305).
7885

7986
## Switch between new and old experience
8087

0 commit comments

Comments
 (0)