Share via

az automation runtime-environment package

  • 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 package command. Learn more about extensions.

Manage Package for Runtime Environment.

Commands

Name Description Type Status
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 package create

Create the package identified by package name.

az automation runtime-environment package create --account
                                                 --environment
                                                 --name
                                                 --resource-group
                                                 [--all-of]
                                                 [--content-hash]
                                                 [--content-uri]
                                                 [--content-version]

Examples

Create Runtime Environment Package

az automation runtime-environment package create -g rg--automation-account-name myAutomationAccount --runtime-environment-name rt --name rt-package --uri https://teststorage.blob.core.windows.net/mycontainer/MyModule.zip --content-version 1.0.0.0

Required Parameters

--account --automation-account-name

The name of the automation account.

--environment --runtime-environment-name

The name of the Runtime Environment.

--name --package-name -n

The name of Package.

--resource-group -g

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

Optional Parameters

--all-of

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--content-hash

Gets or sets the hash of content. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--content-uri --uri

Gets or sets the uri of content.

--content-version

Gets or sets the version of the content.

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 package delete

Delete the package by name.

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

Examples

Delete the package

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

Optional Parameters

--account --automation-account-name

The name of the automation account.

--environment --runtime-environment-name

The name of the Runtime Environment.

--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 --package-name -n

The Package name.

--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 package list

List the a list of Packages.

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

Examples

List packages in Runtime Environment

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

Required Parameters

--account --automation-account-name

The name of the automation account.

--environment --runtime-environment-name

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

--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 package show

Get the Package identified by Package name.

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

Examples

Get the information about the package

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

Optional Parameters

--account --automation-account-name

The name of the automation account.

--environment --runtime-environment-name

The name of the Runtime Environment.

--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 --package-name -n

The Package name.

--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 package update

Update the package identified by package name.

az automation runtime-environment package update [--account]
                                                 [--add]
                                                 [--all-of]
                                                 [--content-hash]
                                                 [--content-uri]
                                                 [--content-version]
                                                 [--environment]
                                                 [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--ids]
                                                 [--name]
                                                 [--remove]
                                                 [--resource-group]
                                                 [--set]
                                                 [--subscription]

Examples

Update the package

az automation runtime-environment package update -g rg --automation-account-name myAutomationAccount --runtime-environment-name rt --name rt-package --uri https://teststorage.blob.core.windows.net/mycontainer/MyModule.zip --content-version 1.0.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>.

--all-of

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--content-hash

Gets or sets the hash of content. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--content-uri --uri

Gets or sets the uri of content.

--content-version

Gets or sets the version of the content.

--environment --runtime-environment-name

The name of the Runtime Environment.

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

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 --package-name -n

The Package name.

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

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.