Azure Automation - Runtime Environment and its Packages - Powershell cmdlets by kaarthik2103 · Pull Request #29867 · Azure/azure-powershell

kaarthik2103 · 2026-07-21T09:43:21Z

Description

This PR implements functionality for PowerShell cmdlets for managing Runtime Environments and Packages in Azure Automation. These cmdlets support the Azure Automation Runtime Environment experience, allowing customers to define custom execution environments for runbooks with:

Specific PowerShell runtime versions
Specific Python runtime versions
Custom module/package dependencies
Consistent and reusable execution configurations across Automation workloads.

Cmdlets functionality:

ARE-pwsh-cmdlets.md

Local testing document:

Testing - ARE cmdlets.docx

Mandatory Checklist

Please choose the target release of Azure PowerShell. (⚠️Target release is a different concept from API readiness. Please click below links for details.)
- General release
- Public preview
- Private preview
- Engineering build
- No need for a release
Check this box to confirm: I have read the Submitting Changes section of CONTRIBUTING.md and reviewed the following information:

SHOULD update ChangeLog.md file(s) appropriately
- Update src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.
  - A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense.
- Should not change ChangeLog.md if no new release is required, such as fixing test case only.
SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
SHOULD have proper test coverage for changes in pull request.
SHOULD NOT adjust version of module manually in pull request

azure-pipelines · 2026-07-21T09:43:30Z

Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run.

kaarthik2103 · 2026-07-21T09:49:19Z

@microsoft-github-policy-service agree company="microsoft"

Copilot

Pull request overview

This PR adds new Az.Automation PowerShell cmdlets for managing Azure Automation Runtime Environments and Runtime Environment Packages, including client-side plumbing (AutomationPSClient + management SDK operations/models), help docs, module exports, and initial unit test coverage.

Changes:

Added cmdlets to Get/New/Set/Remove Runtime Environments and Runtime Environment Packages.
Extended AutomationPSClient/IAutomationPSClient and the Automation management SDK surface area to call the new Runtime Environment + Package REST operations.
Added markdown help for the new cmdlets, updated Az.Automation.psd1 exports and ChangeLog.md, and added unit tests for Runtime Environment cmdlets.

Reviewed changes

