แชร์ผ่าน

az automation runtime-environment

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 --automation-account-name
                                         --name --runtime-environment-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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--default-packages

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

Property Value
Parameter group: Properties Arguments
--description

Gets or sets the description.

Property Value
Parameter group: Properties Arguments
--language

Language of Runtime Environment.

Property Value
Parameter group: Runtime Arguments
--location -l

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

Property Value
Parameter group: Parameters Arguments
--tags

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

Property Value
Parameter group: Parameters Arguments
--version

Version of Language.

Property Value
Parameter group: Runtime Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az automation runtime-environment delete

Delete the Runtime Environment.

az automation runtime-environment delete [--account --automation-account-name]
                                         [--ids]
                                         [--name --runtime-environment-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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account --automation-account-name

The name of the automation account.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--name --runtime-environment-name -n

The name of the Runtime Environment.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False

az automation runtime-environment list

List a list of RuntimeEnvironments.

az automation runtime-environment list --account --automation-account-name
                                       --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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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.

Property Value
Parameter group: Pagination Arguments
--next-token

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

Property Value
Parameter group: Pagination Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az automation runtime-environment show

Get information about the Runtime Environment.

az automation runtime-environment show [--account --automation-account-name]
                                       [--ids]
                                       [--name --runtime-environment-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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account --automation-account-name

The name of the automation account.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--name --runtime-environment-name -n

The name of the Runtime Environment.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False

az automation runtime-environment update

Update Runtime Environment.

az automation runtime-environment update [--account --automation-account-name]
                                         [--add]
                                         [--default-packages]
                                         [--description]
                                         [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--ids]
                                         [--language]
                                         [--name --runtime-environment-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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account --automation-account-name

The name of the automation account.

Property Value
Parameter group: Resource Id Arguments
--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>.

Property Value
Parameter group: Generic Update Arguments
--default-packages

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

Property Value
Parameter group: Properties Arguments
--description

Gets or sets the description.

Property Value
Parameter group: Properties Arguments
--force-string

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

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

Property Value
Parameter group: Resource Id Arguments
--language

Language of Runtime Environment.

Property Value
Parameter group: Runtime Arguments
--name --runtime-environment-name -n

The name of the Runtime Environment.

Property Value
Parameter group: Resource Id Arguments
--remove

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

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--set

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

Property Value
Parameter group: Generic Update Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--tags

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

Property Value
Parameter group: Parameters Arguments
--version

Version of Language.

Property Value
Parameter group: Runtime Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False