az automation hrwg

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

Automation Hybrid Runbook Worker Group.

Commands

Name	Description	Type	Status
az automation hrwg create	Create a hybrid runbook worker group.	Extension	GA
az automation hrwg delete	Delete a hybrid runbook worker group.	Extension	GA
az automation hrwg hrw	Manage Automation Hybrid Runbook Worker.	Extension	GA
az automation hrwg hrw create	Create a hybrid runbook worker.	Extension	GA
az automation hrwg hrw delete	Delete a hybrid runbook worker.	Extension	GA
az automation hrwg hrw list	List a list of hybrid runbook workers.	Extension	GA
az automation hrwg hrw move	Move a hybrid worker to a different group.	Extension	GA
az automation hrwg hrw show	Get a hybrid runbook worker.	Extension	GA
az automation hrwg list	List all hybrid runbook worker groups.	Extension	GA
az automation hrwg show	Get hybrid worker group.	Extension	GA
az automation hrwg update	Update a hybrid runbook worker group.	Extension	GA

az automation hrwg create

Create a hybrid runbook worker group.

az automation hrwg create --automation-account-name
                          --hybrid-runbook-worker-group-name --name
                          --resource-group
                          [--credential]

Examples

Create a hybrid runbook worker group

az automation hrwg create --automation-account-name accountName --resource-group groupName --name hybridrunbookworkergroupName

Required Parameters

--automation-account-name

The name of the automation account.

--hybrid-runbook-worker-group-name --name -n

The hybrid runbook worker group name.

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

--credential

Sets the credential of a worker group. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties 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 hrwg delete

Delete a hybrid runbook worker group.

az automation hrwg delete [--automation-account-name]
                          [--hybrid-runbook-worker-group-name --name]
                          [--ids]
                          [--resource-group]
                          [--subscription]
                          [--yes]

Examples

Delete hybrid worker group

az automation hrwg delete --automation-account-name accountName --resource-group groupName --name hybridrunbookworkergroupName

Optional Parameters

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

--automation-account-name

The name of the automation account.

Property	Value
Parameter group:	Resource Id Arguments

--hybrid-runbook-worker-group-name --name -n

The hybrid runbook worker group name.

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

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

List all hybrid runbook worker groups.

az automation hrwg list --automation-account-name
                        --resource-group
                        [--filter]

Examples

List all hybrid runbook worker groups

az automation hrwg list --automation-account-name accountName --resource-group groupName

Required Parameters

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

--filter

The filter to apply on the operation.

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

Get hybrid worker group.

az automation hrwg show [--automation-account-name]
                        [--hybrid-runbook-worker-group-name --name]
                        [--ids]
                        [--resource-group]
                        [--subscription]

Examples

Get hybrid worker group

az automation hrwg show --automation-account-name accountName --resource-group groupName --name hybridrunbookworkergroupName

Optional Parameters

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

--automation-account-name

The name of the automation account.

Property	Value
Parameter group:	Resource Id Arguments

--hybrid-runbook-worker-group-name --name -n

The hybrid runbook worker group name.

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

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

Update a hybrid runbook worker group.

az automation hrwg update [--add]
                          [--automation-account-name]
                          [--credential]
                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                          [--hybrid-runbook-worker-group-name --name]
                          [--ids]
                          [--remove]
                          [--resource-group]
                          [--set]
                          [--subscription]

Examples

Update hybrid worker group

az automation hrwg update --automation-account-name accountName --resource-group groupName --name hybridrunbookworkergroupName --credential "{name: credentialname}"

Optional Parameters

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

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

--automation-account-name

The name of the automation account.

Property	Value
Parameter group:	Resource Id Arguments

--credential

Sets the credential of a worker group. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--hybrid-runbook-worker-group-name --name -n

The hybrid runbook worker group name.

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

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

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