Copilot reviewed 27 out of 43 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
src/Automation/Automation/Properties/Resources.resx	Adds localized strings for Runtime Environment / Package not-found & already-exists cases.
src/Automation/Automation/Properties/Resources.Designer.cs	Exposes the new resource strings via strongly-typed accessors.
src/Automation/Automation/Model/RuntimeEnvironmentPackage.cs	Introduces the client-side model returned by Runtime Environment Package cmdlets.
src/Automation/Automation/Model/RuntimeEnvironment.cs	Introduces the client-side model returned by Runtime Environment cmdlets.
src/Automation/Automation/help/Set-AzAutomationRuntimeEnvironmentPackage.md	Adds reference help for Set-AzAutomationRuntimeEnvironmentPackage.
src/Automation/Automation/help/Set-AzAutomationRuntimeEnvironment.md	Adds reference help for Set-AzAutomationRuntimeEnvironment.
src/Automation/Automation/help/Remove-AzAutomationRuntimeEnvironmentPackage.md	Adds reference help for Remove-AzAutomationRuntimeEnvironmentPackage.
src/Automation/Automation/help/Remove-AzAutomationRuntimeEnvironment.md	Adds reference help for Remove-AzAutomationRuntimeEnvironment.
src/Automation/Automation/help/New-AzAutomationRuntimeEnvironmentPackage.md	Adds reference help for New-AzAutomationRuntimeEnvironmentPackage.
src/Automation/Automation/help/New-AzAutomationRuntimeEnvironment.md	Adds reference help for New-AzAutomationRuntimeEnvironment.
src/Automation/Automation/help/Get-AzAutomationRuntimeEnvironmentPackage.md	Adds reference help for Get-AzAutomationRuntimeEnvironmentPackage.
src/Automation/Automation/help/Get-AzAutomationRuntimeEnvironment.md	Adds reference help for Get-AzAutomationRuntimeEnvironment.
src/Automation/Automation/Common/IAutomationPSClient.cs	Adds new client interface methods for Runtime Environments and Packages.
src/Automation/Automation/Common/AutomationPSClient.cs	Implements Runtime Environment and Package operations and error mapping.
src/Automation/Automation/Cmdlet/SetAzureAutomationRuntimeEnvironmentPackage.cs	Adds Set-AzAutomationRuntimeEnvironmentPackage cmdlet implementation.
src/Automation/Automation/Cmdlet/SetAzureAutomationRuntimeEnvironment.cs	Adds Set-AzAutomationRuntimeEnvironment cmdlet implementation.
src/Automation/Automation/Cmdlet/RemoveAzureAutomationRuntimeEnvironmentPackage.cs	Adds Remove-AzAutomationRuntimeEnvironmentPackage cmdlet implementation.
src/Automation/Automation/Cmdlet/RemoveAzureAutomationRuntimeEnvironment.cs	Adds Remove-AzAutomationRuntimeEnvironment cmdlet implementation.
src/Automation/Automation/Cmdlet/NewAzureAutomationRuntimeEnvironmentPackage.cs	Adds New-AzAutomationRuntimeEnvironmentPackage cmdlet implementation.
src/Automation/Automation/Cmdlet/NewAzureAutomationRuntimeEnvironment.cs	Adds New-AzAutomationRuntimeEnvironment cmdlet implementation.
src/Automation/Automation/Cmdlet/GetAzureAutomationRuntimeEnvironmentPackage.cs	Adds Get-AzAutomationRuntimeEnvironmentPackage cmdlet implementation.
src/Automation/Automation/Cmdlet/GetAzureAutomationRuntimeEnvironment.cs	Adds Get-AzAutomationRuntimeEnvironment cmdlet implementation.
src/Automation/Automation/ChangeLog.md	Documents the new cmdlets under Upcoming Release.
src/Automation/Automation/Az.Automation.psd1	Exports the newly added cmdlets from the module manifest.
src/Automation/Automation.Test/UnitTests/SetAzureAutomationRuntimeEnvironmentTest.cs	Adds unit tests for Set-AzAutomationRuntimeEnvironment.
src/Automation/Automation.Test/UnitTests/RemoveAzureAutomationRuntimeEnvironmentTest.cs	Adds unit tests for Remove-AzAutomationRuntimeEnvironment.
src/Automation/Automation.Test/UnitTests/NewAzureAutomationRuntimeEnvironmentTest.cs	Adds unit tests for New-AzAutomationRuntimeEnvironment.
src/Automation/Automation.Test/UnitTests/GetAzureAutomationRuntimeEnvironmentTest.cs	Adds unit tests for Get-AzAutomationRuntimeEnvironment.
src/Automation/Automation.Management.Sdk/Generated/RuntimeEnvironmentOperationsExtensions.cs	Adds generated extension methods for RuntimeEnvironment operations.
src/Automation/Automation.Management.Sdk/Generated/RuntimeEnvironmentOperations.cs	Adds generated RuntimeEnvironment operations implementation.
src/Automation/Automation.Management.Sdk/Generated/PackageOperationsExtensions.cs	Adds generated extension methods for Package operations.
src/Automation/Automation.Management.Sdk/Generated/Models/RuntimeEnvironmentUpdateParameters.cs	Adds generated model for Runtime Environment update parameters.
src/Automation/Automation.Management.Sdk/Generated/Models/RuntimeEnvironmentRuntime.cs	Adds generated model describing Runtime properties (language/version).
src/Automation/Automation.Management.Sdk/Generated/Models/RuntimeEnvironmentCreateOrUpdateParameters.cs	Adds generated model for Runtime Environment create/update parameters.
src/Automation/Automation.Management.Sdk/Generated/Models/RuntimeEnvironment.cs	Adds generated model for Runtime Environment resource shape.
src/Automation/Automation.Management.Sdk/Generated/Models/PackageUpdateParameters.cs	Adds generated model for Package update parameters.
src/Automation/Automation.Management.Sdk/Generated/Models/PackageCreateOrUpdateParameters.cs	Adds generated model for Package create/update parameters.
src/Automation/Automation.Management.Sdk/Generated/Models/Package.cs	Adds generated model for Runtime Environment Package resource shape.
src/Automation/Automation.Management.Sdk/Generated/IRuntimeEnvironmentOperations.cs	Adds generated interface for RuntimeEnvironment operations.
src/Automation/Automation.Management.Sdk/Generated/IPackageOperations.cs	Adds generated interface for Package operations.
src/Automation/Automation.Management.Sdk/Generated/IAutomationClient.cs	Extends client interface to expose RuntimeEnvironment/Package operations.
src/Automation/Automation.Management.Sdk/Generated/AutomationClient.cs	Wires RuntimeEnvironment/Package operations into the generated client.

