Share via

az automation account

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

This command group is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Automation Account.

Commands

Name Description Type Status
az automation account create

Create automation account.

 Extension Experimental
az automation account delete

Delete an automation account.

 Extension Experimental
az automation account list

Retrieve a list of accounts within a given resource group. And Retrieve a list of accounts within a given subscription.

 Extension Experimental
az automation account list-keys

Retrieve the automation keys for an account.

 Extension Experimental
az automation account show

Get information about an Automation Account.

 Extension Experimental
az automation account show-linked-workspace

Get the linked workspace for the account id.

 Extension Experimental
az automation account update

Update an automation account.

 Extension Experimental

az automation account create

Experimental

Command group 'automation account' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create automation account.

az automation account create --automation-account-name
                             --resource-group
                             [--location]
                             [--sku {Basic, Free}]
                             [--tags]

Examples

Create an automation account

az automation account create --automation-account-name "myAutomationAccount" --location "East US 2"                --sku "Free" --resource-group "rg"

Required Parameters

--automation-account-name --name -n

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

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--sku

Account SKU.

Accepted values: Basic, Free
Default value: Basic
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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

Experimental

Command group 'automation account' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete an automation account.

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

Examples

Delete automation account

az automation account delete --name "myAutomationAccount" --resource-group "rg"

Optional Parameters

--automation-account-name --name -n

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.

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

Experimental

Command group 'automation account' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Retrieve a list of accounts within a given resource group. And Retrieve a list of accounts within a given subscription.

az automation account list [--resource-group]

Examples

List automation accounts by resource group

az automation account list --resource-group "rg"

List automation accounts by resource group

az automation account list

Optional Parameters

--resource-group -g

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

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 account list-keys

Experimental

Command group 'automation account' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Retrieve the automation keys for an account.

az automation account list-keys [--automation-account-name]
                                [--ids]
                                [--resource-group]
                                [--subscription]

Examples

Retrieve the automation keys

az automation account list-keys --resource-group myResouceGroup --name myAutomationAccount

Optional Parameters

--automation-account-name --name -n

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.

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

Experimental

Command group 'automation account' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get information about an Automation Account.

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

Examples

Get automation account

az automation account show --name "myAutomationAccount" --resource-group "rg"

Optional Parameters

--automation-account-name --name -n

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.

--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 account show-linked-workspace

Experimental

Command group 'automation account' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the linked workspace for the account id.

az automation account show-linked-workspace [--automation-account-name]
                                            [--ids]
                                            [--resource-group]
                                            [--subscription]

Examples

Get the linked workspace id

az automation account show-linked-workspace --resource-group myResourceGroup --name myAutomationAccount

Optional Parameters

--automation-account-name --name -n

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.

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

Experimental

Command group 'automation account' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update an automation account.

az automation account update [--automation-account-name]
                             [--ids]
                             [--resource-group]
                             [--sku {Basic, Free}]
                             [--subscription]
                             [--tags]

Examples

Update an automation account

az automation account update --automation-account-name "myAutomationAccount" --tags KEY=VALUE                --resource-group "rg"

Optional Parameters

--automation-account-name --name -n

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.

--resource-group -g

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

--sku

Account SKU.

Accepted values: Basic, Free
--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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.