Share via

az vmware addon arc

  • Reference

Note

This reference is part of the vmware extension for the Azure CLI (version 2.54.0 or higher). The extension will automatically install the first time you run an az vmware addon arc command. Learn more about extensions.

Commands to manage a Arc addon.

Commands

Name Description Type Status
az vmware addon arc create

Create an Arc addon for a private cloud.

 Extension GA
az vmware addon arc delete

Delete an Arc addon for a private cloud.

 Extension GA
az vmware addon arc show

Show details of an Arc addon for a private cloud.

 Extension GA
az vmware addon arc update

Update an Arc addon for a private cloud.

 Extension GA

az vmware addon arc create

Create an Arc addon for a private cloud.

az vmware addon arc create --private-cloud
                           --resource-group
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--vcenter]

Examples

Create an Arc addon.

az vmware addon vr show --resource-group MyResourceGroup --private-cloud MyPrivateCloud

Required Parameters

--private-cloud -c

Name of the private cloud.

--resource-group -g

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

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--vcenter

The VMware vCenter resource 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 vmware addon arc delete

Delete an Arc addon for a private cloud.

az vmware addon arc delete [--ids]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--private-cloud]
                           [--resource-group]
                           [--subscription]
                           [--yes]

Examples

Delete an Arc addon.

az vmware addon arc delete --resource-group MyResourceGroup --private-cloud MyPrivateCloud

Optional Parameters

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

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--private-cloud -c

Name of the private cloud.

--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 vmware addon arc show

Show details of an Arc addon for a private cloud.

az vmware addon arc show [--ids]
                         [--private-cloud]
                         [--resource-group]
                         [--subscription]

Examples

Show details of an Arc addon.

az vmware addon arc show --resource-group MyResourceGroup --private-cloud MyPrivateCloud

Optional Parameters

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

--private-cloud -c

Name of the private cloud.

--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 vmware addon arc update

Update an Arc addon for a private cloud.

az vmware addon arc update [--add]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--ids]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--private-cloud]
                           [--remove]
                           [--resource-group]
                           [--set]
                           [--subscription]
                           [--vcenter]

Examples

Update an Arc addon.

az vmware addon arc update --resource-group MyResourceGroup --private-cloud MyPrivateCloud --vcenter "00000000-0000-0000-0000-000000000000"

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

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

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--private-cloud -c

Name of the private cloud.

--remove

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

--resource-group -g

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

--set

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

--subscription

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

--vcenter

The VMware vCenter resource 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.