az automation runtime-environment

Reference

Note

This reference is part of the automation extension for the Azure CLI (version 2.55.0 or higher). The extension will automatically install the first time you run an az automation runtime-environment command. Learn more about extensions.

Manage RuntimeEnvironment.

Commands

Name	Description	Type	Status
az automation runtime-environment create	Create Runtime Environment.	Extension	GA
az automation runtime-environment delete	Delete the Runtime Environment.	Extension	GA
az automation runtime-environment list	List a list of RuntimeEnvironments.	Extension	GA
az automation runtime-environment package	Manage Package for Runtime Environment.	Extension	GA
az automation runtime-environment package create	Create the package identified by package name.	Extension	GA
az automation runtime-environment package delete	Delete the package by name.	Extension	GA
az automation runtime-environment package list	List the a list of Packages.	Extension	GA
az automation runtime-environment package show	Get the Package identified by Package name.	Extension	GA
az automation runtime-environment package update	Update the package identified by package name.	Extension	GA
az automation runtime-environment show	Get information about the Runtime Environment.	Extension	GA
az automation runtime-environment update	Update Runtime Environment.	Extension	GA

az automation runtime-environment create

Create Runtime Environment.

az automation runtime-environment create --account
                                         --name
                                         --resource-group
                                         [--default-packages]
                                         [--description]
                                         [--language]
                                         [--location]
                                         [--tags]
                                         [--version]

Examples

Create Runtime Environment

az automation runtime-environment create -g rg --automation-account-name myAutomationAccount --name rt --location westus2 --language PowerShell --version 7.1 --default-packages "{Az:7.3.2}"

Required Parameters

--account --automation-account-name

The name of the automation account.

--name --runtime-environment-name -n

The name of the Runtime Environment.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--default-packages

List of Default packages for Environment Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--description

Gets or sets the description.

--language

Language of Runtime Environment.

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--version

Version of Language.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az automation runtime-environment delete

Delete the Runtime Environment.

az automation runtime-environment delete [--account]
                                         [--ids]
                                         [--name]
                                         [--resource-group]
                                         [--subscription]
                                         [--yes]

Examples

Delete the Runtime Environment

az automation runtime-environment delete -g rg --automation-account-name myAutomationAccount --name rt -y

Optional Parameters

--account --automation-account-name

The name of the automation account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --runtime-environment-name -n

The name of the Runtime Environment.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az automation runtime-environment list

List a list of RuntimeEnvironments.

az automation runtime-environment list --account
                                       --resource-group
                                       [--max-items]
                                       [--next-token]

Examples

List Runtime Environments

az automation runtime-environment list -g rg --automation-account-name myAutomationAccount

Required Parameters

--account --automation-account-name

The name of the automation account.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az automation runtime-environment show

Get information about the Runtime Environment.

az automation runtime-environment show [--account]
                                       [--ids]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]

Examples

Get information about the Runtime Environment

az automation runtime-environment show -g rg --automation-account-name myAutomationAccount --name rt

Optional Parameters

--account --automation-account-name

The name of the automation account.

--ids

--name --runtime-environment-name -n

The name of the Runtime Environment.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az automation runtime-environment update

Update Runtime Environment.

az automation runtime-environment update [--account]
                                         [--add]
                                         [--default-packages]
                                         [--description]
                                         [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--ids]
                                         [--language]
                                         [--name]
                                         [--remove]
                                         [--resource-group]
                                         [--set]
                                         [--subscription]
                                         [--tags]
                                         [--version]

Examples

Update Runtime Environment

az automation runtime-environment update -g rg --automation-account-name myAutomationAccount --name rt --default-packages "{Az:8.0.0}"

Optional Parameters

--account --automation-account-name

The name of the automation account.

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--default-packages

List of Default packages for Environment Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--description

Gets or sets the description.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--ids

--language

Language of Runtime Environment.

--name --runtime-environment-name -n

The name of the Runtime Environment.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--version

Version of Language.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Share via

az automation runtime-environment

Commands

az automation runtime-environment create

Examples

Required Parameters

Optional Parameters

az automation runtime-environment delete

Examples

Optional Parameters

az automation runtime-environment list

Examples

Required Parameters

Optional Parameters

az automation runtime-environment show

Examples

Optional Parameters

az automation runtime-environment update

Examples

Optional Parameters

Additional resources