az automation hrwg

Note

This reference is part of the automation extension for the Azure CLI (version 2.39.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

az automation hrwg create

Create a hybrid runbook worker group.

az automation hrwg delete

Delete a hybrid runbook worker group.

az automation hrwg hrw

Automation Hybrid Runbook Worker.

az automation hrwg hrw create

Create a hybrid runbook worker.

az automation hrwg hrw delete

Delete a hybrid runbook worker.

az automation hrwg hrw list

Retrieve a list of hybrid runbook workers.

az automation hrwg hrw move

Move a hybrid worker to a different group.

az automation hrwg hrw show

Retrieve a hybrid runbook worker.

az automation hrwg hrw update

Create a hybrid runbook worker.

az automation hrwg list

Retrieve a list of hybrid runbook worker groups.

az automation hrwg show

Retrieve a hybrid runbook worker group.

az automation hrwg update

Create a hybrid runbook worker group.

az automation hrwg create

Create a hybrid runbook worker group.

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

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

--credential

Set the credential of a worker group. Shorthand syntax supported. Try ?? to show more.

az automation hrwg delete

Delete a hybrid runbook worker group.

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

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

--yes -y

Do not prompt for confirmation.

az automation hrwg list

Retrieve a list of hybrid runbook worker groups.

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

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

--filter

The filter to apply on the operation.

az automation hrwg show

Retrieve a hybrid runbook worker group.

az automation hrwg show --automation-account-name
                        --hybrid-runbook-worker-group-name
                        --resource-group

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

az automation hrwg update

Create a hybrid runbook worker group.

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

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

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

--credential

Sets the credential of a worker group. Shorthand syntax supported. Try ?? to show more.

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

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

--set

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