Files not reviewed (1)

src/Automation/Automation/Properties/Resources.Designer.cs: Generated file

kaarthik2103 · 2026-07-21T09:51:44Z

@microsoft-github-policy-service agree company="Microsoft"

Copilot

Pull request overview

Copilot reviewed 31 out of 47 changed files in this pull request and generated 1 comment.

Files not reviewed (1)

src/Automation/Automation/Properties/Resources.Designer.cs: Generated file

Comments suppressed due to low confidence (1)

src/Automation/Automation/Cmdlet/NewAzureAutomationRuntimeEnvironment.cs:95

-Location is declared optional (and help says it defaults to the Automation Account location), but the cmdlet forwards Location directly into CreateRuntimeEnvironment. The underlying RuntimeEnvironmentCreateOrUpdateParameters.Validate() requires Location to be non-null, so omitting -Location will throw before the request is sent.

                this.Name,
                this.Location,
                this.Language,

a0x1ab · 2026-07-22T11:31:45Z

/azp run

azure-pipelines · 2026-07-22T11:32:02Z

Azure Pipelines: Successfully started running 3 pipeline(s).

a0x1ab · 2026-07-24T10:24:23Z

/azp run

azure-pipelines · 2026-07-24T10:24:39Z

Azure Pipelines: Successfully started running 3 pipeline(s).

Copilot

Pull request overview

Copilot reviewed 31 out of 47 changed files in this pull request and generated 5 comments.

Files not reviewed (1)

src/Automation/Automation/Properties/Resources.Designer.cs: Generated file

a0x1ab · 2026-07-24T11:28:22Z

/azp run

azure-pipelines · 2026-07-24T11:28:39Z

Azure Pipelines: Successfully started running 3 pipeline(s).

Copilot

Pull request overview

Copilot reviewed 31 out of 47 changed files in this pull request and generated 5 comments.

Files not reviewed (1)

src/Automation/Automation/Properties/Resources.Designer.cs: Generated file

Comments suppressed due to low confidence (3)

src/Automation/Automation/Cmdlet/NewAzureAutomationRuntimeEnvironment.cs:125

