az automation runtime-environment package
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 --automation-account-name
--environment --runtime-environment-name
--name --package-name
--resource-group
[--all-of]
[--content-hash]
[--content-uri --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
The name of the automation account.
The name of the Runtime Environment.
The name of Package.
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.
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.
| Property | Value |
|---|---|
| Parameter group: | Parameters Arguments |
Gets or sets the hash of content. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | ContentLink Arguments |
Gets or sets the uri of content.
| Property | Value |
|---|---|
| Parameter group: | ContentLink Arguments |
Gets or sets the version of the content.
| Property | Value |
|---|---|
| Parameter group: | ContentLink Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az automation runtime-environment package delete
Delete the package by name.
az automation runtime-environment package delete [--account --automation-account-name]
[--environment --runtime-environment-name]
[--ids]
[--name --package-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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name of the automation account.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
The name of the Runtime Environment.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
The Package name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
Do not prompt for confirmation.
| Property | Value |
|---|---|
| Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az automation runtime-environment package list
List the a list of Packages.
az automation runtime-environment package list --account --automation-account-name
--environment --runtime-environment-name
--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
The name of the automation account.
The name of the Runtime Environment.
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.
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 |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az automation runtime-environment package show
Get the Package identified by Package name.
az automation runtime-environment package show [--account --automation-account-name]
[--environment --runtime-environment-name]
[--ids]
[--name --package-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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name of the automation account.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
The name of the Runtime Environment.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
The Package name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az automation runtime-environment package update
Update the package identified by package name.
az automation runtime-environment package update [--account --automation-account-name]
[--add]
[--all-of]
[--content-hash]
[--content-uri --uri]
[--content-version]
[--environment --runtime-environment-name]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name --package-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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name of the automation account.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
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.
| Property | Value |
|---|---|
| Parameter group: | Parameters Arguments |
Gets or sets the hash of content. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | ContentLink Arguments |
Gets or sets the uri of content.
| Property | Value |
|---|---|
| Parameter group: | ContentLink Arguments |
Gets or sets the version of the content.
| Property | Value |
|---|---|
| Parameter group: | ContentLink Arguments |
The name of the Runtime Environment.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
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 |
The Package name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.
| Property | Value |
|---|---|
| Parameter group: | Generic Update Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.
| Property | Value |
|---|---|
| Parameter group: | Generic Update Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |