az automation hrwg hrw

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

Manage Automation Hybrid Runbook Worker.

Commands

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

Create a hybrid runbook worker.

az automation hrwg hrw create --automation-account-name
                              --hybrid-runbook-worker-group-name
                              --hybrid-runbook-worker-id
                              --resource-group
                              [--vm-resource-id]

Examples

Create a hybrid runbook worker

az automation hrwg hrw create --automation-account-name accountName --resource-group groupName --hybrid-runbook-worker-group-name hybridRunbookWorkerGroupName --hybrid-runbook-worker-id hybridRunbookWorkerId --vm-resource-id vmResourceId

Required Parameters

--automation-account-name

The name of the automation account.

--hybrid-runbook-worker-group-name

The hybrid runbook worker group name.

--hybrid-runbook-worker-id --name -n

The hybrid runbook worker id.

--resource-group -g

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

Optional Parameters

--vm-resource-id

Azure Resource Manager Id for a virtual machine.

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 hrwg hrw delete

Delete a hybrid runbook worker.

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

Examples

Delete a hybrid worker

az automation hrwg hrw delete --automation-account-name accountName --resource-group groupName --hybrid-runbook-worker-group-name hybridRunbookWorkerGroupName --hybrid-runbook-worker-id hybridRunbookWorkerId

Optional Parameters

--automation-account-name

The name of the automation account.

--hybrid-runbook-worker-group-name

The hybrid runbook worker group name.

--hybrid-runbook-worker-id --name -n

The hybrid runbook worker id.

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

List a list of hybrid runbook workers.

az automation hrwg hrw list --automation-account-name
                            --hybrid-runbook-worker-group-name
                            --resource-group
                            [--filter]

Examples

List all hybrid runbook workers in a worker group

az automation hrwg hrw list --automation-account-name accountName --resource-group groupName --hybrid-runbook-worker-group-name hybridRunbookWorkerGroupName

Required Parameters

--automation-account-name

The name of the automation account.

--hybrid-runbook-worker-group-name

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

--filter

The filter to apply on the operation.

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 hrwg hrw move

Move a hybrid worker to a different group.

az automation hrwg hrw move [--automation-account-name]
                            [--hybrid-runbook-worker-group-name]
                            [--hybrid-runbook-worker-id]
                            [--ids]
                            [--resource-group]
                            [--subscription]
                            [--target-hybrid-runbook-worker-group-name]

Optional Parameters

--automation-account-name

The name of the automation account.

--hybrid-runbook-worker-group-name

The hybrid runbook worker group name.

--hybrid-runbook-worker-id --name -n

The hybrid runbook worker id.

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

--target-hybrid-runbook-worker-group-name

Gets or sets the target hybrid runbook worker group.

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

Get a hybrid runbook worker.

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

Examples

Get hybrid runbook worker

az automation hrwg hrw show --automation-account-name accountName --resource-group groupName --hybrid-runbook-worker-group-name hybridRunbookWorkerGroupName --hybrid-runbook-worker-id hybridRunbookWorkerId

Optional Parameters

--automation-account-name

The name of the automation account.

--hybrid-runbook-worker-group-name

The hybrid runbook worker group name.

--hybrid-runbook-worker-id --name -n

The hybrid runbook worker id.

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