-Location is documented as optional (and the help states it is inherited from the Automation Account), but the cmdlet passes Location through as-is. The SDK create parameters validate Location as non-null, so omitting -Location will throw before the request is sent. Resolve an effective location (for example, by reading the parent Automation Account location) when Location is not provided.

            if (ShouldProcess(this.Name, "Create Runtime Environment"))
            {
                var createdRuntimeEnvironment = this.AutomationClient.CreateRuntimeEnvironment(
                    this.ResourceGroupName,
                    this.AutomationAccountName,
                    this.Name,
                    this.Location,
                    this.Language,
                    this.Version,
                    defaultPackagesDict,
                    this.Description,
                    tagsDict);

src/Automation/Automation/help/New-AzAutomationRuntimeEnvironment.md:111

The cmdlet supports a -Tag parameter, but there is no parameter documentation section for it. Add a "### -Tag" section (including type/Required/Position metadata) so users can discover and correctly use tagging support.
src/Automation/Automation/help/Set-AzAutomationRuntimeEnvironment.md:112
The cmdlet supports a -Tag parameter, but there is no parameter documentation section for it. Add a "### -Tag" section (including type/Required/Position metadata) so users can discover and correctly use tagging support.

a0x1ab · 2026-07-24T11:56:01Z

/azp run

a0x1ab · 2026-07-27T12:42:24Z

/azp run

azure-pipelines · 2026-07-27T12:42:40Z

Azure Pipelines: Successfully started running 3 pipeline(s).

Copilot

Copilot wasn't able to review this pull request because it exceeds the maximum number of files (300). Try reducing the number of changed files and requesting a review from Copilot again.

a0x1ab · 2026-07-27T12:49:25Z

/azp run

azure-pipelines · 2026-07-27T12:49:42Z

Azure Pipelines: Successfully started running 3 pipeline(s).

Copilot

Copilot wasn't able to review any files in this pull request.

a0x1ab · 2026-07-27T14:14:57Z

/azp run

azure-pipelines · 2026-07-27T14:15:14Z

Azure Pipelines: Successfully started running 3 pipeline(s).

Copilot

Pull request overview

Copilot reviewed 31 out of 47 changed files in this pull request and generated 1 comment.

Files not reviewed (1)

src/Automation/Automation/Properties/Resources.Designer.cs: Generated file

+            var parameters = new AutomationManagement.Models.RuntimeEnvironmentCreateOrUpdateParameters(
+                location: location,
+                runtime: new AutomationManagement.Models.RuntimeEnvironmentRuntime(language: language, version: version),
+                tags: tags,
+                defaultPackages: defaultPackages,
+                description: description
+            );


a0x1ab · 2026-07-27T15:22:36Z

/azp run

azure-pipelines · 2026-07-27T15:22:53Z

Azure Pipelines: Successfully started running 3 pipeline(s).

Copilot

Pull request overview

Copilot reviewed 31 out of 32 changed files in this pull request and generated 1 comment.

Files not reviewed (1)

src/Automation/Automation/Properties/Resources.Designer.cs: Generated file

Comments suppressed due to low confidence (1)

src/Automation/Automation/Cmdlet/NewAzureAutomationRuntimeEnvironmentPackage.cs:71

The package name validation rejects dots ('.'), but the newly added help uses a package name like "Az.Accounts". Either the validation is too strict (preventing common PowerShell module names) or the documentation is incorrect. If dots are intended to be supported, expand the regex and error text accordingly so users can create packages like 'Az.Accounts'.

            // Validate name format
            if (!Regex.IsMatch(this.Name, "^[a-zA-Z][a-zA-Z0-9_-]{0,62}$"))
            {
                throw new PSArgumentException(
                    "The name can contain only letters, numbers, underscores and dashes. The name must begin with a letter. The name must be less than 64 characters.",
                    nameof(Name));

 ## Upcoming Release
 * Updated Automation account identity handling to explicitly use the Automation SDK `Identity` model in create/update flows.
+* Added cmdlets for Runtime Environment management
+  * `Get-AzAutomationRuntimeEnvironment`
+  * `New-AzAutomationRuntimeEnvironment`
+  * `Set-AzAutomationRuntimeEnvironment`
+  * `Remove-AzAutomationRuntimeEnvironment`
+* Added cmdlets for Runtime Environment Package management
+  * `Get-AzAutomationRuntimeEnvironmentPackage`
+  * `New-AzAutomationRuntimeEnvironmentPackage`
+  * `Set-AzAutomationRuntimeEnvironmentPackage`
+  * `Remove-AzAutomationRuntimeEnvironmentPackage`


Copilot

Copilot wasn't able to review this pull request because it exceeds the maximum number of files (300). Try reducing the number of changed files and requesting a review from Copilot again.

a0x1ab · 2026-07-28T06:40:15Z

/azp run

azure-pipelines · 2026-07-28T06:40:32Z

Azure Pipelines: Successfully started running 3 pipeline(s).

Copilot

Copilot wasn't able to review any files in this pull request.

a0x1ab · 2026-07-28T07:20:32Z

/azp run

azure-pipelines · 2026-07-28T07:20:48Z

Azure Pipelines: Successfully started running 3 pipeline(s).

kaarthik2103 added 2 commits July 7, 2026 20:06

Added Runtime Environment cmdlets for Azure Automation

5d76df9

Adding functionality, cmdlets for adding packages with runtime env(ARE)

5d44f63

Copilot AI review requested due to automatic review settings July 21, 2026 09:43

Copilot started reviewing on behalf of kaarthik2103 July 21, 2026 09:43 View session

Copilot AI reviewed Jul 21, 2026

View reviewed changes

Resolving comments suggested by copilot

b48fce0

Copilot AI review requested due to automatic review settings July 21, 2026 10:48

Copilot started reviewing on behalf of kaarthik2103 July 21, 2026 10:49 View session

Copilot AI reviewed Jul 21, 2026

View reviewed changes

Comment thread src/Automation/Automation/Common/AutomationPSClient.cs Outdated

Adding tags, regex for naming convention

c882252

Copilot AI review requested due to automatic review settings July 24, 2026 10:23

Copilot started reviewing on behalf of kaarthik2103 July 24, 2026 10:23 View session

Copilot AI reviewed Jul 24, 2026

View reviewed changes

Resolving copilot comments

f48f804

Copilot AI review requested due to automatic review settings July 24, 2026 11:27

Copilot started reviewing on behalf of kaarthik2103 July 24, 2026 11:28 View session

Copilot AI reviewed Jul 24, 2026

View reviewed changes

Resolve comments on Tags and contentUri

5f2fa10

Copilot AI review requested due to automatic review settings July 24, 2026 11:53

Copilot started reviewing on behalf of kaarthik2103 July 24, 2026 11:53 View session

Copilot started reviewing on behalf of kaarthik2103 July 27, 2026 12:40 View session

Copilot AI reviewed Jul 27, 2026

Copilot AI review requested due to automatic review settings July 27, 2026 14:09

Copilot AI reviewed Jul 27, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings July 27, 2026 14:42

kaarthik2103 force-pushed the aa/runtime-env-cmdlets branch from 11de74f to 5f2fa10 Compare July 27, 2026 14:42

Copilot started reviewing on behalf of kaarthik2103 July 27, 2026 14:43 View session

Copilot AI reviewed Jul 27, 2026

View reviewed changes

Revert manual Automation SDK generated changes

a8589dd

Copilot AI review requested due to automatic review settings July 27, 2026 15:21

Copilot started reviewing on behalf of kaarthik2103 July 27, 2026 15:22 View session

Copilot AI reviewed Jul 27, 2026

View reviewed changes

New generated SDK files from 2024-10-23

eca6168

Copilot AI review requested due to automatic review settings July 28, 2026 06:38

Copilot AI reviewed Jul 28, 2026

Generating with only 2024-10-23 to remove duplicates

bf0f28c

Copilot AI review requested due to automatic review settings July 28, 2026 07:16

Copilot AI reviewed Jul 28, 2026

View reviewed changes

Uh oh!

Conversation

kaarthik2103 commented Jul 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Cmdlets functionality:

Local testing document:

Mandatory Checklist

Uh oh!

azure-pipelines Bot commented Jul 21, 2026

Uh oh!

kaarthik2103 commented Jul 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kaarthik2103 commented Jul 21, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

a0x1ab commented Jul 22, 2026

Uh oh!

azure-pipelines Bot commented Jul 22, 2026

Uh oh!

a0x1ab commented Jul 24, 2026

Uh oh!

azure-pipelines Bot commented Jul 24, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

a0x1ab commented Jul 24, 2026

Uh oh!

azure-pipelines Bot commented Jul 24, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

a0x1ab commented Jul 24, 2026

Uh oh!

a0x1ab commented Jul 27, 2026

Uh oh!

azure-pipelines Bot commented Jul 27, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

a0x1ab commented Jul 27, 2026

Uh oh!

azure-pipelines Bot commented Jul 27, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

a0x1ab commented Jul 27, 2026

Uh oh!

azure-pipelines Bot commented Jul 27, 2026

kaarthik2103 commented Jul 21, 2026 •

edited

Loading

kaarthik2103 commented Jul 21, 2026 •

edited

Loading